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 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. After careful consideration and in alignment with our long-term product vision, we have made the decision to remove this feature on February 28, 2024. 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

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

Utilities

Overview

Get list of all endpoints

get /api/rest/v1

PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE

Authentication

Get authentication token

post /api/oauth/v1/token

PIM versions: 1.7 2.x 3.x 4.0 5.0 6.0 7.0 SaaS | PIM editions: CE EE