Actions671
- Product Actions
- Query Product Selections for Product by Product Key
- Get Product by Key
- Check if Product exists by Key
- Update Product by Key
- Delete Product by Key
- Upload Product image
- Query Product Selections for Product by Product ID
- Get Product by ID
- Check if Product exists by ID
- Update Product by ID
- Delete Product by ID
- Search Products
- Query Products
- Check if Product exists by Query Predicate
- Create Product
- Customer Actions
- Get Customer by password token
- Get Customer by email token
- Create email token for Customer
- Verify email of Customer
- Change password of Customer
- Reset password of Customer
- Create password reset token for Customer
- Get Customer by Key
- Check if Customer exists by Key
- Update Customer by Key
- Delete Customer by Key
- Get Customer by ID
- Check if Customer exists by ID
- Update Customer by ID
- Delete Customer by ID
- Search Customers
- Check if Customer Search index exists
- Get indexing status of Customer Search
- Query Customers
- Check if Customer exists by Query Predicate
- Create (sign up) Customer
- Cart Actions
- Order Actions
- Create Order by Import
- Create Order from Quote
- Get Order by OrderNumber
- Check if Order exists by OrderNumber
- Update Order by OrderNumber
- Delete Order by OrderNumber
- Get OrderEdit by Key
- Check if OrderEdit exists by Key
- Update OrderEdit by Key
- Delete OrderEdit by Key
- Apply order edit
- Get OrderEdit by ID
- Check if OrderEdit exists by ID
- Update OrderEdit by ID
- Delete OrderEdit by ID
- Query OrderEdits
- Check if OrderEdit exists by Query Predicate
- Create OrderEdit
- Get Order by ID
- Check if Order exists by ID
- Update Order by ID
- Delete Order by ID
- Search Orders
- head ByProjectKeyOrdersSearch
- Query Orders
- Check if Order exists by Query Predicate
- Create Order
- Business Unit Actions
- Get BusinessUnit by Key
- Check if BusinessUnit exists by Key
- Update BusinessUnit by Key
- Delete BusinessUnit by Key
- Get BusinessUnit by ID
- Check if BusinessUnit exists by ID
- Update BusinessUnit by ID
- Delete BusinessUnit by ID
- Get Associate in BusinessUnit by Key
- Get Associate in BusinessUnit by ID
- Search Business Units
- Check if Business Unit Search index exists
- Get indexing status of Business Unit Search
- Query BusinessUnits
- Check if BusinessUnit exists by Query Predicate
- Create BusinessUnit
- Category Actions
- Channel Actions
- Associate-role Actions
- Get AssociateRole by Key
- Check if AssociateRole exists by Key
- Update AssociateRole by Key
- Delete AssociateRole by Key
- Get AssociateRole by ID
- Check if AssociateRole exists by ID
- Update AssociateRole by ID
- Delete AssociateRole by ID
- Query AssociateRoles
- Check if AssociateRole exists by Query Predicate
- Create AssociateRole
- Inventory Actions
- Get InventoryEntry by ID
- Check if InventoryEntry exists by ID
- Update InventoryEntry by ID
- Delete InventoryEntry by ID
- Get InventoryEntry by Key
- Check if InventoryEntry exists by Key
- Update InventoryEntry by Key
- Delete InventoryEntry by Key
- Query InventoryEntries
- Check if InventoryEntry exists by Query Predicate
- Create InventoryEntry
- Review Actions
- Shopping-list Actions
- Get ShoppingList by Key
- Check if ShoppingList exists by Key
- Update ShoppingList by Key
- Delete ShoppingList by Key
- Get ShoppingList by ID
- Check if ShoppingList exists by ID
- Update ShoppingList by ID
- Delete ShoppingList by ID
- Query ShoppingLists
- Check if ShoppingList exists by Query Predicate
- Create ShoppingList
- Type Actions
- Custom-object Actions
- Payment Actions
- Payment-method Actions
- Get PaymentMethod by Key
- Check if PaymentMethod exists by Key
- Update PaymentMethod by Key
- Delete PaymentMethod by Key
- Get PaymentMethod by ID
- Check if PaymentMethod exists by ID
- Update PaymentMethod by ID
- Delete PaymentMethod by ID
- Query PaymentMethods
- Check if PaymentMethod exists by Query Predicate
- Create PaymentMethod
- Shipping-method Actions
- Get ShippingMethod by Key
- Check if ShippingMethod exists by Key
- Update ShippingMethod by Key
- Delete ShippingMethod by Key
- Get matching ShippingMethods for a Cart
- Check if matching ShippingMethod exists for a Cart
- Get matching ShippingMethods for a Cart and Location
- Check if matching ShippingMethod exists for a Cart and Location
- Get matching ShippingMethods for an OrderEdit
- Check if matching ShippingMethod exists for an Order Edit
- Get matching ShippingMethods for a Location
- Check if matching ShippingMethod exists for a Location
- Get ShippingMethod by ID
- Check if ShippingMethod exists by ID
- Update ShippingMethod by ID
- Delete ShippingMethod by ID
- Query ShippingMethods
- Check if ShippingMethod exists by Query Predicate
- Create ShippingMethod
- Zone Actions
- Subscription Actions
- Get Subscription by Key
- Check if Subscription exists by Key
- Update Subscription by Key
- Delete Subscription by Key
- Get Health Status of Subscription by ID
- Get Subscription by ID
- Check if Subscription exists by ID
- Update Subscription by ID
- Delete Subscription by ID
- Query Subscriptions
- Check if Subscription exists by Query Predicate
- Create Subscription
- State Actions
- Quote Actions
- Quote-request Actions
- Get QuoteRequest by Key
- Check if QuoteRequest exists by Key
- Update QuoteRequest by Key
- Delete QuoteRequest by Key
- Get QuoteRequest by ID
- Check if QuoteRequest exists by ID
- Update QuoteRequest by ID
- Delete QuoteRequest by ID
- Query QuoteRequests
- Check if QuoteRequest exists by Query Predicate
- Create QuoteRequest
- Staged-quote Actions
- Message Actions
- Extension Actions
- Approval Rule Actions
- Approval Flow Actions
- Associate Cart Actions
- Get Cart in BusinessUnit by Key as Associate
- Check if Cart exists in BusinessUnit by Key as Associate
- Update Cart in BusinessUnit by Key as Associate
- Delete Cart in BusinessUnit by Key as Associate
- Get Cart in BusinessUnit by ID as Associate
- Check if Cart exists in BusinessUnit by ID as Associate
- Update Cart in BusinessUnit by ID as Associate
- Delete Cart in BusinessUnit by ID as Associate
- Replicate Cart in BusinessUnit as Associate
- Query Carts in BusinessUnit as Associate
- Check if Cart exists in BusinessUnit by Query Predicate as Associate
- Create Cart in BusinessUnit as Associate
- Associate Order Actions
- Create Order in BusinessUnit from Quote as Associate
- Get Order in BusinessUnit by OrderNumber as Associate
- Check if Order exists in BusinessUnit by OrderNumber as Associate
- Update Order in BusinessUnit by OrderNumber as Associate
- Get Order in BusinessUnit by ID as Associate
- Check if Order exists in BusinessUnit by ID as Associate
- Update Order in BusinessUnit by ID as Associate
- Query Orders in BusinessUnit as Associate
- Check if Order exists in BusinessUnit by Query Predicate as Associate
- Create Order in BusinessUnit from Cart as Associate
- Associate Quote Actions
- Get Quote in BusinessUnit by Key as Associate
- Check if Quote exists in BusinessUnit by Key as Associate
- Update Quote in BusinessUnit by Key as Associate
- Get Quote in BusinessUnit by ID as Associate
- Check if Quote exists in BusinessUnit by ID as Associate
- Update Quote in BusinessUnit by ID as Associate
- Query Quotes in BusinessUnit as Associate
- Check if Quote exists in BusinessUnit by Query Predicate as Associate
- Associate Quote Request Actions
- Get QuoteRequest in BusinessUnit by Key as Associate
- Check if QuoteRequest exists in BusinessUnit by Key as Associate
- Update QuoteRequest in BusinessUnit by Key as Associate
- Get QuoteRequest in BusinessUnit by ID as Associate
- Check if QuoteRequest exists in BusinessUnit by ID as Associate
- Update QuoteRequest in BusinessUnit by ID as Associate
- Query QuoteRequests in BusinessUnit as Associate
- Check if QuoteRequest exists in BusinessUnit by Query Predicate as Associate
- Create QuoteRequest in BusinessUnit as Associate
- Associate Shopping List Actions
- Get ShoppingList in BusinessUnit by Key as Associate
- Check if ShoppingList exists in BusinessUnit by Key as Associate
- Update ShoppingList in BusinessUnit by Key as Associate
- Delete ShoppingList in BusinessUnit by Key as Associate
- Get ShoppingList in BusinessUnit by ID as Associate
- Check if ShoppingList exists in BusinessUnit by ID as Associate
- Update ShoppingList in BusinessUnit by ID as Associate
- Delete ShoppingList in BusinessUnit by ID as Associate
- Query ShoppingLists in BusinessUnit as Associate
- Check if ShoppingList exists in BusinessUnit by Query Predicate as Associate
- Create ShoppingList in BusinessUnit as Associate
- Associate Business Unit Actions
- Get BusinessUnit by Key
- Check if BusinessUnit exists by Key
- Update BusinessUnit by Key
- Delete BusinessUnit by Key
- Get BusinessUnit by ID
- Check if BusinessUnit exists by ID
- Update BusinessUnit by ID
- Delete BusinessUnit by ID
- Get Associate in BusinessUnit by Key
- Get Associate in BusinessUnit by ID
- Search Business Units
- Check if Business Unit Search index exists
- Get indexing status of Business Unit Search
- Query BusinessUnits
- Check if BusinessUnit exists by Query Predicate
- Create BusinessUnit
- Standalone Price Actions
- Get StandalonePrice by Key
- Check if StandalonePrice exists by Key
- Update StandalonePrice by Key
- Delete StandalonePrice by Key
- Get StandalonePrice by ID
- Check if StandalonePrice exists by ID
- Update StandalonePrice by ID
- Delete StandalonePrice by ID
- Query StandalonePrices
- Check if StandalonePrice exists by Query Predicate
- Create StandalonePrice
- Store Actions
- Product Tailoring Actions
- Customer Group Actions
- Get CustomerGroup by Key
- Check if CustomerGroup exists by Key
- Update CustomerGroup by Key
- Delete CustomerGroup by Key
- Get CustomerGroup by ID
- Check if CustomerGroup exists by ID
- Update CustomerGroup by ID
- Delete CustomerGroup by ID
- Query CustomerGroups
- Check if CustomerGroup exists by Query Predicate
- Create CustomerGroup
- Product Selection Actions
- Query Products in ProductSelection by Key
- Get ProductSelection by Key
- Check if ProductSelection exists by Key
- Update ProductSelection by Key
- Delete ProductSelection by Key
- Query Products in ProductSelection by ID
- Get ProductSelection by ID
- Check if ProductSelection exists by ID
- Update ProductSelection by ID
- Delete ProductSelection by ID
- Query ProductSelections
- Check if ProductSelection exists by Query Predicate
- Create ProductSelection
- Cart Discount Actions
- Get CartDiscount by Key
- Check if CartDiscount exists by Key
- Update CartDiscount by Key
- Delete CartDiscount by Key
- Get CartDiscount by ID
- Check if CartDiscount exists by ID
- Update CartDiscount by ID
- Delete CartDiscount by ID
- Query CartDiscounts
- Check if CartDiscount exists by Query Predicate
- Create CartDiscount
- Discount Code Actions
- Get DiscountCode by ID
- Check if DiscountCode exists by ID
- Update DiscountCode by ID
- Delete DiscountCode by ID
- Get DiscountCode by Key
- Check if DiscountCode exists by Key
- Update DiscountCode by Key
- Delete DiscountCode by Key
- Query DiscountCodes
- Check if DiscountCode exists by Query Predicate
- Create DiscountCode
- Product-discount Actions
- Get Matching ProductDiscount
- Get ProductDiscount by Key
- Check if ProductDiscount exists by Key
- Update ProductDiscount by Key
- Delete ProductDiscount by Key
- Get ProductDiscount by ID
- Check if ProductDiscount exists by ID
- Update ProductDiscount by ID
- Delete ProductDiscount by ID
- Query ProductDiscounts
- Check if ProductDiscount exists by Query Predicate
- Create ProductDiscount
- Product-type Actions
- Product-projection Actions
- Tax-category Actions
- Attribute-group Actions
- Get AttributeGroup by Key
- Check if AttributeGroup exists by Key
- Update AttributeGroup by Key
- Delete AttributeGroup by Key
- Get AttributeGroup by ID
- Check if AttributeGroup exists by ID
- Update AttributeGroup by ID
- Delete AttributeGroup by ID
- Query AttributeGroups
- Check if AttributeGroup exists by Query Predicate
- Create AttributeGroup
- Api-client Actions
- Recurring-order Actions
- Get RecurringOrder by ID
- Check if RecurringOrder exists by ID
- Update RecurringOrder by ID
- Delete RecurringOrder by ID
- Get RecurringOrder by Key
- Check if RecurringOrder exists by Key
- Update RecurringOrder by Key
- Delete RecurringOrder by Key
- Query RecurringOrders
- Check if RecurringOrder exists by Query Predicate
- Create RecurringOrder
- Recurrence-policy Actions
- Get RecurrencePolicy by Key
- Check if RecurrencePolicy exists by Key
- Update RecurrencePolicy by Key
- Delete RecurrencePolicy by Key
- Get RecurrencePolicy by ID
- Check if RecurrencePolicy exists by ID
- Update RecurrencePolicy by ID
- Delete RecurrencePolicy by ID
- Query RecurrencePolicies
- Check if RecurrencePolicy exists by Query Predicate
- Create RecurrencePolicy
- Discount-group Actions
- Get DiscountGroup by Key
- Check if DiscountGroup exists by Key
- Update DiscountGroup by Key
- Delete DiscountGroup by Key
- Get DiscountGroup by ID
- Check if DiscountGroup exists by ID
- Update DiscountGroup by ID
- Delete DiscountGroup by ID
- Query DiscountGroups
- Check if DiscountGroup exists by Query Predicate
- Create DiscountGroup
- Store Business Unit Actions
- Get BusinessUnit in Store by Key
- Check if BusinessUnit exists in Store by Key
- Update BusinessUnit in Store by Key
- Delete BusinessUnit in Store by Key
- Get BusinessUnit in Store by ID
- Check if BusinessUnit exists in Store by ID
- Update BusinessUnit in Store by ID
- Delete BusinessUnit in Store by ID
- Get Associate in BusinessUnit in Store by Key
- Get Associate in BusinessUnit in Store by ID
- Query BusinessUnits in Store
- Check if BusinessUnit exists in Store by Query Predicate
- Create BusinessUnit in Store
- Store Cart Discount Actions
- Get CartDiscount in Store by Key
- Check if CartDiscount exists in Store by Key
- Update CartDiscount in Store by Key
- Delete CartDiscount in Store by Key
- Get CartDiscount in Store by ID
- Check if CartDiscount exists in Store by ID
- Update CartDiscount in Store by ID
- Delete CartDiscount in Store by ID
- Query CartDiscounts in Store
- Check if CartDiscount exists in Store by Query Predicate
- Create CartDiscount in Store
- Store Cart Actions
- Get Cart in Store by Customer ID
- Check if Cart exists in Store by Customer ID
- Merge Cart in Store
- Get Cart in Store by Key
- Check if Cart exists in Store by Key
- Update Cart in Store by Key
- Delete Cart in Store by Key
- Replicate Cart in Store
- Get Cart in Store by ID
- Check if Cart exists in Store by ID
- Update Cart in Store by ID
- Delete Cart in Store by ID
- Query Carts in Store
- Check if Cart exists in Store by Query Predicate
- Create Cart in Store
- Store Customer Actions
- Get Customer in Store by password token
- Get Customer in Store by email token
- Create email token for Customer in Store
- Verify email of Customer in Store
- Change password of Customer in Store
- Reset password of Customer in Store
- Create password reset token for Customer in Store
- Get Customer in Store by Key
- Check if Customer exists in Store by Key
- Update Customer in Store by Key
- Delete Customer in Store by Key
- Get Customer in Store by ID
- Check if Customer exists in Store by ID
- Update Customer in Store by ID
- Delete Customer in Store by ID
- Query Customers in Store
- Check if Customers exist in Store by Query Predicate
- Create (sign up) Customer in Store
- Store Order Actions
- Create Order in Store from Quote
- Get Order in Store by OrderNumber
- Check if Order exists in Store by OrderNumber
- Update Order in Store by OrderNumber
- Delete Order in Store by OrderNumber
- Get Order in Store by ID
- Check if Order exists in Store by ID
- Update Order in Store by ID
- Delete Order in Store by ID
- Query Orders in Store
- Check if Order exists in Store by Query Predicate
- Create Order in Store
- Store Quote Request Actions
- Get QuoteRequest in Store by Key
- Check if QuoteRequest exists in Store by Key
- Update QuoteRequest in Store by Key
- Delete QuoteRequest in Store by Key
- Get QuoteRequest in Store by ID
- Check if QuoteRequest exists in Store by ID
- Update QuoteRequest in Store by ID
- Delete QuoteRequest in Store by ID
- Query QuoteRequests in Store
- Check if QuoteRequest exists in Store by Query Predicate
- Create QuoteRequest in Store
- Store Quote Actions
- Get Quote in Store by Key
- Check if Quote exists in Store by Key
- Update Quote in Store by Key
- Delete Quote in Store by Key
- Get Quote in Store by ID
- Check if Quote exists in Store by ID
- Update Quote in Store by ID
- Delete Quote in Store by ID
- Query Quotes in Store
- Check if Quote exists in Store by Query Predicate
- Create Quote in Store
- Store Shopping List Actions
- Get ShoppingList in Store by Key
- Check if ShoppingList exists in Store by Key
- Update ShoppingList in Store by Key
- Delete ShoppingList in Store by Key
- Get ShoppingList in Store by ID
- Check if ShoppingList exists in Store by ID
- Update ShoppingList in Store by ID
- Delete ShoppingList in Store by ID
- Query ShoppingLists in Store
- Check if ShoppingList exists in Store by Query Predicate
- Create ShoppingList in Store
- Store Staged Quote Actions
- Get StagedQuote in Store by Key
- Check if StagedQuote exists in Store by Key
- Update StagedQuote in Store by Key
- Delete StagedQuote in Store by Key
- Get StagedQuote in Store by ID
- Check if StagedQuote exists in Store by ID
- Update StagedQuote in Store by ID
- Delete StagedQuote in Store by ID
- Query StagedQuotes in Store
- Check if StagedQuote exists in Store by Query Predicate
- Create StagedQuote in Store
- Store Product Projection Actions
- Store Shipping Method Actions
- Store Product Actions
- Upload ProductTailoring image by Product ID
- Get ProductTailoring assigned to Product in Store by Product ID
- Update ProductTailoring assigned to Product in Store by Product ID
- Delete ProductTailoring assigned to Product in Store
- Upload ProductTailoring image by Product Key
- Get ProductTailoring assigned to Product in Store by Product Key
- Update ProductTailoring assigned to Product in Store by Product Key
- Delete ProductTailoring assigned to Product in Store by Product Key
Customer → Update Customer by Key
AI-generatedSummary
Update an existing customer resource by its unique customer key by specifying the version for concurrency control and providing one or more update actions either as a JSON array or through a UI-friendly fixed collection of available customer update actions.
Inputs
- Customer Key (required) — The unique key identifying the customer to update.
- Version (required) — The current version of the customer resource, required for optimistic concurrency control.
- Actions (JSON) — A raw JSON array representing the update actions to apply; if provided and non-empty, this overrides UI-specified actions.
- Actions (UI) — A collection of predefined update actions selectable and configurable via the UI, such as changing email, adding addresses, setting custom fields, etc. These actions are used if 'Actions (JSON)' is empty.
Output shape
a single JSON object representing the updated customer resource as returned from the commercetools API
The operation requires valid OAuth2 credentials for the commercetools API with the correct project key and region. The update applies changes atomically to the customer identified by the given key and version, preventing conflicts. Errors throw exceptions unless 'Continue On Fail' is enabled, where they are returned as error objects per item.
Examples
Example 1: Update a customer by key to change their email address and add a billing address ID using UI actions.
Set the 'Customer Key' to the key of the target customer, set 'Version' to their current version number, and select 'ChangeEmail' and 'AddBillingAddressId' actions in the UI, filling required fields.
Example 2: Update a customer by key using raw JSON actions.
Set the 'Customer Key' and 'Version', then input a JSON array of actions in 'Actions (JSON)', which overrides UI actions. For example, to set first name and set custom type fields.