/commercetools | Type: Application | PCID required: Yes
Products, customers, orders, carts, and inventory
Tools
| Tool | Description |
|---|---|
commercetools_create_product | Create a new product in Commerce Tools |
commercetools_get_product | Retrieve a product by ID or key |
commercetools_list_products | List products with optional filtering and pagination |
commercetools_update_product | Update a product using actions |
commercetools_create_customer | Create a new customer in Commerce Tools |
commercetools_get_customer | Retrieve a customer by ID |
commercetools_list_customers | List customers with optional filtering |
commercetools_create_order | Create an order from a cart |
commercetools_get_order | Retrieve an order by ID |
commercetools_list_orders | List orders with optional filtering |
commercetools_create_cart | Create a new shopping cart |
commercetools_get_cart | Retrieve a cart by ID |
commercetools_update_cart | Update a cart using actions |
commercetools_list_categories | List product categories |
commercetools_create_category | Create a new product category |
commercetools_get_inventory | Get inventory information for a SKU |
commercetools_update_inventory | Update inventory for a SKU |
commercetools_create_product
Create a new product in Commerce Tools Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | object | Yes | — | Product name in different locales (e.g., {“en”: “Product Name”}) |
productType | string | Yes | — | Product type ID or key |
slug | object | Yes | — | Product slug in different locales (e.g., {“en”: “product-slug”}) |
description | object | No | — | Product description in different locales |
categories | string[] | No | — | Array of category IDs or keys |
masterVariant | object | Yes | — | Master variant details |
publish | boolean | No | false | Whether to publish the product immediately |
commercetools_get_product
Retrieve a product by ID or key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID or key |
expand | string[] | No | — | Fields to expand (e.g., [“productType”, “categories”]) |
commercetools_list_products
List products with optional filtering and pagination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
where | string | No | — | Filter query (e.g., “masterData(published=true)“) |
sort | string[] | No | — | Sort criteria (e.g., [“createdAt desc”]) |
limit | number | No | 20 | Maximum number of results |
offset | number | No | 0 | Number of results to skip |
expand | string[] | No | — | Fields to expand |
commercetools_update_product
Update a product using actions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID |
version | number | Yes | — | Current version of the product |
actions | object[] | Yes | — | Array of update actions |
commercetools_create_customer
Create a new customer in Commerce Tools Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Customer email address |
password | string | No | — | Customer password (if not provided, customer will be created without password) |
firstName | string | No | — | Customer first name |
lastName | string | No | — | Customer last name |
dateOfBirth | string | No | — | Date of birth (YYYY-MM-DD format) |
addresses | object[] | No | — | Customer addresses |
customerGroup | string | No | — | Customer group ID or key |
commercetools_get_customer
Retrieve a customer by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerId | string | Yes | — | Customer ID |
expand | string[] | No | — | Fields to expand |
commercetools_list_customers
List customers with optional filtering Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
where | string | No | — | Filter query (e.g., “email=“john@example.com"") |
sort | string[] | No | — | Sort criteria |
limit | number | No | 20 | Maximum number of results |
offset | number | No | 0 | Number of results to skip |
commercetools_create_order
Create an order from a cart Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cartId | string | Yes | — | Cart ID to create order from |
version | number | Yes | — | Current version of the cart |
orderNumber | string | No | — | Custom order number |
storeKey | string | No | — | Store key for store-scoped operations (e.g., “b2c-retail-store”). Required when using store-scoped API credentials. |
commercetools_get_order
Retrieve an order by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID |
expand | string[] | No | — | Fields to expand |
commercetools_list_orders
List orders with optional filtering Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
where | string | No | — | Filter query (e.g., “customerId=“customer-id"") |
sort | string[] | No | — | Sort criteria (e.g., [“createdAt desc”]) |
limit | number | No | 20 | Maximum number of results |
offset | number | No | 0 | Number of results to skip |
commercetools_create_cart
Create a new shopping cart Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
currency | string | Yes | — | Currency code (e.g., USD, EUR) |
customerId | string | No | — | Customer ID for the cart |
country | string | No | — | Country code for tax calculation |
storeKey | string | No | — | Store key for store-scoped operations (e.g., “b2c-retail-store”) |
lineItems | object[] | No | — | Initial line items for the cart |
commercetools_get_cart
Retrieve a cart by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cartId | string | Yes | — | Cart ID |
storeKey | string | No | — | Store key for store-scoped operations |
expand | string[] | No | — | Fields to expand |
commercetools_update_cart
Update a cart using actions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cartId | string | Yes | — | Cart ID |
version | number | Yes | — | Current version of the cart |
storeKey | string | No | — | Store key for store-scoped operations (e.g., “b2c-retail-store”) |
actions | object[] | Yes | — | Array of update actions |
commercetools_list_categories
List product categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
where | string | No | — | Filter query |
sort | string[] | No | — | Sort criteria |
limit | number | No | 20 | Maximum number of results |
offset | number | No | 0 | Number of results to skip |
commercetools_create_category
Create a new product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | object | Yes | — | Category name in different locales |
slug | object | Yes | — | Category slug in different locales |
description | object | No | — | Category description in different locales |
parent | string | No | — | Parent category ID or key |
orderHint | string | No | — | Order hint for category sorting |
commercetools_get_inventory
Get inventory information for a SKU Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sku | string | Yes | — | Product SKU |
supplyChannel | string | No | — | Supply channel ID |
commercetools_update_inventory
Update inventory for a SKU Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventoryId | string | Yes | — | Inventory entry ID |
version | number | Yes | — | Current version of the inventory entry |
actions | object[] | Yes | — | Array of update actions |

