Commercetools API Reference

https://github.com/commercetools/commercetools-api-reference
Admin
API specification and reference documentation for the commercetools Composable Commerce Platform...
Tokens:154,998
Snippets:839
Trust Score:9.9
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /{projectKey}/products/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

Get a product by its key. Supports price selection.

```APIDOC
## GET /{projectKey}/products/key={key}

### Description
Get a product by its key. Supports price selection.

### Method
GET

### Endpoint
/{projectKey}/products/key={key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the product.

### Response
#### Success Response (200)
- **Product** - The product with the specified key.

#### Response Example
```json
{
  "id": "product-id",
  "version": 1,
  "key": "product-key",
  "productType": {
    "typeId": "product-type",
    "id": "product-type-id"
  },
  "name": {
    "en": "Product Name"
  },
  "slug": {
    "en": "product-slug"
  }
}
```
```

--------------------------------

### GET /{projectKey}/customers/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Get a Customer by key.

```APIDOC
## GET /{projectKey}/customers/key={key}

### Description
Get a Customer by key.

### Method
GET

### Endpoint
/{projectKey}/customers/key={key}

### Parameters
#### Path Parameters
- **key** (string) - Required - Customer key.

### Response
#### Success Response (200)
- **Customer** - The customer.
```

--------------------------------

### GET /{projectKey}/customers/email-token={emailToken}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Get a Customer by email token.

```APIDOC
## GET /{projectKey}/customers/email-token={emailToken}

### Description
Get a Customer by email token.

### Method
GET

### Endpoint
/{projectKey}/customers/email-token={emailToken}

### Parameters
#### Path Parameters
- **emailToken** (string) - Required - The email token.

### Response
#### Success Response (200)
- **Customer** - The customer associated with the token.
```

--------------------------------

### GET /{projectKey}/customers/password-token={passwordToken}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Get a Customer by password token.

```APIDOC
## GET /{projectKey}/customers/password-token={passwordToken}

### Description
Get a Customer by password token.

### Method
GET

### Endpoint
/{projectKey}/customers/password-token={passwordToken}

### Parameters
#### Path Parameters
- **passwordToken** (string) - Required - The password token.

### Response
#### Success Response (200)
- **Customer** - The customer associated with the token.
```

--------------------------------

### GET /{projectKey}/customers/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Get a Customer by ID.

```APIDOC
## GET /{projectKey}/customers/{ID}

### Description
Get a Customer by ID.

### Method
GET

### Endpoint
/{projectKey}/customers/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Customer ID.

### Response
#### Success Response (200)
- **Customer** - The customer.
```

--------------------------------

### GET /applications/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves an application by key.

```APIDOC
## GET /applications/key={key}

### Description
Retrieves an application by key.

### Method
GET

### Endpoint
`https://checkout.{region}.commercetools.com/applications/key={key}`

### Parameters
#### Path Parameters
- **key** (string) - Required - The application key.

### Response
#### Success Response (200)
- **Application** - The application.

#### Response Example
```json
{
  "id": "application-id"
}
```
```

--------------------------------

### GET /{projectKey}/products/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

Get a product by its ID. Supports price selection.

```APIDOC
## GET /{projectKey}/products/{ID}

### Description
Get a product by its ID. Supports price selection.

### Method
GET

### Endpoint
/{projectKey}/products/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - The ID of the product.

### Response
#### Success Response (200)
- **Product** - The product with the specified ID.

#### Response Example
```json
{
  "id": "product-id",
  "version": 1,
  "productType": {
    "typeId": "product-type",
    "id": "product-type-id"
  },
  "name": {
    "en": "Product Name"
  },
  "slug": {
    "en": "product-slug"
  }
}
```
```

--------------------------------

### GET /{projectKey}/applications

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves a paginated list of applications.

```APIDOC
## GET /{projectKey}/applications

### Description
Retrieves a paginated list of applications.

### Method
GET

### Endpoint
`https://checkout.{region}.commercetools.com/{projectKey}/applications`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.

### Response
#### Success Response (200)
- **PaginatedApplication** - The paginated list.

#### Response Example
```json
{
  "results": []
}
```
```

--------------------------------

### JSON error response for ConcurrentModification

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/errors.md

Example JSON response returned when the version is stale, with statusCode 409 and an error code of ConcurrentModification.

```json
{
  "statusCode": 409,
  "message": "Object my-project/cart/key=my-cart has a different version than expected. Expected: 99 - Actual: 12.",
  "errors": [
    { "code": "ConcurrentModification", "message": "Object my-project/cart/key=my-cart has a different version than expected. Expected: 99 - Actual: 12.", "currentVersion": 12 }
  ]
}
```

--------------------------------

### Catch errors in consumer code

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/errors.md

Example of making an API request that triggers a concurrent modification error, and the consumer-side pattern for handling errors based on status codes and error codes.

```APIDOC
## POST /my-project/carts/key=my-cart

### Description
Updates a cart by key with a set of actions. In this example, a stale version is sent to trigger a concurrent modification error.

### Method
POST

### Endpoint
https://api.europe-west1.gcp.commercetools.com/my-project/carts/key=my-cart

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key (here: my-project)
- **cartKey** (string) - Required - The cart key (here: my-cart)

#### Request Body
- **version** (integer) - Required - The expected version of the cart.
- **actions** (array) - Required - List of update actions.

### Request Example
{
  "version": 99,
  "actions": [
    { "action": "setCustomerEmail", "email": "x@example.com" }
  ]
}

### Response
#### Success Response (200)
- **statusCode** (number) - HTTP status code
- **message** (string) - Human-readable message
- **errors** (array) - List of error objects

#### Error Response (409)
- **statusCode** (number) - HTTP status code (409)
- **message** (string) - Error message
- **errors** (array) - List of error objects, each with a code and message
- **errors[].code** (string) - Error code, e.g., "ConcurrentModification"
- **errors[].currentVersion** (number) - The current version of the resource

#### Response Example
{
  "statusCode": 409,
  "message": "Object my-project/cart/key=my-cart has a different version than expected. Expected: 99 - Actual: 12.",
  "errors": [
    { "code": "ConcurrentModification", "message": "Object my-project/cart/key=my-cart has a different version than expected. Expected: 99 - Actual: 12.", "currentVersion": 12 }
  ]
}

### Error Handling
Consumer-side pattern:
- status == 409 && errors[0].code == "ConcurrentModification" → re-fetch and merge
- status == 400 && errors[0].code == "InvalidField" → read field / invalidValue / allowedValues
- status == 400 && errors[0].code == "ReferencedResourceNotFound" → read typeId / field / key
- status == 502/503 && code in ["BadGateway", "OverCapacity", "PendingOperation"] → retry with exponential backoff
```

--------------------------------

### Define a query endpoint with traits and annotations

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/api-specs/readme.md

Example of a resource definition for a query endpoint, including type, annotations, description, get method with scopes, query parameters, and response example.

```raml
type:
  baseDomain:
    resourceType: Cart
    resourceQueryType: CartPagedQueryResponse
    resourceDraft: CartDraft
    whereExample: 'customerEmail = "john.doe@example.com"'
    sortExample: createdAt asc
(updateable): Cart
(deleteable): Cart
(createable): CartDraft
description: A shopping cart holds product variants and can be ordered.
get:
  securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
  queryParameters:
    customerId?:
      type: string
  responses:
    200:
      body:
        application/json:
          example: !include ../examples/carts.example.json
```

--------------------------------

### POST /{projectKey}/customers

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Create (sign up) a Customer. Returns a CustomerSignInResult.

```APIDOC
## POST /{projectKey}/customers

### Description
Create (sign up) a Customer. Returns a CustomerSignInResult.

### Method
POST

### Endpoint
/{projectKey}/customers

### Parameters
#### Request Body
- **email** (string) - Required - Customer email.
- **password** (string) - Required - Customer password.
- **firstName** (string) - Optional - Customer first name.
- **lastName** (string) - Optional - Customer last name.
- **middleName** (string) - Optional - Customer middle name.
- **title** (string) - Optional - Customer title.
- **salutation** (string) - Optional - Customer salutation.
- **dateOfBirth** (date) - Optional - Customer date of birth.
- **companyName** (string) - Optional - Customer company name.
- **vatId** (string) - Optional - Customer VAT ID.
- **customerGroup** (object) - Optional - Customer group reference.
- **stores** (array) - Optional - Stores associated with the customer.
- **anonymousCart** (object) - Optional - Anonymous cart reference.
- **anonymousId** (string) - Optional - Anonymous ID.
- **businessUnit** (object) - Optional - Business unit reference.
- **key** (string) - Optional - Unique key.
- **addresses** (array) - Required - Addresses.
- **defaultShippingAddress** (integer) - Optional - Index of default shipping address.
- **defaultBillingAddress** (integer) - Optional - Index of default billing address.
- **custom** (object) - Optional - Custom fields.
- **locale** (string) - Optional - Locale.
- **isEmailVerified** (boolean) - Optional - Whether email is verified.
- **externalId** (string) - Optional - External ID.

### Request Example
```json
{
  "email": "email@example.com",
  "password": "secret",
  "firstName": "John",
  "lastName": "Doe",
  "addresses": []
}
```

### Response
#### Success Response (201)
- **CustomerSignInResult** - Contains the created customer and optional cart.

#### Response Example
```json
{
  "customer": {},
  "cart": {}
}
```

### Errors
- **DuplicateFieldError** - A field value is duplicated.
- **AnonymousIdAlreadyInUseError** - The anonymous ID is already in use.
- **InvalidSubjectError** - The subject is invalid.
```

--------------------------------

### Create a method: RAML example for adding a new method to an endpoint

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/api-specs/readme.md

Shows the RAML structure for adding a new method to an endpoint. Requires modifying the related resource file, adding a methodName annotation, defining a baseResource with uriParameterName and resourceType, and specifying the HTTP method (usually get or post).

```raml
/password-token={passwordToken}:
  (methodName): withPasswordToken
  type:
    baseResource:
      uriParameterName: passwordToken
      resourceType: Customer
  get:
    displayName: Get customer by password verification token
    securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }]
    responses:
      200:
        body:
          application/json:
            example: !include ../examples/customer.example.json
```

--------------------------------

### Install dependencies and generate Postman Collection

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/api-specs/generate-a-postman-collection.md

When errors appear in the Terminal, install dependencies with 'yarn install' and then run the generation command again.

```bash
yarn install

yarn run generate-postman
```

--------------------------------

### POST /me/signup

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Registers a new customer.

```APIDOC
## POST /me/signup

### Description
Registers a new customer.

### Method
POST

### Endpoint
/me/signup

### Response
#### Success Response (200)
- **customer** (object) - The created customer.

#### Response Example
{
  "customer": {}
}
```

--------------------------------

### GET /{projectKey}/applications

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/checkout-api.md

Queries applications. Returns a paginated list of applications. The withTotal parameter defaults to true.

```APIDOC
## GET /{projectKey}/applications

### Description
Queries applications. Returns a paginated list of applications. The withTotal parameter defaults to true.

### Method
GET

### Endpoint
/{projectKey}/applications

### Parameters
#### Query Parameters
- **withTotal** (boolean) - Optional - Whether to include total count (default `true`)

### Response
#### Success Response (200)
- **PaginatedApplication** - Paginated list of applications

#### Response Example
```json
{
  "results": []
}
```
```

--------------------------------

### GET /{projectKey}/variants/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/product-projections.md

Gets a variant by ID.

```APIDOC
## GET /{projectKey}/variants/{ID}

### Description
Gets a variant by ID.

### Method
GET

### Endpoint
/{projectKey}/variants/{ID}

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **ID** (string) - Required - The variant ID.
```

--------------------------------

### POST /{projectKey}/<r>

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Create a new resource. Returns the created resource with a 201 status.

```APIDOC
## POST /{projectKey}/<r>

### Description
Create a new resource. Returns the created resource with a 201 status.

### Method
POST

### Endpoint
`/{projectKey}/<r>`

### Parameters
#### Request Body
- **<R>Draft** (object) - Required - The draft object for creating the resource

### Response
#### Success Response (201)
- **<R>** - The created resource

#### Response Example
```json
{
  "id": "string"
}
```
```

--------------------------------

### GET /{projectKey}/variants/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/product-projections.md

Gets a variant by key.

```APIDOC
## GET /{projectKey}/variants/key={key}

### Description
Gets a variant by key.

### Method
GET

### Endpoint
/{projectKey}/variants/key={key}

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **key** (string) - Required - The variant key.
```

--------------------------------

### Create a Product with curl

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

POST to the products endpoint to create a product. Requires an access token and a product type ID. Returns 201 with the created Product.

```bash
curl -sS -X POST 'https://api.europe-west1.gcp.commercetools.com/my-project/products' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productType": { "typeId": "product-type", "id": "24f510c3-f334-4099-94e2-d6224a8eb919" },
    "name": { "en": "Some Product" },
    "slug": { "en": "some-product" },
    "masterVariant": {
      "sku": "SKU-1",
      "prices": [ { "value": { "currencyCode": "EUR", "centAmount": 4200 } } ]
    }
  }'
```

--------------------------------

### HEAD /{projectKey}/products/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

Check if a product with the given key exists. Returns 200 if it exists, otherwise 404.

```APIDOC
## HEAD /{projectKey}/products/key={key}

### Description
Check if a product with the given key exists. Returns 200 if it exists, otherwise 404.

### Method
HEAD

### Endpoint
/{projectKey}/products/key={key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the product.

### Response
#### Success Response (200)
- **No content** - Indicates that the product exists.

#### Error Response (404)
- **No content** - Indicates that the product does not exist.
```

--------------------------------

### POST /{projectKey}/in-business-unit/key={businessUnitKey}/me/customers

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/business-units.md

Creates a new Customer and associates it with the Business Unit. Requires the UpdateAssociates Permission, otherwise an AssociateMissingPermissionError is returned.

```APIDOC
## POST /{projectKey}/in-business-unit/key={businessUnitKey}/me/customers

### Description
Creates a new Customer and associates it with the Business Unit. No support for assigning existing Customers.

### Method
POST

### Endpoint
`/{projectKey}/in-business-unit/key={businessUnitKey}/me/customers`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **businessUnitKey** (string) - Required - The key of the Business Unit.

#### Request Body
- **MyBusinessUnitAssociateDraft** (object) - Required - The draft containing the associate details.

### Request Example
```json
{
  "email": "associate@example.com",
  "password": "secret",
  "firstName": "Jane",
  "lastName": "Doe"
}
```

### Response
#### Success Response (201)
- **CustomerSignInResult** (object) - The result containing the created customer and sign-in information.

#### Response Example
```json
{
  "customer": {
    "id": "customer-id",
    "email": "associate@example.com"
  }
}
```

### Error Handling
- **AssociateMissingPermissionError** - Returned if the caller lacks the `UpdateAssociates` permission.
```

--------------------------------

### GET /product-projections/suggest

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/product-projections.md

Get search keyword suggestions. Returns a SuggestionResult.

```APIDOC
## GET /product-projections/suggest

### Description
Get search keyword suggestions.

### Method
GET

### Endpoint
`https://api.europe-west1.gcp.commercetools.com/my-project/product-projections/suggest`

### Parameters
#### Query Parameters
- **searchKeywords.en** (string) - Required - The search keywords in the specified locale. At least one such parameter is required.

### Request Example
```bash
curl -sS -X GET 'https://api.europe-west1.gcp.commercetools.com/my-project/product-projections/suggest?searchKeywords.en=jea' \
  -H 'Authorization: Bearer <access_token>'
```

### Response
#### Success Response (200)
- **SuggestionResult** - The suggestion result containing suggested keywords per locale.

#### Response Example
`200` → `SuggestionResult` `{ "en": [ { "text": "jeans" } ] }`.

### Error Handling
- **400** - If the `searchKeywords.<locale>` parameter is omitted entirely, a 400 error is returned because at least one such parameter is required.
```

--------------------------------

### HEAD /{projectKey}/<r>

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Check if a resource exists. Returns 200 if found, 404 if not.

```APIDOC
## HEAD /{projectKey}/<r>

### Description
Check if a resource exists. Returns 200 if found, 404 if not.

### Method
HEAD

### Endpoint
`/{projectKey}/<r>`

### Parameters
#### Query Parameters
- **where** (string) - Optional - Filter predicate

### Response
#### Success Response (200)
- **200** - Resource exists

#### Success Response (404)
- **404** - Resource not found
```

--------------------------------

### GET /{projectKey}/customers/search/indexing-status

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Get indexing status of Customer Search.

```APIDOC
## GET /{projectKey}/customers/search/indexing-status

### Description
Get indexing status of Customer Search.

### Method
GET

### Endpoint
/{projectKey}/customers/search/indexing-status

### Response
#### Success Response (200)
- **CustomerSearchIndexingStatusResponse** - Indexing status.
```

--------------------------------

### GET /{projectKey}/customers/{ID}/custom-objects

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/customers.md

Get CustomObjects of a Customer.

```APIDOC
## GET /{projectKey}/customers/{ID}/custom-objects

### Description
Get CustomObjects of a Customer.

### Method
GET

### Endpoint
/{projectKey}/customers/{ID}/custom-objects

### Parameters
#### Path Parameters
- **ID** (string) - Required - Customer ID.

#### Query Parameters
- **where** (string) - Optional - Query predicate.
- **sort** (string) - Optional - Sort criteria.
- **limit** (integer) - Optional - Maximum number of results.
- **offset** (integer) - Optional - Offset for pagination.

### Response
#### Success Response (200)
- **CustomObjectPagedQueryResponse** - Paged list of custom objects.
```

--------------------------------

### POST /my-project/products/import-containers/{containerKey}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/import-api.md

Submits an import request for products into a specified import container. Requires a token with the manage_products scope for the project.

```APIDOC
## POST /my-project/products/import-containers/{containerKey}

### Description
Submits an import request for products into a specified import container.

### Method
POST

### Endpoint
https://import.europe-west1.gcp.commercetools.com/my-project/products/import-containers/my-first-container

### Parameters
#### Path Parameters
- **containerKey** (string) - Required - The key of the import container.

#### Request Body
- **type** (string) - Required - The type of resources being imported (e.g., product).
- **resources** (array) - Required - List of resources to import.
  - **key** (string) - Required - Unique key for the resource.
  - **name** (object) - Required - Localized name of the product.
  - **productType** (object) - Required - Reference to the product type.
    - **key** (string) - Required - Key of the product type.
    - **typeId** (string) - Required - Type identifier (e.g., product-type).
  - **slug** (object) - Required - Localized slug for the product.
  - **masterVariant** (object) - Required - The master variant of the product.
    - **sku** (string) - Required - Stock keeping unit.
    - **prices** (array) - Required - List of prices.
      - **key** (string) - Required - Price key.
      - **value** (object) - Required - Price value.
        - **currencyCode** (string) - Required - ISO currency code.
        - **centAmount** (integer) - Required - Amount in cents.

### Request Example
```json
{
  "type": "product",
  "resources": [
    {
      "key": "product-1",
      "name": { "en": "Jeans" },
      "productType": { "key": "main-product-type", "typeId": "product-type" },
      "slug": { "en": "jeans" },
      "masterVariant": { "sku": "JEANS-1", "prices": [ { "key": "price-1", "value": { "currencyCode": "EUR", "centAmount": 4200 } } ] }
    }
  ]
}
```

### Response
#### Success Response (201)
Returns an ImportResponse containing the ImportOperation id and status.
```

--------------------------------

### GET /me/quotes

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves quotes for the customer. Supports GET, HEAD, and sub-resource operations.

```APIDOC
## GET /me/quotes

### Description
Retrieves quotes for the customer. Supports GET, HEAD, and sub-resource operations.

### Method
GET

### Endpoint
/me/quotes

### Response
#### Success Response (200)
- **results** (array) - List of quotes.

#### Response Example
{
  "results": []
}
```

--------------------------------

### POST /me/signup

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/me.md

Creates a new Customer (sign up) using a MyCustomerDraft. Returns a CustomerSignInResult with the created customer and possibly a cart or order.

```APIDOC
## POST /me/signup

### Description
Creates a new Customer (sign up) using a MyCustomerDraft.

### Method
POST

### Endpoint
/me/signup

### Parameters
#### Request Body
- **MyCustomerDraft** - Required - Customer draft data

### Response
#### Success Response (201)
- **CustomerSignInResult** - Contains the created customer and optionally a cart or order
```

--------------------------------

### HEAD /{projectKey}/products

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

Check if any products exist that match the given query predicate. Returns 200 if at least one product matches, otherwise 404.

```APIDOC
## HEAD /{projectKey}/products

### Description
Check if any products exist that match the given query predicate. Returns 200 if at least one product matches, otherwise 404.

### Method
HEAD

### Endpoint
/{projectKey}/products

### Parameters
#### Query Parameters
- **where** (string[]) - Optional - Query predicates.

### Response
#### Success Response (200)
- **No content** - Indicates that at least one product matches the predicate.

#### Error Response (404)
- **No content** - Indicates that no products match the predicate.
```

--------------------------------

### GET /me/payments

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves payments for the customer. Supports GET, HEAD, POST, and sub-resource operations.

```APIDOC
## GET /me/payments

### Description
Retrieves payments for the customer. Supports GET, HEAD, POST, and sub-resource operations.

### Method
GET

### Endpoint
/me/payments

### Response
#### Success Response (200)
- **results** (array) - List of payments.

#### Response Example
{
  "results": []
}
```

--------------------------------

### GET /me/orders

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves orders for the customer. Supports GET, HEAD, POST, and sub-resource operations.

```APIDOC
## GET /me/orders

### Description
Retrieves orders for the customer. Supports GET, HEAD, POST, and sub-resource operations.

### Method
GET

### Endpoint
/me/orders

### Response
#### Success Response (200)
- **results** (array) - List of orders.

#### Response Example
{
  "results": []
}
```

--------------------------------

### POST /{projectKey}/applications

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/checkout-api.md

Creates a new application. Requires the 'manage' scope. The request body must be an ApplicationDraft.

```APIDOC
## POST /{projectKey}/applications

### Description
Creates a new application. Requires the 'manage' scope. The request body must be an ApplicationDraft.

### Method
POST

### Endpoint
/{projectKey}/applications

### Parameters
#### Request Body
- **ApplicationDraft** (object) - Required - The draft data for the application

### Request Example
```json
{
  "name": "string"
}
```

### Response
#### Success Response (201)
- **Application** - The created application

#### Response Example
```json
{
  "id": "string"
}
```
```

--------------------------------

### GET /me/carts

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves carts for the customer. Supports GET, HEAD, POST, and sub-resource operations.

```APIDOC
## GET /me/carts

### Description
Retrieves carts for the customer. Supports GET, HEAD, POST, and sub-resource operations.

### Method
GET

### Endpoint
/me/carts

### Response
#### Success Response (200)
- **results** (array) - List of carts.

#### Response Example
{
  "results": []
}
```

--------------------------------

### GET /{projectKey}/products

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/platform-api.md

Accesses the products resource. Pagination is handled via ProductPagedQueryResponse.

```APIDOC
## GET /{projectKey}/products

### Description
Accesses the products resource. Pagination is handled via `ProductPagedQueryResponse`.

### Method
GET

### Endpoint
`/{projectKey}/products`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The key of the Project.

### Response
#### Success Response (200)
- **productPagedQueryResponse** (ProductPagedQueryResponse) - Paginated list of products.
```

--------------------------------

### GET /me

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves the customer profile of the logged-in user. Supports GET, POST, and DELETE.

```APIDOC
## GET /me

### Description
Retrieves the customer profile of the logged-in user. Supports GET, POST, and DELETE.

### Method
GET

### Endpoint
/me

### Response
#### Success Response (200)
- **customer** (object) - The customer profile.

#### Response Example
{
  "customer": {}
}
```

--------------------------------

### POST /{projectKey}/in-store/key={storeKey}/login

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Logs in a customer within a store context. Mirrors project-scoped routes with store-specific scopes.

```APIDOC
## POST /{projectKey}/in-store/key={storeKey}/login

### Description
Logs in a customer within a store context. Mirrors project-scoped routes with store-specific scopes.

### Method
POST

### Endpoint
/{projectKey}/in-store/key={storeKey}/login

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **storeKey** (string) - Required - The store key.

### Response
#### Success Response (200)
- **token** (string) - The authentication token.

#### Response Example
{
  "token": ""
}
```

--------------------------------

### GET /{projectKey}/orders/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/carts-orders.md

Gets an order by its ID. Requires the view_orders scope for the project.

```APIDOC
## GET /{projectKey}/orders/{ID}

### Description
Gets an order by its ID.

### Method
GET

### Endpoint
/{projectKey}/orders/{ID}

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **ID** (string) - Required - The order ID.

### Response
#### Success Response (200)
- **Order** - The order.

#### Response Example
```json
{
  "id": "order-id",
  "version": 1
}
```
```

--------------------------------

### GET /me/quote-requests

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves quote requests for the customer. Supports GET, HEAD, POST, and sub-resource operations.

```APIDOC
## GET /me/quote-requests

### Description
Retrieves quote requests for the customer. Supports GET, HEAD, POST, and sub-resource operations.

### Method
GET

### Endpoint
/me/quote-requests

### Response
#### Success Response (200)
- **results** (array) - List of quote requests.

#### Response Example
{
  "results": []
}
```

--------------------------------

### POST /{projectKey}/main/session/scope

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/auxiliary-apis.md

Selects store and channels for the session.

```APIDOC
## POST /{projectKey}/main/session/scope

### Description
Selects store and channels for the session.

### Method
POST

### Endpoint
`/{projectKey}/main/session/scope`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.

### Response
#### Success Response (200)
No response body is documented.
```

--------------------------------

### Sign in to a Store (curl)

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/in-store.md

Sends a POST request to authenticate a customer in a store. Requires a token with the `manage_customers:my-project:berlin-store` scope. Returns a `CustomerSignInResult` on success, or a `400` with `InvalidCredentials` if the customer's stores do not include the target store.

```bash
curl -sS -X POST 'https://api.europe-west1.gcp.commercetools.com/my-project/in-store/key=berlin-store/login' \
  -H 'Authorization: Bearer <token-with-manage_customers:my-project:berlin-store>' \
  -H 'Content-Type: application/json' \
  -d '{ "email": "johndoe@example.com", "password": "secret123" }'
```

--------------------------------

### GET /me/business-units

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/endpoints.md

Retrieves business units for the customer. Supports GET, HEAD, POST, and sub-resource operations.

```APIDOC
## GET /me/business-units

### Description
Retrieves business units for the customer. Supports GET, HEAD, POST, and sub-resource operations.

### Method
GET

### Endpoint
/me/business-units

### Response
#### Success Response (200)
- **results** (array) - List of business units.

#### Response Example
{
  "results": []
}
```

--------------------------------

### GET /{projectKey}/payment-integrations

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/checkout-api.md

Queries payment integrations. Returns a paginated list of payment integrations. The withTotal parameter defaults to true.

```APIDOC
## GET /{projectKey}/payment-integrations

### Description
Queries payment integrations. Returns a paginated list of payment integrations. The withTotal parameter defaults to true.

### Method
GET

### Endpoint
/{projectKey}/payment-integrations

### Parameters
#### Query Parameters
- **withTotal** (boolean) - Optional - Whether to include total count (default `true`)

### Response
#### Success Response (200)
- **PaginatedPaymentIntegration** - Paginated list of payment integrations

#### Response Example
```json
{
  "results": []
}
```
```

--------------------------------

### GET /{projectKey}/orders/edits/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/carts-orders.md

Gets an order edit by its ID. Requires the view_order_edits scope for the project.

```APIDOC
## GET /{projectKey}/orders/edits/{ID}

### Description
Gets an order edit by its ID.

### Method
GET

### Endpoint
/{projectKey}/orders/edits/{ID}

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **ID** (string) - Required - The order edit ID.

### Response
#### Success Response (200)
- **OrderEdit** - The order edit.

#### Response Example
```json
{
  "id": "edit-id",
  "version": 1
}
```
```

--------------------------------

### GET /{projectKey}/orders/edits/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/carts-orders.md

Gets an order edit by its key. Requires the view_order_edits scope for the project.

```APIDOC
## GET /{projectKey}/orders/edits/key={key}

### Description
Gets an order edit by its key.

### Method
GET

### Endpoint
/{projectKey}/orders/edits/key={key}

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **key** (string) - Required - The key of the order edit.

### Response
#### Success Response (200)
- **OrderEdit** - The order edit.

#### Response Example
```json
{
  "id": "edit-id",
  "key": "edit-key"
}
```
```

--------------------------------

### POST /{projectKey}/products

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

Create a new product. The request body must be a ProductDraft. Returns the created Product and produces a ProductCreated Message.

```APIDOC
## POST /{projectKey}/products

### Description
Create a new product. The request body must be a ProductDraft. Returns the created Product and produces a ProductCreated Message.

### Method
POST

### Endpoint
/{projectKey}/products

### Parameters
#### Request Body
- **productType** (Reference) - Required - Reference to the product type.
- **name** (LocalizedString) - Required - Name of the product.
- **slug** (LocalizedString) - Required - Slug of the product.
- **masterVariant** (ProductVariantDraft) - Optional - Master variant of the product.
- **variants** (ProductVariantDraft[]) - Optional - Additional variants.
- **attributes** (Attribute[]) - Optional - Attributes for the product.
- **publish** (boolean) - Optional - Whether to publish the product.
- **taxCategory** (Reference) - Optional - Reference to a tax category.
- **categories** (Reference[]) - Optional - References to categories.
- **state** (Reference) - Optional - Reference to a state.
- **key** (string) - Optional - Unique key for the product.
- **metaTitle** (LocalizedString) - Optional - Meta title.
- **metaDescription** (LocalizedString) - Optional - Meta description.
- **metaKeywords** (LocalizedString) - Optional - Meta keywords.
- **searchKeywords** (SearchKeywords) - Optional - Search keywords.
- **priceMode** (string) - Optional - Price mode.

### Request Example
```json
{
  "productType": {
    "typeId": "product-type",
    "id": "product-type-id"
  },
  "name": {
    "en": "Product Name"
  },
  "slug": {
    "en": "product-slug"
  },
  "publish": true
}
```

### Response
#### Success Response (201)
- **Product** - The created product.

#### Response Example
```json
{
  "id": "product-id",
  "version": 1,
  "productType": {
    "typeId": "product-type",
    "id": "product-type-id"
  },
  "name": {
    "en": "Product Name"
  },
  "slug": {
    "en": "product-slug"
  }
}
```

#### Error Response
- **OverlappingPriceValidityError** - Returned if price validity periods overlap.
```

--------------------------------

### GET /{projectKey}/variant-projections/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/product-projections.md

Get a VariantProjection by ID. Also provides access to the `/variant-attributes` sub-resource.

```APIDOC
## GET /{projectKey}/variant-projections/{ID}

### Description
Get a VariantProjection by ID. Also provides access to the `/variant-attributes` sub-resource.

### Method
GET

### Endpoint
`/{projectKey}/variant-projections/{ID}`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The ID of the variant projection.

### Response
#### Success Response (200)
- **VariantProjection** - The variant projection object.

#### Response Example
```json
{
  "id": "string",
  "key": "string",
  "sku": "string"
}
```
```

--------------------------------

### Create a Product

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/products.md

Creates a new product in the commercetools project. Requires a product type, name, slug, and master variant.

```APIDOC
## POST /my-project/products

### Description
Creates a new product in the commercetools project.

### Method
POST

### Endpoint
`https://api.europe-west1.gcp.commercetools.com/my-project/products`

### Parameters
#### Request Body
- **productType** (object) - Required - The product type reference.
  - **typeId** (string) - Required - The type ID, e.g., "product-type".
  - **id** (string) - Required - The product type ID.
- **name** (object) - Required - Localized name of the product.
- **slug** (object) - Required - Localized slug of the product.
- **masterVariant** (object) - Required - The master variant of the product.
  - **sku** (string) - Required - The SKU of the variant.
  - **prices** (array) - Required - List of prices.
    - **value** (object) - Required - The price value.
      - **currencyCode** (string) - Required - The currency code (e.g., "EUR").
      - **centAmount** (integer) - Required - The amount in cents.

### Request Example
```bash
curl -sS -X POST 'https://api.europe-west1.gcp.commercetools.com/my-project/products' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productType": { "typeId": "product-type", "id": "24f510c3-f334-4099-94e2-d6224a8eb919" },
    "name": { "en": "Some Product" },
    "slug": { "en": "some-product" },
    "masterVariant": {
      "sku": "SKU-1",
      "prices": [ { "value": { "currencyCode": "EUR", "centAmount": 4200 } } ]
    }
  }'
```

### Response
#### Success Response (201)
Returns the created `Product` object with `id`, `version`, `masterData` (containing `current` and `staged` `ProductCatalogData`), and `createdAt`/`lastModifiedAt`.

#### Response Example
(Not provided in source)
```

--------------------------------

### POST /{projectKey}/business-units

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/business-units.md

Creates a new Business Unit. The example shows creating a Company Business Unit.

```APIDOC
## POST /{projectKey}/business-units

### Description
Creates a new Business Unit. The example shows creating a Company Business Unit.

### Method
POST

### Endpoint
`/{projectKey}/business-units`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.

#### Request Body
- **unitType** (string) - Required - The type of business unit (e.g., "Company").
- **name** (string) - Required - The name of the business unit.
- **key** (string) - Required - The unique key of the business unit.
- **addresses** (array) - Required - List of addresses.
- **associates** (array) - Required - List of associates with their role assignments.

### Request Example
```json
{
  "unitType": "Company",
  "name": "ACME Corp",
  "key": "acme-corp",
  "addresses": [ { "id": "addr-1", "country": "DE" } ],
  "associates": [ { "customer": { "typeId": "customer", "id": "<customer-id>" }, "associateRoleAssignments": [ { "associateRole": { "typeId": "associate-role", "key": "admin" } } ] } ]
}
```

### Response
#### Success Response (201)
- **BusinessUnit** (object) - The created business unit.

#### Response Example
```json
{
  "unitType": "Company",
  "name": "ACME Corp",
  "key": "acme-corp"
}
```
```

--------------------------------

### GET /{projectKey}/variant-projections/key={key}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/product-projections.md

Get a VariantProjection by key. Also provides access to the `/variant-attributes` sub-resource.

```APIDOC
## GET /{projectKey}/variant-projections/key={key}

### Description
Get a VariantProjection by key. Also provides access to the `/variant-attributes` sub-resource.

### Method
GET

### Endpoint
`/{projectKey}/variant-projections/key={key}`

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the variant projection.

### Response
#### Success Response (200)
- **VariantProjection** - The variant projection object.

#### Response Example
```json
{
  "id": "string",
  "key": "string",
  "sku": "string"
}
```
```

--------------------------------

### GET /{projectKey}/product-projections/{ID}

Source: https://github.com/commercetools/commercetools-api-reference/blob/main/_autodocs/api-reference/product-projections.md

Get a ProductProjection by its ID. Supports the same query traits as the query endpoint.

```APIDOC
## GET /{projectKey}/product-projections/{ID}

### Description
Get a ProductProjection by its ID. Supports the same query traits as the query endpoint.

### Method
GET

### Endpoint
/{projectKey}/product-projections/{ID}

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The project key.
- **ID** (string) - Required - The ID of the product projection.

#### Query Parameters
- **staged** (boolean) - Optional - Whether to query the staged or current view.
- **price** (string) - Optional - Price selection criteria.
- **store** (string) - Optional - Store projection key.
- **locale** (string) - Optional - Locale projection.
- **filter[attributes]** (string) - Optional - Attribute filtering.
- **expand** (string) - Optional - Expansion of referenced resources.

### Response
#### Success Response (200)
- **ProductProjection** - The product projection matching the ID.

#### Response Example
{
  "id": "string",
  "key": "string",
  "productType": {},
  "name": {},
  "masterVariant": {},
  "variants": []
}
```
Tokens:
Raw