Skip to main content
Server path: /commercetools | Type: Application | PCID required: Yes Products, customers, orders, carts, and inventory

Tools

ToolDescription
commercetools_create_productCreate a new product in Commerce Tools
commercetools_get_productRetrieve a product by ID or key
commercetools_list_productsList products with optional filtering and pagination
commercetools_update_productUpdate a product using actions
commercetools_create_customerCreate a new customer in Commerce Tools
commercetools_get_customerRetrieve a customer by ID
commercetools_list_customersList customers with optional filtering
commercetools_create_orderCreate an order from a cart
commercetools_get_orderRetrieve an order by ID
commercetools_list_ordersList orders with optional filtering
commercetools_create_cartCreate a new shopping cart
commercetools_get_cartRetrieve a cart by ID
commercetools_update_cartUpdate a cart using actions
commercetools_list_categoriesList product categories
commercetools_create_categoryCreate a new product category
commercetools_get_inventoryGet inventory information for a SKU
commercetools_update_inventoryUpdate inventory for a SKU

commercetools_create_product

Create a new product in Commerce Tools Parameters:
ParameterTypeRequiredDefaultDescription
nameobjectYesProduct name in different locales (e.g., {“en”: “Product Name”})
productTypestringYesProduct type ID or key
slugobjectYesProduct slug in different locales (e.g., {“en”: “product-slug”})
descriptionobjectNoProduct description in different locales
categoriesstring[]NoArray of category IDs or keys
masterVariantobjectYesMaster variant details
publishbooleanNofalseWhether to publish the product immediately

commercetools_get_product

Retrieve a product by ID or key Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID or key
expandstring[]NoFields to expand (e.g., [“productType”, “categories”])

commercetools_list_products

List products with optional filtering and pagination Parameters:
ParameterTypeRequiredDefaultDescription
wherestringNoFilter query (e.g., “masterData(published=true)“)
sortstring[]NoSort criteria (e.g., [“createdAt desc”])
limitnumberNo20Maximum number of results
offsetnumberNo0Number of results to skip
expandstring[]NoFields to expand

commercetools_update_product

Update a product using actions Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID
versionnumberYesCurrent version of the product
actionsobject[]YesArray of update actions

commercetools_create_customer

Create a new customer in Commerce Tools Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesCustomer email address
passwordstringNoCustomer password (if not provided, customer will be created without password)
firstNamestringNoCustomer first name
lastNamestringNoCustomer last name
dateOfBirthstringNoDate of birth (YYYY-MM-DD format)
addressesobject[]NoCustomer addresses
customerGroupstringNoCustomer group ID or key

commercetools_get_customer

Retrieve a customer by ID Parameters:
ParameterTypeRequiredDefaultDescription
customerIdstringYesCustomer ID
expandstring[]NoFields to expand

commercetools_list_customers

List customers with optional filtering Parameters:
ParameterTypeRequiredDefaultDescription
wherestringNoFilter query (e.g., “email=“john@example.com"")
sortstring[]NoSort criteria
limitnumberNo20Maximum number of results
offsetnumberNo0Number of results to skip

commercetools_create_order

Create an order from a cart Parameters:
ParameterTypeRequiredDefaultDescription
cartIdstringYesCart ID to create order from
versionnumberYesCurrent version of the cart
orderNumberstringNoCustom order number
storeKeystringNoStore 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:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID
expandstring[]NoFields to expand

commercetools_list_orders

List orders with optional filtering Parameters:
ParameterTypeRequiredDefaultDescription
wherestringNoFilter query (e.g., “customerId=“customer-id"")
sortstring[]NoSort criteria (e.g., [“createdAt desc”])
limitnumberNo20Maximum number of results
offsetnumberNo0Number of results to skip

commercetools_create_cart

Create a new shopping cart Parameters:
ParameterTypeRequiredDefaultDescription
currencystringYesCurrency code (e.g., USD, EUR)
customerIdstringNoCustomer ID for the cart
countrystringNoCountry code for tax calculation
storeKeystringNoStore key for store-scoped operations (e.g., “b2c-retail-store”)
lineItemsobject[]NoInitial line items for the cart

commercetools_get_cart

Retrieve a cart by ID Parameters:
ParameterTypeRequiredDefaultDescription
cartIdstringYesCart ID
storeKeystringNoStore key for store-scoped operations
expandstring[]NoFields to expand

commercetools_update_cart

Update a cart using actions Parameters:
ParameterTypeRequiredDefaultDescription
cartIdstringYesCart ID
versionnumberYesCurrent version of the cart
storeKeystringNoStore key for store-scoped operations (e.g., “b2c-retail-store”)
actionsobject[]YesArray of update actions

commercetools_list_categories

List product categories Parameters:
ParameterTypeRequiredDefaultDescription
wherestringNoFilter query
sortstring[]NoSort criteria
limitnumberNo20Maximum number of results
offsetnumberNo0Number of results to skip

commercetools_create_category

Create a new product category Parameters:
ParameterTypeRequiredDefaultDescription
nameobjectYesCategory name in different locales
slugobjectYesCategory slug in different locales
descriptionobjectNoCategory description in different locales
parentstringNoParent category ID or key
orderHintstringNoOrder hint for category sorting

commercetools_get_inventory

Get inventory information for a SKU Parameters:
ParameterTypeRequiredDefaultDescription
skustringYesProduct SKU
supplyChannelstringNoSupply channel ID

commercetools_update_inventory

Update inventory for a SKU Parameters:
ParameterTypeRequiredDefaultDescription
inventoryIdstringYesInventory entry ID
versionnumberYesCurrent version of the inventory entry
actionsobject[]YesArray of update actions