Shopping lists GraphQL

Served by ShoppingListModule on commercetools, ShoppingListModule on medusa and ShoppingListModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the shopping lists types page.

Operations

Operation	Description	Served by
`shoppingList`Query	Get a specific shopping list by ID (returns default list if no ID provided)	commercetoolsmedusasfcc
`shoppingLists`Query	Get paginated list of shopping lists for the current user	commercetoolsmedusasfcc
`shoppingListCreate`Mutation	Create a new shopping list for the current user	commercetoolsmedusasfcc
`shoppingListDelete`Mutation	Delete a shopping list permanently	commercetoolsmedusasfcc
`shoppingListLineItemsAdd`Mutation	Add products to a shopping list Note: "id" is optional for B2C/anonymous users - if not provided, a new list is created	commercetoolsmedusasfcc
`shoppingListLineItemsRemove`Mutation	Remove specific items from a shopping list	commercetoolsmedusasfcc
`shoppingListLineItemsUpdate`Mutation	Update quantities or other properties of existing shopping list items	commercetoolsmedusasfcc
`shoppingListUpdate`Mutation	Update an existing shopping list's information	commercetoolsmedusasfcc

Types

Type	Description
`ShoppingList`Object	Customer shopping list containing saved products for future purchase
`ShoppingListCreateError`Union
`ShoppingListCreateResponse`Object
`ShoppingListDeleteError`Union
`ShoppingListDeleteResponse`Object
`ShoppingListInput`Input object	Input data for creating or updating a shopping list
`ShoppingListLineItem`Object	Individual item within a shopping list containing product and quantity information
`ShoppingListLineItemAddInput`Input object	Input data for adding a new item to a shopping list
`ShoppingListLineItemsAddError`Union
`ShoppingListLineItemsAddResponse`Object
`ShoppingListLineItemsRemoveError`Union
`ShoppingListLineItemsRemoveResponse`Object
`ShoppingListLineItemsUpdateError`Union
`ShoppingListLineItemsUpdateResponse`Object
`ShoppingListLineItemUpdateInput`Input object	Input data for updating an existing item in a shopping list
`ShoppingListResult`Object	Paginated result containing shopping lists and metadata
`ShoppingListUpdateError`Union
`ShoppingListUpdateResponse`Object

Fields on other types

This domain adds these fields to types that another domain defines.

`BusinessUnit`

Field	Type	Description
`shoppingList`B2B	`ShoppingList`	Get a specific shopping list by IDArguments: `id`
`shoppingLists`B2B	`ShoppingListResult`	Get a paginated list of shopping listsArguments: `page`, `pageSize`

`Customer`

Field	Type	Description
`email`	`String!`
`shoppingList`	`ShoppingList`	Get a specific shopping list by ID for the customerArguments: `id`
`shoppingLists`	`ShoppingListResult`	Get paginated shopping lists for the customerArguments: `page`, `pageSize`