REST API reference cheat sheet

All our available endpoints. Just for you.

Products

Product [uuid]

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.

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.

Product model

Product media file

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.

Catalog structure

Family

Family variant

Attribute

Attribute option

Attribute group

Association type

Category

Target market settings

Channel

Locale

Currency

Measure family

Measurement family

Reference entities

Reference entity

Reference entity attribute

Reference entity attribute option

Reference entity record

Reference entity media file

Asset Manager

Asset family

Asset attribute

Asset attribute option

Asset media file

Asset

Catalogs for Apps

Catalogs

Catalog products

Mapping schema for products

Utilities

Overview

Authentication

System