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

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

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

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

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

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

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

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