/commercetools | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
commercetools_create_cart | Create a new shopping cart |
commercetools_create_category | Create a new product category |
commercetools_create_customer | Create a new customer in Commerce Tools |
commercetools_create_order | Create an order from a cart |
commercetools_create_product | Create a new product in Commerce Tools |
commercetools_get_cart | Retrieve a cart by ID |
commercetools_get_customer | Retrieve a customer by ID |
commercetools_get_inventory | Get inventory information for a SKU |
commercetools_get_order | Retrieve an order by ID |
commercetools_get_product | Retrieve a product by ID or key |
commercetools_list_categories | List product categories |
commercetools_list_customers | List customers with optional filtering |
commercetools_list_orders | List orders with optional filtering |
commercetools_list_products | List products with optional filtering and pagination |
commercetools_update_cart | Update a cart using actions |
commercetools_update_inventory | Update inventory for a SKU |
commercetools_update_product | Update a product using actions |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"currency": {
"type": "string",
"description": "Currency code (e.g., USD, EUR)"
},
"customerId": {
"type": "string",
"description": "Customer ID for the cart"
},
"country": {
"type": "string",
"description": "Country code for tax calculation"
},
"storeKey": {
"type": "string",
"description": "Store key for store-scoped operations (e.g., \"b2c-retail-store\")"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product ID"
},
"variantId": {
"type": "number",
"description": "Product variant ID"
},
"sku": {
"type": "string",
"description": "Product SKU"
},
"quantity": {
"type": "number",
"default": 1,
"description": "Quantity of the item"
}
}
},
"description": "Initial line items for the cart"
}
},
"required": [
"PCID",
"currency"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"name": {
"type": "object",
"additionalProperties": true,
"description": "Category name in different locales"
},
"slug": {
"type": "object",
"additionalProperties": true,
"description": "Category slug in different locales"
},
"description": {
"type": "object",
"additionalProperties": true,
"description": "Category description in different locales"
},
"parent": {
"type": "string",
"description": "Parent category ID or key"
},
"orderHint": {
"type": "string",
"description": "Order hint for category sorting"
}
},
"required": [
"PCID",
"name",
"slug"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"email": {
"type": "string",
"description": "Customer email address"
},
"password": {
"type": "string",
"description": "Customer password (if not provided, customer will be created without password)"
},
"firstName": {
"type": "string",
"description": "Customer first name"
},
"lastName": {
"type": "string",
"description": "Customer last name"
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth (YYYY-MM-DD format)"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code (e.g., US, DE)"
},
"streetName": {
"type": "string",
"description": "Street name"
},
"streetNumber": {
"type": "string",
"description": "Street number"
},
"city": {
"type": "string",
"description": "City"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"region": {
"type": "string",
"description": "State/Region"
},
"phone": {
"type": "string",
"description": "Phone number"
}
}
},
"description": "Customer addresses"
},
"customerGroup": {
"type": "string",
"description": "Customer group ID or key"
}
},
"required": [
"PCID",
"email"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"cartId": {
"type": "string",
"description": "Cart ID to create order from"
},
"version": {
"type": "number",
"description": "Current version of the cart"
},
"orderNumber": {
"type": "string",
"description": "Custom order number"
},
"storeKey": {
"type": "string",
"description": "Store key for store-scoped operations (e.g., \"b2c-retail-store\"). Required when using store-scoped API credentials."
}
},
"required": [
"PCID",
"cartId",
"version"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"name": {
"type": "object",
"additionalProperties": true,
"description": "Product name in different locales (e.g., {\"en\": \"Product Name\"})"
},
"productType": {
"type": "string",
"description": "Product type ID or key"
},
"slug": {
"type": "object",
"additionalProperties": true,
"description": "Product slug in different locales (e.g., {\"en\": \"product-slug\"})"
},
"description": {
"type": "object",
"additionalProperties": true,
"description": "Product description in different locales"
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of category IDs or keys"
},
"masterVariant": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Stock keeping unit"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"description": "Currency code (e.g., USD, EUR)"
},
"centAmount": {
"type": "number",
"description": "Price in cents"
}
}
},
"country": {
"type": "string",
"description": "Country code"
}
}
},
"description": "Product prices"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Attribute name"
},
"value": {
"type": "any",
"description": "Attribute value"
}
}
},
"description": "Product attributes"
}
},
"description": "Master variant details"
},
"publish": {
"type": "boolean",
"default": false,
"description": "Whether to publish the product immediately"
}
},
"required": [
"PCID",
"name",
"productType",
"slug",
"masterVariant"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"cartId": {
"type": "string",
"description": "Cart ID"
},
"storeKey": {
"type": "string",
"description": "Store key for store-scoped operations"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Fields to expand"
}
},
"required": [
"PCID",
"cartId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"customerId": {
"type": "string",
"description": "Customer ID"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Fields to expand"
}
},
"required": [
"PCID",
"customerId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"sku": {
"type": "string",
"description": "Product SKU"
},
"supplyChannel": {
"type": "string",
"description": "Supply channel ID"
}
},
"required": [
"PCID",
"sku"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Fields to expand"
}
},
"required": [
"PCID",
"orderId"
]
}
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”]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID or key"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Fields to expand (e.g., [\"productType\", \"categories\"])"
}
},
"required": [
"PCID",
"productId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"where": {
"type": "string",
"description": "Filter query"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort criteria"
},
"limit": {
"type": "number",
"default": 20,
"description": "Maximum number of results"
},
"offset": {
"type": "number",
"default": 0,
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"where": {
"type": "string",
"description": "Filter query (e.g., \"email=\\\"john@example.com\\\"\")"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort criteria"
},
"limit": {
"type": "number",
"default": 20,
"description": "Maximum number of results"
},
"offset": {
"type": "number",
"default": 0,
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"where": {
"type": "string",
"description": "Filter query (e.g., \"customerId=\\\"customer-id\\\"\")"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort criteria (e.g., [\"createdAt desc\"])"
},
"limit": {
"type": "number",
"default": 20,
"description": "Maximum number of results"
},
"offset": {
"type": "number",
"default": 0,
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"where": {
"type": "string",
"description": "Filter query (e.g., \"masterData(published=true)\")"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort criteria (e.g., [\"createdAt desc\"])"
},
"limit": {
"type": "number",
"default": 20,
"description": "Maximum number of results"
},
"offset": {
"type": "number",
"default": 0,
"description": "Number of results to skip"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Fields to expand"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"cartId": {
"type": "string",
"description": "Cart ID"
},
"version": {
"type": "number",
"description": "Current version of the cart"
},
"storeKey": {
"type": "string",
"description": "Store key for store-scoped operations (e.g., \"b2c-retail-store\")"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Action type (e.g., \"addLineItem\", \"removeLineItem\", \"changeLineItemQuantity\")"
},
"productId": {
"type": "string",
"description": "Product ID for line item actions"
},
"variantId": {
"type": "number",
"description": "Variant ID for line item actions"
},
"sku": {
"type": "string",
"description": "SKU for line item actions"
},
"quantity": {
"type": "number",
"description": "Quantity for quantity-related actions"
},
"lineItemId": {
"type": "string",
"description": "Line item ID for item-specific actions"
}
}
},
"description": "Array of update actions"
}
},
"required": [
"PCID",
"cartId",
"version",
"actions"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"inventoryId": {
"type": "string",
"description": "Inventory entry ID"
},
"version": {
"type": "number",
"description": "Current version of the inventory entry"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Action type (e.g., \"changeQuantity\", \"setQuantity\")"
},
"quantity": {
"type": "number",
"description": "New quantity value"
}
}
},
"description": "Array of update actions"
}
},
"required": [
"PCID",
"inventoryId",
"version",
"actions"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID"
},
"version": {
"type": "number",
"description": "Current version of the product"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Action type (e.g., \"changeName\", \"setDescription\")"
},
"name": {
"type": "object",
"additionalProperties": true,
"description": "New name in locales"
},
"description": {
"type": "object",
"additionalProperties": true,
"description": "New description in locales"
},
"slug": {
"type": "object",
"additionalProperties": true,
"description": "New slug in locales"
},
"variantId": {
"type": "number",
"description": "Variant ID for variant-specific actions"
},
"sku": {
"type": "string",
"description": "SKU for SKU-specific actions"
}
}
},
"description": "Array of update actions"
}
},
"required": [
"PCID",
"productId",
"version",
"actions"
]
}

