Catalog
magento-2Produtos, categorias, atributos, sets, tiered pricing, links (related/upsell/crosssell), tier prices, special prices.
/rest/V1/products
Admin token
List products (searchCriteria)
List products (searchCriteria).
Admin/integração. Para storefront, use GraphQL.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products
Admin token
Create a product
Create a product.
Body requer product.sku, attribute_set_id, type_id.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku
Admin token
Get product by SKU
Get product by SKU.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku
Admin token
Update a product
Update a product.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku
Admin token
Delete a product by SKU
Delete a product by SKU.
Admin only.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/media
Admin token
List product media (images/video)
List product media (images/video).
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/media
Admin token
Upload media to product
Upload media to product.
Body aceita base64 em entry.content ou URL em remote.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/media/:entryId
Admin token
Update a media entry
Update a media entry.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/media/:entryId
Admin token
Delete a media entry
Delete a media entry.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/group-prices/:customerGroupId/tiers
Admin token
Tier prices for a customer group
Tier prices for a customer group.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| sku | string | Sim | Product SKU. |
| customerGroupId | string | Sim | Customer group identifier (e.g. "General", "NOT LOGGED IN", or a numeric id). |
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/tier-prices-information
Admin token
Retrieve tier prices for multiple SKUs
Returns all active tier prices for the specified SKUs.
Accepts an array of SKUs in the request body and responds with a flat list of tier-price rows (one row per sku/customer_group/quantity combination).
Example request body:
{"skus":["24-UG04","24-UG01"]}Example response:
[{"price":8,"price_type":"fixed","website_id":0,"sku":"24-UG04","customer_group":"General","quantity":5}]Request Body
{
"skus": [
"24-UG04",
"24-UG01"
]
}Exemplo de Resposta
[
{
"price": 8,
"price_type": "fixed",
"website_id": 0,
"sku": "24-UG04",
"customer_group": "General",
"quantity": 5
}
]Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/tier-prices
Admin token
Add/update tier prices (bulk)
Adds new tier prices or updates existing entries for one or more SKUs.
Required fields per price row: price, price_type, website_id, sku, customer_group, quantity.
On success an empty array is returned; any rows returned in the response represent entries that FAILED to be saved.
Example request body:
{"prices":[{"price":10,"price_type":"fixed","website_id":0,"sku":"24-UG04","customer_group":"General","quantity":3}]}Request Body
{
"prices": [
{
"price": 10,
"price_type": "fixed",
"website_id": 0,
"sku": "24-UG04",
"customer_group": "General",
"quantity": 3
}
]
}Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/tier-prices-delete
Admin token
Delete tier prices (bulk)
Removes the specified tier-price entries. Each row must match an existing tier price exactly (price, price_type, website_id, sku, customer_group and quantity).
Successful deletions return an empty array; any returned rows represent entries that could not be removed.
Example request body:
{"prices":[{"price":10,"price_type":"fixed","website_id":0,"sku":"24-UG04","customer_group":"General","quantity":3}]}Request Body
{
"prices": [
{
"price": 10,
"price_type": "fixed",
"website_id": 0,
"sku": "24-UG04",
"customer_group": "General",
"quantity": 3
}
]
}Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/special-price-information
Admin token
Retrieve special prices
Returns the scheduled special prices for the supplied SKUs.
The request body carries an array of SKUs; the response is a list of special-price rows with price, store_id, sku, price_from and price_to.
Example request body:
{"skus":["24-WB06","240-LV06"]}Example response:
[{"price":29.95,"store_id":0,"sku":"24-WB06","price_from":"2017-07-15 00:00:00","price_to":"2017-07-16 23:59:59"}]Request Body
{
"skus": [
"24-WB06",
"240-LV06"
]
}Exemplo de Resposta
[
{
"price": 29.95,
"store_id": 0,
"sku": "24-WB06",
"price_from": "2017-07-15 00:00:00",
"price_to": "2017-07-16 23:59:59"
}
]Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/special-price
Admin token
Set special prices (bulk)
Sets special prices for products of type Simple, Bundle, Virtual or Downloadable.
Required fields per row: store_id, sku, price. On Adobe Commerce (Enterprise Edition) price_from is also required; on Magento Open Source it is optional.
An empty array indicates success; any returned rows represent entries that could not be saved.
Example request body:
{"prices":[{"price":29.95,"store_id":0,"price_from":"2017-07-15 00:00:00","price_to":"2017-07-16 23:59:59","sku":"24-WB06"}]}Request Body
{
"prices": [
{
"price": 29.95,
"store_id": 0,
"price_from": "2017-07-15 00:00:00",
"price_to": "2017-07-16 23:59:59",
"sku": "24-WB06"
}
]
}Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/special-price-delete
Admin token
Delete special prices (bulk)
Removes scheduled special prices for the supplied rows. Invalid items are silently excluded from the deletion.
Each row must include price, store_id, sku, price_from and price_to matching an existing special-price entry.
Example request body:
{"prices":[{"price":29.95,"store_id":0,"price_from":"2017-07-15 00:00:00","price_to":"2017-07-16 23:59:59","sku":"24-WB06"}]}Request Body
{
"prices": [
{
"price": 29.95,
"store_id": 0,
"price_from": "2017-07-15 00:00:00",
"price_to": "2017-07-16 23:59:59",
"sku": "24-WB06"
}
]
}Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories
Admin token
Get category tree
Get category tree.
Param opcional rootCategoryId.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/list
Admin token
List categories (searchCriteria)
List categories (searchCriteria).
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories
Admin token
Create a category
Creates a new category. The request body is a category object carrying core fields (parent_id, name, is_active, include_in_menu, level) plus a custom_attributes array for display and SEO metadata.
Supported custom_attributes include description, meta_title, meta_keywords, meta_description, url_key, url_path, is_anchor, display_mode, default_sort_by, landing_page, page_layout, image, custom_design, custom_design_from, custom_design_to, custom_layout_update, custom_apply_to_products, custom_use_parent_settings, filter_price_range, all_children, children, children_count, path, and path_in_store. Third-party modules may register additional codes.
The response returns the created category with its assigned id, computed position, created_at and updated_at timestamps, and the submitted custom attributes merged with any system-generated ones.
Example request body:
{"category":{"parent_id":2,"name":"Kids","is_active":true,"level":2,"include_in_menu":true,"custom_attributes":[{"attribute_code":"description","value":"kids category description"}]}}Request Body
{
"category": {
"parent_id": 2,
"name": "Kids",
"is_active": true,
"level": 2,
"include_in_menu": true,
"custom_attributes": [
{
"attribute_code": "description",
"value": "kids category description"
}
]
}
}Exemplo de Resposta
{
"id": 42,
"parent_id": 2,
"name": "Kids",
"is_active": true,
"position": 9,
"level": 2,
"created_at": "2020-12-18 08:50:47",
"updated_at": "2020-12-18 08:50:47"
}Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId
Admin token
Get a category
Get a category.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId
Admin token
Update a category
Update a category.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId
Admin token
Delete a category
Delete a category.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId/products
Admin token
Assign product to category
Assign product to category.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId/products
Admin token
Update a product assignment
Update a product assignment.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId/products/:sku
Admin token
Unassign a product
Unassign a product.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId/products
Admin token
List products in a category
List products in a category.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/categories/:categoryId/move
Admin token
Move a category
Move a category.
Body aceita parentId e afterId.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes
Admin token
List product attributes
List product attributes.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes
Admin token
Create a product attribute
Create a product attribute.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes/:attributeCode
Admin token
Get attribute by code
Get attribute by code.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes/:attributeCode
Admin token
Update attribute
Update attribute.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes/:attributeCode
Admin token
Delete attribute
Delete attribute.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes/:attributeCode/options
Admin token
List attribute options
List attribute options.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes/:attributeCode/options
Admin token
Add attribute option
Add attribute option.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attributes/:attributeCode/options/:optionId
Admin token
Delete attribute option
Delete attribute option.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets/sets/list
Admin token
List attribute sets
List attribute sets.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets
Admin token
Create attribute set
Create attribute set.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets/:attributeSetId
Admin token
Get attribute set
Get attribute set.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets/:attributeSetId
Admin token
Update attribute set
Update attribute set.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets/:attributeSetId
Admin token
Delete attribute set
Delete attribute set.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets/attributes
Admin token
Assign attribute to a set
Assign attribute to a set.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/attribute-sets/:attributeSetId/attributes/:attributeCode
Admin token
Unassign attribute
Unassign attribute.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/links/:type
Admin token
List product links (related/upsell/crosssell/associated)
List product links (related/upsell/crosssell/associated).
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/links
Admin token
Assign related/upsell/crosssell
Assign related/upsell/crosssell.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/links
Admin token
Update product links
Update product links.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/products/:sku/links/:type/:linkedProductSku
Admin token
Delete a link
Delete a link.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/children
Admin token
List configurable children
List configurable children.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/child
Admin token
Assign simple to configurable
Assign simple to configurable.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/children/:childSku
Admin token
Unassign simple
Unassign simple.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/options/all
Admin token
List configurable options
List configurable options.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/options/:id
Admin token
Get option by ID
Get option by ID.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/options
Admin token
Add configurable option
Add configurable option.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/options/:id
Admin token
Update option
Update option.
Status codes
OK
Bad Request
Unauthorized
Not Found
/rest/V1/configurable-products/:sku/options/:id
Admin token
Delete option
Delete option.
Status codes
OK
Bad Request
Unauthorized
Not Found