Catalog REST endpoints
vendor/magento/module-catalog/etc/webapi.xml
GET
/V1/categories
Retrieve list of categories
Catalog · Magento\Catalog\Api\CategoryManagementInterface::getTree
/V1/categories/:categoryId
Get info about category by category id
Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::get
/V1/categories/:categoryId/products
Get products assigned to category
Catalog · Magento\Catalog\Api\CategoryLinkManagementInterface::getAssignedProducts
/V1/categories/attributes
Retrieve all attributes for entity type
Catalog · Magento\Catalog\Api\CategoryAttributeRepositoryInterface::getList
/V1/categories/attributes/:attributeCode
Retrieve specific attribute
Catalog · Magento\Catalog\Api\CategoryAttributeRepositoryInterface::get
/V1/categories/attributes/:attributeCode/options
Retrieve list of attribute options
Catalog · Magento\Catalog\Api\CategoryAttributeOptionManagementInterface::getItems
/V1/categories/list
Get category list
Catalog · Magento\Catalog\Api\CategoryListInterface::getList
/V1/products
Get product list
Catalog · Magento\Catalog\Api\ProductRepositoryInterface::getList
/V1/products-render-info
AnonymousCollect and retrieve the list of product render info.
Catalog · Magento\Catalog\Api\ProductRenderListInterface::getList
/V1/products/:sku
Get info about product by product SKU
Catalog · Magento\Catalog\Api\ProductRepositoryInterface::get
/V1/products/:sku/group-prices/:customerGroupId/tiers
Get tier price of product
Catalog · Magento\Catalog\Api\ProductTierPriceManagementInterface::getList
/V1/products/:sku/links/:type
Provide the list of links for a specific product
Catalog · Magento\Catalog\Api\ProductLinkManagementInterface::getLinkedItemsByType
/V1/products/:sku/media
Retrieve the list of gallery entries associated with given product
Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::getList
/V1/products/:sku/media/:entryId
Return information about gallery entry
Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::get
/V1/products/:sku/options
Get the list of custom options for a specific product
Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::getList
/V1/products/:sku/options/:optionId
Get custom option for a specific product
Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::get
/V1/products/attribute-sets/:attributeSetId
Retrieve attribute set information based on given ID
Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::get
/V1/products/attribute-sets/:attributeSetId/attributes
Retrieve related attributes based on given attribute set ID
Catalog · Magento\Catalog\Api\ProductAttributeManagementInterface::getAttributes
/V1/products/attribute-sets/groups/list
Retrieve list of attribute groups
Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::getList
/V1/products/attribute-sets/sets/list
Retrieve list of Attribute Sets
Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::getList
/V1/products/attributes
Retrieve all attributes for entity type
Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::getList
/V1/products/attributes/:attributeCode
Retrieve specific attribute
Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::get
/V1/products/attributes/:attributeCode/is-filterable
Retrieve 'is_filterable' property for specific attribute as integer
Catalog · Magento\Catalog\Api\ProductAttributeIsFilterableManagementInterface::get
/V1/products/attributes/:attributeCode/options
Retrieve list of attribute options
Catalog · Magento\Catalog\Api\ProductAttributeOptionManagementInterface::getItems
/V1/products/attributes/types
Retrieve list of product attribute types
Catalog · Magento\Catalog\Api\ProductAttributeTypesListInterface::getItems
/V1/products/links/:type/attributes
Provide a list of the product link type attributes
Catalog · Magento\Catalog\Api\ProductLinkTypeListInterface::getItemAttributes
/V1/products/links/types
Retrieve information about available product link types
Catalog · Magento\Catalog\Api\ProductLinkTypeListInterface::getItems
/V1/products/media/types/:attributeSetName
Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.
Catalog · Magento\Catalog\Api\ProductMediaAttributeManagementInterface::getList
/V1/products/options/types
Get custom option types
Catalog · Magento\Catalog\Api\ProductCustomOptionTypeListInterface::getItems
/V1/products/types
Retrieve available product types
Catalog · Magento\Catalog\Api\ProductTypeListInterface::getProductTypes
POST
/V1/categories
Create category service
Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::save
/V1/categories/:categoryId/products
Assign a product to the required category
Catalog · Magento\Catalog\Api\CategoryLinkRepositoryInterface::save
/V1/products
Create product
Catalog · Magento\Catalog\Api\ProductRepositoryInterface::save
/V1/products/:sku/group-prices/:customerGroupId/tiers/:qty/price/:price
Create tier price for product
Catalog · Magento\Catalog\Api\ProductTierPriceManagementInterface::add
/V1/products/:sku/links
Assign a product link to another product
Catalog · Magento\Catalog\Api\ProductLinkManagementInterface::setProductLinks
/V1/products/:sku/media
Create new gallery entry
Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::create
/V1/products/:sku/websites
Assign a product to the website
Catalog · Magento\Catalog\Api\ProductWebsiteLinkRepositoryInterface::save
/V1/products/attribute-sets
Create attribute set from data
Catalog · Magento\Catalog\Api\AttributeSetManagementInterface::create
/V1/products/attribute-sets/attributes
Assign attribute to attribute set
Catalog · Magento\Catalog\Api\ProductAttributeManagementInterface::assign
/V1/products/attribute-sets/groups
Save attribute group
Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::save
/V1/products/attributes
Save attribute data
Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::save
/V1/products/attributes/:attributeCode/options
Add option to attribute
Catalog · Magento\Catalog\Api\ProductAttributeOptionManagementInterface::add
/V1/products/base-prices
Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid price, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
Catalog · Magento\Catalog\Api\BasePriceStorageInterface::update
/V1/products/base-prices-information
Return product prices. In case of at least one of skus is not found exception will be thrown.
Catalog · Magento\Catalog\Api\BasePriceStorageInterface::get
/V1/products/cost
Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid cost, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
Catalog · Magento\Catalog\Api\CostStorageInterface::update
/V1/products/cost-delete
Delete product cost. In case of at least one of skus is not found exception will be thrown. If error occurred during the delete exception will be thrown.
Catalog · Magento\Catalog\Api\CostStorageInterface::delete
/V1/products/cost-information
Return product prices. In case of at least one of skus is not found exception will be thrown.
Catalog · Magento\Catalog\Api\CostStorageInterface::get
/V1/products/options
Save Custom Option
Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::save
/V1/products/special-price
Add or update product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
Catalog · Magento\Catalog\Api\SpecialPriceStorageInterface::update
/V1/products/special-price-delete
Delete product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the delete exception will be thrown.
Catalog · Magento\Catalog\Api\SpecialPriceStorageInterface::delete
/V1/products/special-price-information
Return product's special price. In case of at least one of skus is not found exception will be thrown.
Catalog · Magento\Catalog\Api\SpecialPriceStorageInterface::get
/V1/products/tier-prices
Add or update product prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
Catalog · Magento\Catalog\Api\TierPriceStorageInterface::update
/V1/products/tier-prices-delete
Delete product tier prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
Catalog · Magento\Catalog\Api\TierPriceStorageInterface::delete
/V1/products/tier-prices-information
Return product prices. In case of at least one of skus is not found exception will be thrown.
Catalog · Magento\Catalog\Api\TierPriceStorageInterface::get
PUT
/V1/categories/:categoryId/move
Move category
Catalog · Magento\Catalog\Api\CategoryManagementInterface::move
/V1/categories/:categoryId/products
Assign a product to the required category
Catalog · Magento\Catalog\Api\CategoryLinkRepositoryInterface::save
/V1/categories/:id
Create category service
Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::save
/V1/products/:sku
Create product
Catalog · Magento\Catalog\Api\ProductRepositoryInterface::save
/V1/products/:sku/links
Save product link
Catalog · Magento\Catalog\Api\ProductLinkRepositoryInterface::save
/V1/products/:sku/media/:entryId
Update gallery entry
Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::update
/V1/products/:sku/websites
Assign a product to the website
Catalog · Magento\Catalog\Api\ProductWebsiteLinkRepositoryInterface::save
/V1/products/attribute-sets/:attributeSetId
Save attribute set data
Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::save
/V1/products/attribute-sets/:attributeSetId/groups
Save attribute group
Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::save
/V1/products/attributes/:attributeCode
Save attribute data
Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::save
/V1/products/attributes/:attributeCode/is-filterable/:isFilterable
Set 'is_filterable' property for specific attribute as integer
Catalog · Magento\Catalog\Api\ProductAttributeIsFilterableManagementInterface::set
/V1/products/attributes/:attributeCode/options/:optionId
Update attribute option
Catalog · Magento\Catalog\Api\ProductAttributeOptionUpdateInterface::update
/V1/products/options/:optionId
Save Custom Option
Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::save
/V1/products/tier-prices
Remove existing tier prices and replace them with the new ones. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from replace list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
Catalog · Magento\Catalog\Api\TierPriceStorageInterface::replace
DELETE
/V1/categories/:categoryId
Delete category by identifier
Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::deleteByIdentifier
/V1/categories/:categoryId/products/:sku
Remove the product assignment from the category by category id and sku
Catalog · Magento\Catalog\Api\CategoryLinkRepositoryInterface::deleteByIds
/V1/products/:sku
Catalog · Magento\Catalog\Api\ProductRepositoryInterface::deleteById
/V1/products/:sku/group-prices/:customerGroupId/tiers/:qty
Remove tier price from product
Catalog · Magento\Catalog\Api\ProductTierPriceManagementInterface::remove
/V1/products/:sku/links/:type/:linkedProductSku
Catalog · Magento\Catalog\Api\ProductLinkRepositoryInterface::deleteById
/V1/products/:sku/media/:entryId
Remove gallery entry
Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::remove
/V1/products/:sku/options/:optionId
Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::deleteByIdentifier
/V1/products/:sku/websites/:websiteId
Remove the website assignment from the product by product sku
Catalog · Magento\Catalog\Api\ProductWebsiteLinkRepositoryInterface::deleteById
/V1/products/attribute-sets/:attributeSetId
Remove attribute set by given ID
Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::deleteById
/V1/products/attribute-sets/:attributeSetId/attributes/:attributeCode
Remove attribute from attribute set
Catalog · Magento\Catalog\Api\ProductAttributeManagementInterface::unassign
/V1/products/attribute-sets/groups/:groupId
Remove attribute group by id
Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::deleteById
/V1/products/attributes/:attributeCode
Delete Attribute by id
Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::deleteById
/V1/products/attributes/:attributeCode/options/:optionId
Delete option from attribute
Catalog · Magento\Catalog\Api\ProductAttributeOptionManagementInterface::delete
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.