REST API reference cheat sheet
All our available endpoints. Just for you.
Products
Product [identifier]
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 [uuid]
Get list of products
get /api/rest/v1/products-uuid
PIM versions: 7.0 SaaS | PIM editions: CE EE
Create a new product
post /api/rest/v1/products-uuid
PIM versions: 7.0 SaaS | PIM editions: CE EE
Update/create several products
patch /api/rest/v1/products-uuid
PIM versions: 7.0 SaaS | PIM editions: CE EE
Get a product
get /api/rest/v1/products-uuid/{uuid}
PIM versions: 7.0 SaaS | PIM editions: CE EE
Update/create a product
patch /api/rest/v1/products-uuid/{uuid}
PIM versions: 7.0 SaaS | PIM editions: CE EE
Delete a product
delete /api/rest/v1/products-uuid/{uuid}
PIM versions: 7.0 SaaS | PIM editions: CE EE
Submit a draft for approval
post /api/rest/v1/products-uuid/{uuid}/proposal
PIM versions: 7.0 SaaS | PIM editions: EE
Get a draft
get /api/rest/v1/products-uuid/{uuid}/draft
PIM versions: 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
Delete a product model
delete /api/rest/v1/product-models/{code}
PIM versions: 6.0 7.0 SaaS | PIM editions: CE EE
Submit a draft for approval
post /api/rest/v1/product-models/{code}/proposal
PIM versions: 2.3 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get a draft
get /api/rest/v1/product-models/{code}/draft
PIM versions: 2.3 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: 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
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 familiy
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
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
Measurement family
Get list of measurement families
get /api/rest/v1/measurement-families
PIM versions: 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Update/create several measurement families
patch /api/rest/v1/measurement-families
PIM versions: 5.0 6.0 7.0 SaaS | PIM editions: CE EE
Reference entities
Reference entity
Get list of reference entities
get /api/rest/v1/reference-entities
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get a reference entity
get /api/rest/v1/reference-entities/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create a reference entity
patch /api/rest/v1/reference-entities/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Reference entity attribute
Get the list of attributes of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get an attribute of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create an attribute of a given reference entity
patch /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Reference entity attribute option
Get a list of attribute options of a given attribute for a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get an attribute option for a given attribute of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create a reference entity attribute option
patch /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Reference entity record
Get the list of the records of a reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/records
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create several reference entity records
patch /api/rest/v1/reference-entities/{reference_entity_code}/records
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get a record of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create a record of a given reference entity
patch /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Reference entity media file
Create a new media file for a reference entity or a record
post /api/rest/v1/reference-entities-media-files
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Download the media file associated to a reference entity or a record
get /api/rest/v1/reference-entities-media-files/{code}
PIM versions: 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Asset Manager
Asset family
Get list of asset families
get /api/rest/v1/asset-families
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get an asset family
get /api/rest/v1/asset-families/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create an asset family
patch /api/rest/v1/asset-families/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Asset attribute
Get the list of attributes of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get an attribute of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create an attribute of a given asset family
patch /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Asset attribute option
Get a list of attribute options of a given attribute for a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get an attribute option for a given attribute of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create an asset attribute option for a given asset family
patch /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Asset media file
Create a new media file for an asset
post /api/rest/v1/asset-media-files
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Download the media file associated to an asset
get /api/rest/v1/asset-media-files/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Asset
Get the list of the assets of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/assets
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create several assets
patch /api/rest/v1/asset-families/{asset_family_code}/assets
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Get an asset of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Update/create an asset
patch /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE
Delete an asset
delete /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
PIM versions: 3.2 4.0 5.0 6.0 7.0 SaaS | PIM editions: EE