REST API reference cheat sheet
All our available endpoints. Just for you.
Products
Product [identifier]
This API provides two endpoints for interacting with products:
- Product (UUID): We strongly recommend using this endpoint for its reliability and flexibility. UUIDs, or Universally Unique Identifiers, are guaranteed to be unique and never change, even if other product identifiers like SKUs are modified. This ensures consistent product identification regardless of future changes. Additionally, UUIDs allow interaction with products that lack a traditional identifier.
- Product (Identifier): This endpoint is useful when you already have a product identifier within your systems. This identifier, which could be a SKU or internal code, can be used to directly interact with the corresponding product in our API. This simplifies integration for workflows that rely on existing product identification methods.
Get list of products
get /api/rest/v1/products
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new product
post /api/rest/v1/products
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several products
patch /api/rest/v1/products
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a product
get /api/rest/v1/products/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create a product
patch /api/rest/v1/products/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Delete a product
delete /api/rest/v1/products/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Submit a draft for approval
post /api/rest/v1/products/{code}/proposal
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get a draft
get /api/rest/v1/products/{code}/draft
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Product model
Get list of product models
get /api/rest/v1/product-models
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new product model
post /api/rest/v1/product-models
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several product models
patch /api/rest/v1/product-models
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a product model
get /api/rest/v1/product-models/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create a product model
patch /api/rest/v1/product-models/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Product media file
Get a list of product media files
get /api/rest/v1/media-files
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new product media file
post /api/rest/v1/media-files
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a product media file
get /api/rest/v1/media-files/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Download a product media file
get /api/rest/v1/media-files/{code}/download
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Published products
Published product
Important update: Published Products discontinuation. This feature is no longer actively supported and will soon be retired. We recommend exploring alternative solutions. Learn more in the help center.
Get list of published products
get /api/rest/v1/published-products
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get a published product
get /api/rest/v1/published-products/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Catalog structure
Family
Get list of families
get /api/rest/v1/families
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new family
post /api/rest/v1/families
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several families
patch /api/rest/v1/families
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a family
get /api/rest/v1/families/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create a family
patch /api/rest/v1/families/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new family variant
post /api/rest/v1/families/{family_code}/variants
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Family variant
Get list of family variants
get /api/rest/v1/families/{family_code}/variants
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several family variants
patch /api/rest/v1/families/{family_code}/variants
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a family variant
get /api/rest/v1/families/{family_code}/variants/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create a family variant
patch /api/rest/v1/families/{family_code}/variants/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Attribute
Get list of attributes
get /api/rest/v1/attributes
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new attribute
post /api/rest/v1/attributes
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several attributes
patch /api/rest/v1/attributes
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get an attribute
get /api/rest/v1/attributes/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create an attribute
patch /api/rest/v1/attributes/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Attribute option
Get list of attribute options
get /api/rest/v1/attributes/{attribute_code}/options
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new attribute option
post /api/rest/v1/attributes/{attribute_code}/options
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several attribute options
patch /api/rest/v1/attributes/{attribute_code}/options
PIM versions: 2.1 2.2 2.3 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get an attribute option
get /api/rest/v1/attributes/{attribute_code}/options/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create an attribute option
patch /api/rest/v1/attributes/{attribute_code}/options/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Attribute group
Get list of attribute groups
get /api/rest/v1/attribute-groups
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new attribute group
post /api/rest/v1/attribute-groups
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several attribute groups
patch /api/rest/v1/attribute-groups
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get an attribute group
get /api/rest/v1/attribute-groups/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create an attribute group
patch /api/rest/v1/attribute-groups/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Association type
Get a list of association types
get /api/rest/v1/association-types
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new association type
post /api/rest/v1/association-types
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several association types
patch /api/rest/v1/association-types
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get an association type
get /api/rest/v1/association-types/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create an association type
patch /api/rest/v1/association-types/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Category
Get list of categories
get /api/rest/v1/categories
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new category
post /api/rest/v1/categories
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several categories
patch /api/rest/v1/categories
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a category
get /api/rest/v1/categories/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create a category
patch /api/rest/v1/categories/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Target market settings
Channel
Get a list of channels
get /api/rest/v1/channels
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Create a new channel
post /api/rest/v1/channels
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several channels
patch /api/rest/v1/channels
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a channel
get /api/rest/v1/channels/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create a channel
patch /api/rest/v1/channels/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Locale
Get a list of locales
get /api/rest/v1/locales
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a locale
get /api/rest/v1/locales/{code}
PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Currency
Get a list of currencies
get /api/rest/v1/currencies
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a currency
get /api/rest/v1/currencies/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Measure family
Get list of measure families (deprecated as of v5.0)
get /api/rest/v1/measure-families
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Get a measure family (deprecated as of v5.0)
get /api/rest/v1/measure-families/{code}
PIM versions: 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE
PAM - Deprecated
With the introduction of our new way to handle assets, the Asset Manager, the PAM feature has been removed from the v4.0 of the PIM. As a result, from now on, all the endpoints regarding the PAM assets are deprecated. They will not be available anymore starting from the v4.0.
To understand why, we recommend you to read this Medium post, we wrote on this special occasion.
Also, don't hesitate to take a look at the Asset Manager documentation to discover this new feature and how much more efficient it will be to handle your precious assets.
PAM asset - Deprecated
Get list of PAM assets
get /api/rest/v1/assets
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Create a new PAM asset
post /api/rest/v1/assets
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Update/create several PAM assets
patch /api/rest/v1/assets
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Get a PAM asset
get /api/rest/v1/assets/{code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Update/create a PAM asset
patch /api/rest/v1/assets/{code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
PAM asset reference file - Deprecated
Get a reference file
get /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Upload a new reference file
post /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Download a reference file
get /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
PAM asset variation file - Deprecated
Get a variation file
get /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Upload a new variation file
post /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Download a variation file
get /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
PAM asset category - Deprecated
Get list of PAM asset categories
get /api/rest/v1/asset-categories
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Create a new PAM asset category
post /api/rest/v1/asset-categories
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Update/create several PAM asset categories
patch /api/rest/v1/asset-categories
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Get a PAM asset category
get /api/rest/v1/asset-categories/{code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Update/create a PAM asset category
patch /api/rest/v1/asset-categories/{code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
PAM asset tag - Deprecated
Get list of PAM asset tags
get /api/rest/v1/asset-tags
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Get a PAM asset tag
get /api/rest/v1/asset-tags/{code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Update/create a PAM asset tag
patch /api/rest/v1/asset-tags/{code}
PIM versions: 2.1 2.2 2.3 3.x | PIM editions: EE | deprecated
Overview
Authentication