commercetools icon

commercetools

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

Actions671

Shopping-list → Create ShoppingList

AI-generated

Summary

Create a new shopping list in commercetools by providing its required fields like name, slug, key, deletion policy, line items, and optional associations such as customer and business unit information.

Inputs

  • Name (required) — A localized name for the shopping list in JSON format, e.g., { "en": "My List" }.
  • Slug (required) — A localized slug for the shopping list in JSON format, e.g., { "en": "my-list" }.
  • Key (required) — A unique key identifying the shopping list.
  • Delete Days After Last Modification (required) — Number of days after the last modification when the shopping list should be automatically deleted.
  • Line Items (required) — An array of JSON objects representing line items to include in the shopping list.
  • Text Line Items (required) — An array of JSON objects representing text line items to include in the shopping list.
  • Customer › Type Id — Type identifier for the customer reference.
  • Customer › Id — ID of the customer associated with the shopping list.
  • Business Unit › Key — Key of the business unit associated with the shopping list.
  • Business Unit › Type Id — Type identifier for the business unit reference.

Output shape

a single record representing the created shopping list

Returns the JSON response from the commercetools API containing the newly created shopping list object. Errors are thrown or optionally returned when 'continue on fail' is active.

Links

Discussion