Magento Connection

Based on resource template Base.

[Read] action

Endpoint URL address: /bundle-products/{{=parameters.sku}}/children.

The action has the following user-defined parameters:

• sku: Required. Specify bundle product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductLinkManagementV1/bundleProductLinkManagementV1GetChildrenGet.

---

[Create] action

Endpoint URL address: /bundle-products/{{=item.sku}}/links.

The following request parameters will be automatically processed:

• application/json: {{={ linkedProduct: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductLinkManagementV1/bundleProductLinkManagementV1AddChildByProductSkuPost.

---

[Update] action

Endpoint URL address: /bundle-products/{{=item.sku}}/links/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ linkedProduct: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductLinkManagementV1/bundleProductLinkManagementV1SaveChildPut.

---

The resource includes the fields from the BundleProductLink template.

Based on resource template Base.

[Read] action

Endpoint URL address: /bundle-products/{{=parameters.sku}}/options/all.

The action has the following user-defined parameters:

• sku: Required. Specify bundle product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductOptionRepositoryV1/bundleProductOptionRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /bundle-products/options/add.
The result is extracted from: {{=response.option}}.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductOptionManagementV1/bundleProductOptionManagementV1SavePost.

---

[Update] action

Endpoint URL address: /bundle-products/options/{{=item.optionId}}.
The result is extracted from: {{=response.option}}.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductOptionManagementV1/bundleProductOptionManagementV1SavePut.

---

[Delete] action

Endpoint URL address: /bundle-products/{{=item.sku}}/options/{{=item.optionId}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductOptionRepositoryV1/bundleProductOptionRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the BundleProductOption template.

Based on resource template Base.

[Read] action

Endpoint URL address: /bundle-products/options/types.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/bundleProductOptionTypeListV1/bundleProductOptionTypeListV1GetItemsGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/attribute-sets/sets/list.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogAttributeSetRepositoryV1/catalogAttributeSetRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products/attribute-sets.
The result is extracted from: {{=response.attributeSet}}.

The following request parameters will be automatically processed:

• application/json: {{={ attributeSet: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogAttributeSetManagementV1/catalogAttributeSetManagementV1CreatePost.

---

The resource includes the fields from the AttributeSet template.

Based on resource template Base.

[Read] action

Endpoint URL address: /categories/attributes/{{=parameters.attributeCode}}/options.

The action has the following user-defined parameters:

• attributeCode: Required. Specify attribute code.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryAttributeOptionManagementV1/catalogCategoryAttributeOptionManagementV1GetItemsGet.

---

The resource includes the fields from the AttributeOption template.

Based on resource template Base.

[Read] action

Endpoint URL address: /categories/attributes.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryAttributeRepositoryV1/catalogCategoryAttributeRepositoryV1GetListGet.

---

[Read productAttributeSetId] action

Endpoint URL address: /products/attribute-sets/{{=parameters.productAttributeSetId}}/attributes.
The result is extracted from: {{=response}}.

The action has the following user-defined parameters:

• productAttributeSetId: Required. Specify attribute set identifier.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeManagementV1/catalogProductAttributeManagementV1GetAttributesGet.

---

The resource includes the fields from the Attribute template.

Based on resource template Base.

[Read] action

Endpoint URL address: /categories/{{=parameters.categoryId}}/products.

The action has the following user-defined parameters:

• categoryId: Required. Specify category identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryLinkManagementV1/catalogCategoryLinkManagementV1GetAssignedProductsGet.

---

[Create] action

Endpoint URL address: /categories/{{=item.categoryId}}/products.
The result is extracted from: {{=response.productLink}}.

The following request parameters will be automatically processed:

• application/json: {{={ productLink: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryLinkRepositoryV1/catalogCategoryLinkRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /categories/{{=item.categoryId}}/products/{{=item.sku}}.
The result is extracted from: {{=response.productLink}}.

The following request parameters will be automatically processed:

• application/json: {{={ productLink: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryLinkRepositoryV1/catalogCategoryLinkRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /categories/{{=item.categoryId}}/products/{{=item.sku}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryLinkRepositoryV1/catalogCategoryLinkRepositoryV1DeleteByIdsDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /categories.
The result is extracted from: {{=Magento.flatten([response], 'children_data')}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryManagementV1/catalogCategoryManagementV1GetTreeGet.

---

[Create] action

Endpoint URL address: /categories.

The following request parameters will be automatically processed:

• application/json: {{={ category: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryRepositoryV1/catalogCategoryRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /categories/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ category: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryRepositoryV1/catalogCategoryRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /categories/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogCategoryRepositoryV1/catalogCategoryRepositoryV1DeleteByIdentifierDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /stockItems/lowStock/.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• page: {{=parameters.iterator}}
• pageSize: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogInventoryStockRegistryV1/catalogInventoryStockRegistryV1GetLowStockItemsGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/attribute-sets/groups/list.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeGroupRepositoryV1/catalogProductAttributeGroupRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products/attribute-sets/groups.

The following request parameters will be automatically processed:

• application/json: {{={ group: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeGroupRepositoryV1/catalogProductAttributeGroupRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/attribute-sets/groups/{{=item.attributeGroupId}}.

The following request parameters will be automatically processed:

• application/json: {{={ group: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeGroupRepositoryV1/catalogProductAttributeGroupRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/attribute-sets/groups/{{=item.attributeGroupId}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeGroupRepositoryV1/catalogProductAttributeGroupRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Create] action

Endpoint URL address: /products/attribute-sets/attributes.

The following request parameters will be automatically processed:

• application/json: {{=item}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeManagementV1/catalogProductAttributeManagementV1AssignPost.

---

[Delete] action

Endpoint URL address: /products/attribute-sets/{{=item.attributeSetId}}/attributes/{{=item.attributeCode}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeManagementV1/catalogProductAttributeManagementV1UnassignDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/{{=parameters.sku}}/media.

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeMediaGalleryManagementV1/catalogProductAttributeMediaGalleryManagementV1GetListGet.

---

[Create] action

Endpoint URL address: /products/{{=item.sku}}/media.
The result is extracted from: {{=response.entry}}.

The following request parameters will be automatically processed:

• application/json: {{={ entry: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeMediaGalleryManagementV1/catalogProductAttributeMediaGalleryManagementV1CreatePost.

---

[Update] action

Endpoint URL address: /products/{{=item.sku}}/media/{{=item.id}}.
The result is extracted from: {{=response.entry}}.

The following request parameters will be automatically processed:

• application/json: {{={ entry: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeMediaGalleryManagementV1/catalogProductAttributeMediaGalleryManagementV1UpdatePut.

---

[Delete] action

Endpoint URL address: /products/{{=item.sku}}/media/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeMediaGalleryManagementV1/catalogProductAttributeMediaGalleryManagementV1RemoveDelete.

---

The resource includes the fields from the MediaGallery template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products/attributes/{{=parameters.attributeCode}}/options.

The action has the following user-defined parameters:

• attributeCode: Required. Specify attribute code.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeOptionManagementV1/catalogProductAttributeOptionManagementV1GetItemsGet.

---

[Create] action

Endpoint URL address: /products/attributes/{{=item.attribute_code}}/options.
The result is extracted from: {{=response.option}}.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeOptionManagementV1/catalogProductAttributeOptionManagementV1AddPost.

---

[Delete] action

Endpoint URL address: /products/attributes/{{=item.attribute_code}}/options/{{=item.value}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeOptionManagementV1/catalogProductAttributeOptionManagementV1DeleteDelete.

---

The resource includes the fields from the AttributeOption template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products/attributes.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeRepositoryV1/catalogProductAttributeRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products/attributes.
The result is extracted from: {{=response.attribute}}.

The following request parameters will be automatically processed:

• application/json: {{={ attribute: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeRepositoryV1/catalogProductAttributeRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/attributes/{{=item.attribute_code}}.
The result is extracted from: {{=response.attribute}}.

The following request parameters will be automatically processed:

• application/json: {{={ attribute: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeRepositoryV1/catalogProductAttributeRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/attributes/{{=item.attribute_code}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeRepositoryV1/catalogProductAttributeRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the Attribute template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products/attributes/types.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductAttributeTypesListV1/catalogProductAttributeTypesListV1GetItemsGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/{{=parameters.sku}}/options.

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductCustomOptionRepositoryV1/catalogProductCustomOptionRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products/options.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductCustomOptionRepositoryV1/catalogProductCustomOptionRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/options/{{=item.optionId}}.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductCustomOptionRepositoryV1/catalogProductCustomOptionRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/{{=item.sku}}/options/{{=item.optionId}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductCustomOptionRepositoryV1/catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete.

---

The resource includes the fields from the ProductOption template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products/options/types.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductCustomOptionTypeListV1/catalogProductCustomOptionTypeListV1GetItemsGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/{{=parameters.sku}}/links/{{=parameters.type}}.
The result is extracted from: .

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.
• type: Required.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductLinkManagementV1/catalogProductLinkManagementV1GetLinkedItemsByTypeGet.

---

[Create] action

Endpoint URL address: /products/{{=item.sku}}/links.

The following request parameters will be automatically processed:

• application/json: {{={ items: [item] } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductLinkManagementV1/catalogProductLinkManagementV1SetProductLinksPost.

---

[Update] action

Endpoint URL address: /products/{{=item.sku}}/links.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductLinkRepositoryV1/catalogProductLinkRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/{{=item.sku}}/links/{{=item.linkType}}/{{=item.linkedProductSku}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductLinkRepositoryV1/catalogProductLinkRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the ProductLink template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products/links/types.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductLinkTypeListV1/catalogProductLinkTypeListV1GetItemsGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/links/{{=parameters.type}}/attributes.

The action has the following user-defined parameters:

• type: Required. Specify link type.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductLinkTypeListV1/catalogProductLinkTypeListV1GetItemAttributesGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/media/types/{{=parameters.attributeSetName}}.

The action has the following user-defined parameters:

• attributeSetName: Required. Specify attribute set name.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductMediaAttributeManagementV1/catalogProductMediaAttributeManagementV1GetListGet.

---

The resource includes the fields from the Attribute template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

• attributeSetId: Required. Specify product attribute set identifier.

The following request parameters will be automatically processed:

• searchCriteria[filter_groups][0][filters][0][field]: attribute_set_id
• searchCriteria[filter_groups][0][filters][0][value]: {{=parameters.attributeSetId}}
• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductRepositoryV1/catalogProductRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products.

The action has the following user-defined parameters:

• attributeSetId: Required. Specify product attribute set identifier.

The following request parameters will be automatically processed:

• application/json: {{={ product: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductRepositoryV1/catalogProductRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/{{=item.sku}}.

The action has the following user-defined parameters:

• attributeSetId: Required. Specify product attribute set identifier.

The following request parameters will be automatically processed:

• application/json: {{={ product: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductRepositoryV1/catalogProductRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/{{=item.sku}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductRepositoryV1/catalogProductRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/{{=parameters.sku}}/group-prices/{{=parameters.customerGroupId}}/tiers.

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.
• customerGroupId: Required. Specify customer group identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductTierPriceManagementV1/catalogProductTierPriceManagementV1GetListGet.

---

[Create] action

Endpoint URL address: /products/{{=item.sku}}/group-prices/{{=item.customerGroupId}}/tiers/{{=item.qty}}/price/{{=item.value}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductTierPriceManagementV1/catalogProductTierPriceManagementV1AddPost.

---

[Delete] action

Endpoint URL address: /products/{{=item.sku}}/group-prices/{{=item.customerGroupId}}/tiers/{{=item.qty}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductTierPriceManagementV1/catalogProductTierPriceManagementV1RemoveDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/types.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductTypeListV1/catalogProductTypeListV1GetProductTypesGet.

---

Based on resource template Base.

[Create] action

Endpoint URL address: /products/{{=item.sku}}/websites.

The following request parameters will be automatically processed:

• application/json: {{={ productWebsiteLink: { sku: item.sku, websiteId: item.websiteId } } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductWebsiteLinkRepositoryV1/catalogProductWebsiteLinkRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/{{=item.sku}}/websites.

The following request parameters will be automatically processed:

• application/json: {{={ productWebsiteLink: { sku: item.sku, website_id: item.website_id } } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductWebsiteLinkRepositoryV1/catalogProductWebsiteLinkRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/{{=item.sku}}/websites/{{=item.website_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/catalogProductWebsiteLinkRepositoryV1/catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /carts/licence.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/checkoutAgreementsCheckoutAgreementsRepositoryV1/checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /cmsBlock/search.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

• searchCriteria: Required.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsBlockRepositoryV1/cmsBlockRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /cmsBlock.

The following request parameters will be automatically processed:

• application/json: {{={ block: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsBlockRepositoryV1/cmsBlockRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /cmsBlock/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ block: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsBlockRepositoryV1/cmsBlockRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /cmsBlock/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsBlockRepositoryV1/cmsBlockRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /cmsPage/search.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

• searchCriteria: Required.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsPageRepositoryV1/cmsPageRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /cmsPage.

The following request parameters will be automatically processed:

• application/json: {{={ page: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsPageRepositoryV1/cmsPageRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /cmsPage/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ page: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsPageRepositoryV1/cmsPageRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /cmsPage/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/cmsPageRepositoryV1/cmsPageRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /configurable-products/{{=parameters.sku}}/options/all.

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/configurableProductOptionRepositoryV1/configurableProductOptionRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /configurable-products/{{=item.sku}}/options.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/configurableProductOptionRepositoryV1/configurableProductOptionRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /configurable-products/{{=item.sku}}/options/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ option: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/configurableProductOptionRepositoryV1/configurableProductOptionRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /configurable-products/{{=item.sku}}/options/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/configurableProductOptionRepositoryV1/configurableProductOptionRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the ConfigurableProductOption template.

Based on resource template Base.

[Read] action

Endpoint URL address: /customers/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerCustomerRepositoryV1/customerCustomerRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /customers.

The following request parameters will be automatically processed:

• application/json: {{={ customer: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerCustomerRepositoryV1/customerCustomerRepositoryV1SavePut.

---

[Update] action

Endpoint URL address: /customers/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ customer: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerCustomerRepositoryV1/customerCustomerRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /customers/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerCustomerRepositoryV1/customerCustomerRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the CustomerT template.

Based on resource template Base.

[Read] action

Endpoint URL address: /attributeMetadata/customer.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerCustomerMetadataV1/customerCustomerMetadataV1GetAllAttributesMetadataGet.

---

[Read custom] action

Endpoint URL address: /attributeMetadata/customer/custom.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerCustomerMetadataV1/customerCustomerMetadataV1GetCustomAttributesMetadataGet.

---

[Read address] action

Endpoint URL address: /attributeMetadata/customerAddress.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerAddressMetadataV1/customerAddressMetadataV1GetAllAttributesMetadataGet.

---

[Read address_custom] action

Endpoint URL address: /attributeMetadata/customerAddress/custom.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerAddressMetadataV1/customerAddressMetadataV1GetCustomAttributesMetadataGet.

---

[Read rma] action

Endpoint URL address: /returnsAttributeMetadata.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/rmaRmaAttributesManagementV1/rmaRmaAttributesManagementV1GetAllAttributesMetadataGet.

---

[Read rma_custom] action

Endpoint URL address: /returnsAttributeMetadata/custom.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/rmaRmaAttributesManagementV1/rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /customerGroups/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerGroupRepositoryV1/customerGroupRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /customerGroups.

The following request parameters will be automatically processed:

• application/json: {{={ group: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerGroupRepositoryV1/customerGroupRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /customerGroups/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ group: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerGroupRepositoryV1/customerGroupRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /customerGroups/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/customerGroupRepositoryV1/customerGroupRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /directory/countries.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/directoryCountryInformationAcquirerV1/directoryCountryInformationAcquirerV1GetCountriesInfoGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /directory/currency.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/directoryCurrencyInformationAcquirerV1/directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /products/{{=parameters.sku}}/downloadable-links.

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableLinkRepositoryV1/downloadableLinkRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products/{{=item.sku}}/downloadable-links.

The following request parameters will be automatically processed:

• application/json: {{={ link: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableLinkRepositoryV1/downloadableLinkRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/{{=item.sku}}/downloadable-links/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ link: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableLinkRepositoryV1/downloadableLinkRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/downloadable-links/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableLinkRepositoryV1/downloadableLinkRepositoryV1DeleteDelete.

---

The resource includes the fields from the DownloadableLink template.

Based on resource template Base.

[Read] action

Endpoint URL address: /products/{{=parameters.sku}}/downloadable-links/samples.

The action has the following user-defined parameters:

• sku: Required. Specify product identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableSampleRepositoryV1/downloadableSampleRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /products/{{=item.sku}}/downloadable-links/samples.

The following request parameters will be automatically processed:

• application/json: {{={ sample: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableSampleRepositoryV1/downloadableSampleRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /products/{{=item.sku}}/downloadable-links/samples/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ sample: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableSampleRepositoryV1/downloadableSampleRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /products/downloadable-links/samples/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/downloadableSampleRepositoryV1/downloadableSampleRepositoryV1DeleteDelete.

---

The resource includes the fields from the DownloadableSample template.

Based on resource template Base.

[Read] action

Endpoint URL address: /eav/attribute-sets/list.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/eavAttributeSetRepositoryV1/eavAttributeSetRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /eav/attribute-sets.

The following request parameters will be automatically processed:

• application/json: {{={ attribute_set: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/eavAttributeSetManagementV1/eavAttributeSetManagementV1CreatePost.

---

[Update] action

Endpoint URL address: /eav/attribute-sets/{{=item.attribute_set_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ attribute_set: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/eavAttributeSetRepositoryV1/eavAttributeSetRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /eav/attribute-sets/{{=item.attribute_set_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/eavAttributeSetRepositoryV1/eavAttributeSetRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the AttributeSet template.

Based on resource template Base.

[Read] action

Endpoint URL address: /gift-wrappings.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/giftWrappingWrappingRepositoryV1/giftWrappingWrappingRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /gift-wrappings.

The following request parameters will be automatically processed:

• application/json: {{={ data: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/giftWrappingWrappingRepositoryV1/giftWrappingWrappingRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /gift-wrappings/{{=item.wrapping_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ data: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/giftWrappingWrappingRepositoryV1/giftWrappingWrappingRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /gift-wrappings/{{=item.wrapping_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/giftWrappingWrappingRepositoryV1/giftWrappingWrappingRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /carts/{{=parameters.cart_id}}/items.

The action has the following user-defined parameters:

• cart_id: Required. Specify cart identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteCartItemRepositoryV1/quoteCartItemRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /carts/{{=item.cart_id}}/items.

The following request parameters will be automatically processed:

• application/json: {{={ cartItem: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteCartItemRepositoryV1/quoteCartItemRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /carts/{{=item.cart_id}}/items/{{=item.item_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteCartItemRepositoryV1/quoteCartItemRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /carts/{{=item.cart_id}}/items/{{=item.item_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteCartItemRepositoryV1/quoteCartItemRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the CartItem template.

Based on resource template Base.

[Read] action

Endpoint URL address: /carts/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteCartRepositoryV1/quoteCartRepositoryV1GetListGet.

---

The resource includes the fields from the QuoteCartT template.

Based on resource template Base.

[Read] action

Endpoint URL address: /guest-carts/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

---

The resource includes the fields from the QuoteCartT template.

Based on resource template Base.

[Read] action

Endpoint URL address: /guest-carts/{{=parameters.cart_id}}/items.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteGuestCartItemRepositoryV1/quoteGuestCartItemRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /guest-carts/{{=item.cart_id}}/items.

The following request parameters will be automatically processed:

• application/json: {{={ cartItem: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteGuestCartItemRepositoryV1/quoteGuestCartItemRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /guest-carts/{{=item.cart_id}}/items/{{=item.item_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ cartItem: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteGuestCartItemRepositoryV1/quoteGuestCartItemRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /guest-carts/{{=item.cart_id}}/items/{{=item.item_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/quoteGuestCartItemRepositoryV1/quoteGuestCartItemRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the CartItem template.

Based on resource template Base.

[Read] action

Endpoint URL address: /returns.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/rmaRmaManagementV1/rmaRmaManagementV1SearchGet.

---

[Create] action

Endpoint URL address: /returns.

The following request parameters will be automatically processed:

• application/json: {{={ rmaDataObject: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/rmaRmaManagementV1/rmaRmaManagementV1SaveRmaPost.

---

[Update] action

Endpoint URL address: /returns/{{=item.entity_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ rmaDataObject: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/rmaRmaManagementV1/rmaRmaManagementV1SaveRmaPut.

---

[Delete] action

Endpoint URL address: /returns/{{=item.entity_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/rmaRmaRepositoryV1/rmaRmaRepositoryV1DeleteDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /creditmemos.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesCreditmemoRepositoryV1/salesCreditmemoRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /creditmemo.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesCreditmemoRepositoryV1/salesCreditmemoRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /creditmemo/{{=item.entity_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesCreditmemoManagementV1/salesCreditmemoManagementV1CancelPut.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /creditmemo/{{=parameters.creditmemo_id}}/comments.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

• creditmemo_id: Required. Specify credit memo identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesCreditmemoManagementV1/salesCreditmemoManagementV1GetCommentsListGet.

---

[Create] action

Endpoint URL address: /creditmemo/{{=item.creditmemo_id}}/comments.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesCreditmemoCommentRepositoryV1/salesCreditmemoCommentRepositoryV1SavePost.

---

The resource includes the fields from the TransactionComment template.

Based on resource template Base.

[Read] action

Endpoint URL address: /invoices.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesInvoiceRepositoryV1/salesInvoiceRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /invoices/.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesInvoiceRepositoryV1/salesInvoiceRepositoryV1SavePost.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /invoices/{{=parameters.invoice_id}}/comments.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

• invoice_id: Required. Specify invoice identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesInvoiceManagementV1/salesInvoiceManagementV1GetCommentsListGet.

---

[Create] action

Endpoint URL address: /invoices/{{=item.invoice_id}}/comments.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesInvoiceCommentRepositoryV1/salesInvoiceCommentRepositoryV1SavePost.

---

The resource includes the fields from the TransactionComment template.

Based on resource template Base.

[Read] action

Endpoint URL address: /orders.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesOrderRepositoryV1/salesOrderRepositoryV1GetListGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /orders/{{=parameters.salesorder_id}}/comments.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

• salesorder_id: Required. Specify sales order identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesOrderManagementV1/salesOrderManagementV1GetCommentsListGet.

---

[Create] action

Endpoint URL address: /orders/{{=item.salesorder_id}}/comments.

The following request parameters will be automatically processed:

• application/json: {{={ statusHistory: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesOrderManagementV1/salesOrderManagementV1AddCommentPost.

---

The resource includes the fields from the TransactionComment template.

Based on resource template Base.

[Read] action

Endpoint URL address: /coupons/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleCouponRepositoryV1/salesRuleCouponRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /coupons.

The following request parameters will be automatically processed:

• application/json: {{={ coupon: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleCouponRepositoryV1/salesRuleCouponRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /coupons/{{=item.coupon_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ coupon: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleCouponRepositoryV1/salesRuleCouponRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /coupons/{{=item.coupon_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleCouponRepositoryV1/salesRuleCouponRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /salesRules/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleRuleRepositoryV1/salesRuleRuleRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /salesRules.

The following request parameters will be automatically processed:

• application/json: {{={ rule: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleRuleRepositoryV1/salesRuleRuleRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /salesRules/{{=item.rule_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ rule: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleRuleRepositoryV1/salesRuleRuleRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /salesRules/{{=item.rule_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesRuleRuleRepositoryV1/salesRuleRuleRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /shipments.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesShipmentRepositoryV1/salesShipmentRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /shipment.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesShipmentRepositoryV1/salesShipmentRepositoryV1SavePost.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /shipment/{{=parameters.shipment_id}}/comments.

The action has the following user-defined parameters:

• shipment_id: Required. Specify shipment identifier.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesShipmentManagementV1/salesShipmentManagementV1GetCommentsListGet.

---

[Create] action

Endpoint URL address: /shipment/{{=item.shipment_id}}/comments.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesShipmentCommentRepositoryV1/salesShipmentCommentRepositoryV1SavePost.

---

The resource includes the fields from the TransactionComment template.

Based on resource template Base.

[Read] action

Endpoint URL address: /shipment/{{=parameters.shipment_id}}.
The result is extracted from: {{=response.tracks}}.

The action has the following user-defined parameters:

• shipment_id: Required. Specify shipment identifier.

---

[Create] action

Endpoint URL address: /shipment/{{=item.shipment_id}}/track.

The following request parameters will be automatically processed:

• application/json: {{={ entity: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesShipmentTrackRepositoryV1/salesShipmentTrackRepositoryV1SavePost.

---

[Delete] action

Endpoint URL address: /shipment/track/{{=item.entity_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesShipmentTrackRepositoryV1/salesShipmentTrackRepositoryV1DeleteByIdDelete.

---

The resource includes the fields from the ShipmentTrack template.

Based on resource template Base.

[Read] action

Endpoint URL address: /transactions.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/salesTransactionRepositoryV1/salesTransactionRepositoryV1GetListGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/searchV1/searchV1SearchGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /store/storeGroups.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/storeGroupRepositoryV1/storeGroupRepositoryV1GetListGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /store/storeConfigs.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/storeStoreConfigManagerV1/storeStoreConfigManagerV1GetStoreConfigsGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /store/storeViews.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/storeStoreRepositoryV1/storeStoreRepositoryV1GetListGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /store/websites.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/storeWebsiteRepositoryV1/storeWebsiteRepositoryV1GetListGet.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /taxClasses/search.
The result is extracted from: {{=response.items}].

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxClassRepositoryV1/taxTaxClassRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /taxClasses.

The following request parameters will be automatically processed:

• application/json: {{={ taxClass: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxClassRepositoryV1/taxTaxClassRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /taxClasses/{{=item.class_id}}.

The following request parameters will be automatically processed:

• application/json: {{={ taxClass: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxClassRepositoryV1/taxTaxClassRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /taxClasses/{{=item.class_id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxClassRepositoryV1/taxTaxClassRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /taxRates/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRateRepositoryV1/taxTaxRateRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /taxRates.

The following request parameters will be automatically processed:

• application/json: {{={ taxRate: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRateRepositoryV1/taxTaxRateRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /taxRates/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ taxRate: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRateRepositoryV1/taxTaxRateRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /taxRates/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRateRepositoryV1/taxTaxRateRepositoryV1DeleteByIdDelete.

---

Based on resource template Base.

[Read] action

Endpoint URL address: /taxRules/search.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

• searchCriteria[currentPage]: {{=parameters.iterator}}
• searchCriteria[pageSize]: {{=parameters.batchSize}}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRuleRepositoryV1/taxTaxRuleRepositoryV1GetListGet.

---

[Create] action

Endpoint URL address: /taxRules.

The following request parameters will be automatically processed:

• application/json: {{={ rule: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRuleRepositoryV1/taxTaxRuleRepositoryV1SavePost.

---

[Update] action

Endpoint URL address: /taxRules/{{=item.id}}.

The following request parameters will be automatically processed:

• application/json: {{={ rule: item } }}

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRuleRepositoryV1/taxTaxRuleRepositoryV1SavePut.

---

[Delete] action

Endpoint URL address: /taxRules/{{=item.id}}.

Documentation: http://devdocs.magento.com/swagger/index_20.html#!/taxTaxRuleRepositoryV1/taxTaxRuleRepositoryV1DeleteByIdDelete.

---

[Read] action

The result is paginated.

The following request parameters will be automatically processed:

• _includeUserParameters: {{=parameters}}

Documentation: There is a bug in Magento paging. The Iterator Next definition will be revised after the bug is resolved..

---

[Create] action

The action uses POST method.

---

[Update] action

The action uses PUT method.

---

[Delete] action

The action uses DELETE method.

---