How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

commercetools Products API

Manage product catalog entries including variants, images, prices, and attributes.

commercetools Products API is one of 19 APIs that commercetools publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Product. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 6 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.{region}.commercetools.com, https://import.{region}.commercetools.com.

6 operations 3 paths 20 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.{region}.commercetools.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

commercetools Products API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained from the commercetools authentication service at https://auth.{region}.commercetools.com/oauth/token using client credentials f…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Products 6

Manage product catalog entries including variants, images, prices, and attributes.

GET
/{projectKey}/products
List products
listProducts 6 params → 200400401
POST
/{projectKey}/products
Create a product
createProduct 1 param body → 201400401
GET
/{projectKey}/products/{id}
Get a product by ID
getProductById 3 params → 200401404
POST
/{projectKey}/products/{id}
Update a product by ID
updateProductById 2 params body → 200400409
DELETE
/{projectKey}/products/{id}
Delete a product by ID
deleteProductById 3 params → 200409
POST
/{projectKey}/products/import-containers/{importContainerKey}
Import products
importProducts 2 params body → 201400

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ProductDraft (10 properties), Product (9 properties), ProductData (8 properties), ProductImport (7 properties). Each schema is shown below with its type and property counts.

ProductVariantDraft
object
Draft for creating a product variant.
5 properties
Reference
object
A reference to another resource by its typeId and id.
2 properties 2 required
ProductData
object
A version of product data including names, slugs, descriptions, variants, and category assignments.
8 properties 5 required
ProductPagedQueryResponse
object
Paginated response containing a list of products.
5 properties 5 required
ProductDraft
object
Request body for creating a new product.
10 properties 3 required
PriceDraft
object
Draft for creating a price on a product variant.
6 properties 1 required
Attribute
object
A name-value pair representing a product attribute as defined by the product type.
2 properties 2 required
Price
object
A price entry for a product variant with optional scoping by channel, customer group, country, or validity period.
7 properties 2 required
LocalizedString
object
A map of locale keys to string values used for multilingual content. Keys follow IETF language tag format (e.g., 'en', 'de', 'en-US').
Money
object
A monetary value with currency code and amount in the smallest currency unit.
3 properties 2 required
ProductUpdate
object
Request body for updating a product using versioned update actions.
2 properties 2 required
Image
object
A product image with URL, dimensions, and optional label.
3 properties 2 required
ProductCatalogData
object
Container for current (published) and staged product data.
4 properties 2 required
ProductVariant
object
A product variant with SKU, attributes, prices, and images.
6 properties 1 required
Product
object
A commercetools product resource containing both the current (published) and staged versions of product data including variants, attributes, and metadata.
9 properties 4 required
ImportResponse
object
The response returned after submitting an import request batch.
1 property 1 required
ProductImport
object
A single product resource for import, matched by key for upsert behavior.
7 properties 4 required
ErrorObject
object
An error object describing a validation or processing failure.
2 properties 2 required
ProductImportRequest
object
A batch of product resources to import into the project.
2 properties 2 required
ImportOperationStatus
object
The initial status of a single resource submission in an import batch.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

commercetools-products-api-openapi.yml Raw ↑

Other APIs commercetools publishes across the network.

Commercetools GraphQL API
Commercetools TypeScript SDK
Commercetools Java SDK
Commercetools Checkout API
Commercetools Merchant Center Customizations API
commercetools Carts API
commercetools Categories API
commercetools ChangeHistory API
commercetools Customers API
commercetools ImportContainers API
commercetools ImportOperations API
commercetools Inventory API
Where this information came from

This is an independent, third-party profile of commercetools Products API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.