commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Store Shopping List → Update ShoppingList in Store by Key

AI-generated

Summary

Update a specific shopping list within a commercetools store identified by its unique key, applying a set of update actions at a specified version to maintain consistency.

Inputs

  • Store Key (required) — The unique key of the commercetools store containing the shopping list.
  • Store Shopping List Key (required) — The key identifying the shopping list resource type (internal usage for store shopping lists).
  • Shopping List Key (required) — The unique key of the shopping list within the store to update.
  • Version (required) — The current version of the shopping list resource to ensure update consistency; must match the latest version on the server.
  • Actions (JSON) — A JSON array of update actions to apply to the shopping list; this raw JSON overrides any UI-configured actions.

Output shape

a single JSON object representing the updated shopping list resource as returned by the commercetools API

The operation requires the latest version number of the shopping list for optimistic concurrency control. If the specified version is outdated, the update will fail. The updated shopping list object includes the changes applied.

Examples

Example 1: Update the shopping list's name and add a new text line item, specifying the store key, shopping list key, current version, and actions in JSON.

Inputs include storeKey, resourceKey (fixed internally for store shopping lists), tertiaryKey (shopping list key), version, and actionsJson__instoreshoppinglists with desired update actions.

Links

Discussion