Menu
Commercetools actions
Pick an action to see its parameters, request body and response fields.
257 actions
Api · 2
As · 1
Associate · 3
Attribute · 2
Bulk · 1
Business · 2
Cart · 3
Carts · 1
Categories · 1
Category · 1
Channel · 1
Channels · 1
Create · 48
MUTATIONcreateApiClientCreate a new API client.MUTATIONcreateApprovalRuleCreate a B2B approval rule for a business unit (which orders need approval and by whom).MUTATIONcreateAssociateRoleCreate a new associate role.MUTATIONcreateAttributeGroupCreate a new attribute group.MUTATIONcreateBusinessUnitCreate a new business unit.MUTATIONcreateCartCreate a new cart.MUTATIONcreateCartDiscountCreate a new cart discount.MUTATIONcreateCategoryCreate a new category.MUTATIONcreateChannelCreate a new channel.MUTATIONcreateCustomerGroupCreate a new customer group.MUTATIONcreateDiscountCodeCreate a new discount code.MUTATIONcreateDiscountGroupCreate a new discount group.MUTATIONcreateExtensionCreate an API Extension — a synchronous hook commercetools calls during cart/order/payment/customer updates.MUTATIONcreateInventoryEntryCreate a new inventory entry.MUTATIONcreateMyBusinessUnitCreate a new business unit for the signed-in customer.MUTATIONcreateMyCartCreate a new cart for the signed-in customer.MUTATIONcreateMyOrderFromCartPlace an order from the signed-in customer's own cart.MUTATIONcreateMyOrderFromQuotePlace an order from a quote for the signed-in customer.MUTATIONcreateMyPaymentCreate a new payment for the signed-in customer.MUTATIONcreateMyQuoteRequestCreate a new quote request for the signed-in customer.MUTATIONcreateMyShoppingListCreate a new shopping list for the signed-in customer.MUTATIONcreateOrderEditCreate a new order edit.MUTATIONcreateOrderFromCartPlace an order from a cart (by cart id + version).MUTATIONcreateOrderFromQuotePlace an order from an accepted quote.MUTATIONcreateOrUpdateCustomObjectCreate a custom object, or overwrite the existing one for the same container + key.MUTATIONcreatePaymentCreate a new payment.MUTATIONcreatePaymentMethodCreate a new payment method.MUTATIONcreateProductCreate a new product.MUTATIONcreateProductDiscountCreate a new product discount.MUTATIONcreateProductSelectionCreate a new product selection.MUTATIONcreateProductTailoringCreate a new product tailoring.MUTATIONcreateProductTypeCreate a new product type.MUTATIONcreateQuoteCreate a new quote.MUTATIONcreateQuoteRequestCreate a new quote request.MUTATIONcreateRecurrencePolicyCreate a new recurrence policy.MUTATIONcreateRecurringOrderCreate a new recurring order.MUTATIONcreateReviewCreate a new review.MUTATIONcreateShippingMethodCreate a new shipping method.MUTATIONcreateShoppingListCreate a new shopping list.MUTATIONcreateStagedQuoteCreate a new staged quote.MUTATIONcreateStandalonePriceCreate a new standalone price.MUTATIONcreateStateCreate a new state.MUTATIONcreateStoreCreate a new store.MUTATIONcreateSubscriptionCreate a message Subscription that delivers change events to an external queue (SQS, Pub/Sub, EventBridge, Azure Service Bus).MUTATIONcreateTaxCategoryCreate a new tax category.MUTATIONcreateTypeDefinitionCreate a new type definition.MUTATIONcreateVariantCreate a new variant.MUTATIONcreateZoneCreate a new zone.
Custom · 2
Customer · 16
QUERYcustomerFetch a single customer by ID or key.QUERYcustomerActiveCartThe active cart belonging to a given customer, if one exists.MUTATIONcustomerChangeMyPasswordChange the signed-in customer's password.MUTATIONcustomerChangePasswordChange a customer's password (old password + new password).MUTATIONcustomerConfirmEmailConfirm a customer's email address using a verification token.MUTATIONcustomerConfirmMyEmailConfirm the signed-in customer's email address using a verification token.MUTATIONcustomerCreateEmailVerificationTokenCreate an email-verification token for a customer.MUTATIONcustomerCreatePasswordResetTokenCreate a password-reset token for a customer (to email them a reset link).QUERYcustomerGroupFetch a single customer group by ID or key.QUERYcustomerGroupsQuery customer groups — supports a `where` predicate, `sort`, and `limit`/`offset` paging.MUTATIONcustomerResetMyPasswordSet a new password for the signed-in customer using a reset token.MUTATIONcustomerResetPasswordSet a new password for a customer using a reset token.MUTATIONcustomerSignInAuthenticate a customer by email + password; returns the customer and their active cart.MUTATIONcustomerSignMeInAuthenticate the current session's customer by email + password.MUTATIONcustomerSignMeUpRegister the current (anonymous) session as a new customer account.MUTATIONcustomerSignUpRegister a new customer account; returns the customer and, if an anonymous cart was supplied, the merged cart.
Customers · 1
Delete · 44
MUTATIONdeleteApiClientDelete an API client (requires its current version).MUTATIONdeleteAssociateRoleDelete an associate role (requires its current version).MUTATIONdeleteAttributeGroupDelete an attribute group (requires its current version).MUTATIONdeleteBusinessUnitDelete a business unit (requires its current version).MUTATIONdeleteCartDelete a cart (requires its current version).MUTATIONdeleteCartDiscountDelete a cart discount (requires its current version).MUTATIONdeleteCategoryDelete a category (requires its current version).MUTATIONdeleteChannelDelete a channel (requires its current version).MUTATIONdeleteCustomerDelete a customer (requires its current version).MUTATIONdeleteCustomerGroupDelete a customer group (requires its current version).MUTATIONdeleteCustomObjectDelete a custom object (requires its current version).MUTATIONdeleteDiscountCodeDelete a discount code (requires its current version).MUTATIONdeleteDiscountGroupDelete a discount group (requires its current version).MUTATIONdeleteExtensionDelete an extension (requires its current version).MUTATIONdeleteInventoryEntryDelete an inventory entry (requires its current version).MUTATIONdeleteMyCartDelete a cart for the signed-in customer (requires its current version).MUTATIONdeleteMyCustomerDelete a customer for the signed-in customer (requires its current version).MUTATIONdeleteMyPaymentDelete a payment for the signed-in customer (requires its current version).MUTATIONdeleteMyShoppingListDelete a shopping list for the signed-in customer (requires its current version).MUTATIONdeleteOrderDelete an order (requires its current version).MUTATIONdeleteOrderEditDelete an order edit (requires its current version).MUTATIONdeletePaymentDelete a payment (requires its current version).MUTATIONdeletePaymentMethodDelete a payment method (requires its current version).MUTATIONdeleteProductDelete a product (requires its current version).MUTATIONdeleteProductDiscountDelete a product discount (requires its current version).MUTATIONdeleteProductSelectionDelete a product selection (requires its current version).MUTATIONdeleteProductTailoringDelete a product tailoring (requires its current version).MUTATIONdeleteProductTypeDelete a product type (requires its current version).MUTATIONdeleteQuoteDelete a quote (requires its current version).MUTATIONdeleteQuoteRequestDelete a quote request (requires its current version).MUTATIONdeleteRecurrencePolicyDelete a recurrence policy (requires its current version).MUTATIONdeleteRecurringOrderDelete a recurring order (requires its current version).MUTATIONdeleteReviewDelete a review (requires its current version).MUTATIONdeleteShippingMethodDelete a shipping method (requires its current version).MUTATIONdeleteShoppingListDelete a shopping list (requires its current version).MUTATIONdeleteStagedQuoteDelete a staged quote (requires its current version).MUTATIONdeleteStandalonePriceDelete a standalone price (requires its current version).MUTATIONdeleteStateDelete a state (requires its current version).MUTATIONdeleteStoreDelete a store (requires its current version).MUTATIONdeleteSubscriptionDelete a subscription (requires its current version).MUTATIONdeleteTaxCategoryDelete a tax category (requires its current version).MUTATIONdeleteTypeDefinitionDelete a type definition (requires its current version).MUTATIONdeleteVariantDelete a variant (requires its current version).MUTATIONdeleteZoneDelete a zone (requires its current version).
Discount · 4
QUERYdiscountCodeFetch a single discount code by ID or key.QUERYdiscountCodesQuery discount codes — supports a `where` predicate, `sort`, and `limit`/`offset` paging.QUERYdiscountGroupA single discount group (a set of cart discounts that share a sort order) by ID or key.QUERYdiscountGroupsQuery discount groups — supports a `where` predicate, `sort`, and `limit`/`offset` paging.
Extension · 1
Extensions · 1
Import · 1
In · 2
Inventory · 2
Limits · 1
Me · 1
Merge · 1
Message · 1
Messages · 1
Order · 3
Orders · 1
Payment · 3
Payments · 1
Product · 13
QUERYproductFetch a single product by ID or key.QUERYproductDiscountFetch a single product discount by ID or key.QUERYproductDiscountsQuery product discounts — supports a `where` predicate, `sort`, and `limit`/`offset` paging.QUERYproductProjectionSearchFull-text + faceted search over product projections — text query, filters, facets, price selection, sorting and limit/offset paging.QUERYproductProjectionsSuggestSearch-as-you-type suggestions for product projections from a partial search term.QUERYproductProjectionVariantAttributesThe attribute definitions available on product projection variants, for building search filters/facets.QUERYproductSelectionA single Product Selection by ID or key — a curated list of products assignable to stores.QUERYproductSelectionAssignmentsThe product-to-product-selection assignments, optionally filtered by product or selection.QUERYproductSelectionsQuery Product Selections (curated product lists for stores) with a `where` predicate and paging.QUERYproductTailoringA product's store-specific tailoring (name, description, slug, attributes overridden per store).QUERYproductTailoringListQuery product tailorings across products and stores.QUERYproductTypeFetch a single product type definition by ID or key.QUERYproductTypesQuery product type definitions — supports a `where` predicate, `sort`, and `limit`/`offset` paging.
Products · 2
Project · 1
Quote · 3
Quotes · 1
Recurrence · 2
Recurring · 2
Replicate · 2
Review · 1
Reviews · 1
Shipping · 4
QUERYshippingMethodFetch a single shipping method by ID or key.QUERYshippingMethodsQuery shipping methods — supports a `where` predicate, `sort`, and `limit`/`offset` paging.QUERYshippingMethodsByCartThe shipping methods available for a given cart, with their rates already matched to the cart total and destination.QUERYshippingMethodsByLocationThe shipping methods available for a country (and optionally state/currency), with matching rates.
Shopping · 2
Sign · 1
Staged · 2
Standalone · 2
State · 1
States · 1
Store · 1
Stores · 1
Subscription · 1
Subscriptions · 1
Tax · 2
Type · 2
Update · 48
MUTATIONupdateApprovalFlowAdvance or update an approval flow — approve, reject, or change approvers on a pending order.MUTATIONupdateApprovalRuleUpdate a B2B approval rule using an array of update actions.MUTATIONupdateAssociateRoleUpdate an existing associate role — pass its current version and an array of update actions.MUTATIONupdateAttributeGroupUpdate an existing attribute group — pass its current version and an array of update actions.MUTATIONupdateBusinessUnitUpdate an existing business unit — pass its current version and an array of update actions.MUTATIONupdateCartUpdate an existing cart — pass its current version and an array of update actions.MUTATIONupdateCartDiscountUpdate an existing cart discount — pass its current version and an array of update actions.MUTATIONupdateCategoryUpdate an existing category — pass its current version and an array of update actions.MUTATIONupdateChannelUpdate an existing channel — pass its current version and an array of update actions.MUTATIONupdateCustomerUpdate an existing customer — pass its current version and an array of update actions.MUTATIONupdateCustomerGroupUpdate an existing customer group — pass its current version and an array of update actions.MUTATIONupdateDiscountCodeUpdate an existing discount code — pass its current version and an array of update actions.MUTATIONupdateDiscountGroupUpdate an existing discount group — pass its current version and an array of update actions.MUTATIONupdateExtensionUpdate an existing extension — pass its current version and an array of update actions.MUTATIONupdateInventoryEntryUpdate an existing inventory entry — pass its current version and an array of update actions.MUTATIONupdateMyBusinessUnitUpdate an existing business unit for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateMyCartUpdate an existing cart for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateMyCustomerUpdate an existing customer for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateMyPaymentUpdate an existing payment for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateMyQuoteUpdate an existing quote for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateMyQuoteRequestUpdate an existing quote request for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateMyShoppingListUpdate an existing shopping list for the signed-in customer — pass its current version and an array of update actions.MUTATIONupdateOrderUpdate an existing order — pass its current version and an array of update actions.MUTATIONupdateOrderEditUpdate an existing order edit — pass its current version and an array of update actions.MUTATIONupdatePaymentUpdate an existing payment — pass its current version and an array of update actions.MUTATIONupdatePaymentMethodUpdate an existing payment method — pass its current version and an array of update actions.MUTATIONupdateProductUpdate an existing product — pass its current version and an array of update actions.MUTATIONupdateProductDiscountUpdate an existing product discount — pass its current version and an array of update actions.MUTATIONupdateProductSelectionUpdate an existing product selection — pass its current version and an array of update actions.MUTATIONupdateProductTailoringUpdate an existing product tailoring — pass its current version and an array of update actions.MUTATIONupdateProductTypeUpdate an existing product type — pass its current version and an array of update actions.MUTATIONupdateProjectUpdate the current project's settings using an array of update actions.MUTATIONupdateQuoteUpdate an existing quote — pass its current version and an array of update actions.MUTATIONupdateQuoteRequestUpdate an existing quote request — pass its current version and an array of update actions.MUTATIONupdateRecurrencePolicyUpdate an existing recurrence policy — pass its current version and an array of update actions.MUTATIONupdateRecurringOrderUpdate an existing recurring order — pass its current version and an array of update actions.MUTATIONupdateReviewUpdate an existing review — pass its current version and an array of update actions.MUTATIONupdateShippingMethodUpdate an existing shipping method — pass its current version and an array of update actions.MUTATIONupdateShoppingListUpdate an existing shopping list — pass its current version and an array of update actions.MUTATIONupdateStagedQuoteUpdate an existing staged quote — pass its current version and an array of update actions.MUTATIONupdateStandalonePriceUpdate an existing standalone price — pass its current version and an array of update actions.MUTATIONupdateStateUpdate an existing state — pass its current version and an array of update actions.MUTATIONupdateStoreUpdate an existing store — pass its current version and an array of update actions.MUTATIONupdateSubscriptionUpdate an existing subscription — pass its current version and an array of update actions.MUTATIONupdateTaxCategoryUpdate an existing tax category — pass its current version and an array of update actions.MUTATIONupdateTypeDefinitionUpdate an existing type definition — pass its current version and an array of update actions.MUTATIONupdateVariantUpdate an existing variant — pass its current version and an array of update actions.MUTATIONupdateZoneUpdate an existing zone — pass its current version and an array of update actions.