Shopping lists types
The types the shopping lists domain defines, with the fields other domains add to them.
Objects
ShoppingList
Customer shopping list containing saved products for future purchase
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the shopping list |
name | String! | Name of the shopping list |
description | String | Optional description of the shopping list |
lineItems | [ShoppingListLineItem!]! | Items in the shopping list |
ShoppingListCreateResponse
| Field | Type | Description |
|---|---|---|
shoppingList | ShoppingList | Created shopping list information |
shoppingListErrors | [ShoppingListCreateError!] | Error details if creation failed |
ShoppingListDeleteResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | |
shoppingListErrors | [ShoppingListDeleteError!] | Error details if deletion failed |
ShoppingListLineItem
Individual item within a shopping list containing product and quantity information
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the line item |
variant | ProductVariant! | Product variant for this line item |
quantity | Int! | Quantity of the item in the shopping list |
slug | String | URL slug for the product (optional) |
ShoppingListLineItemsAddResponse
| Field | Type | Description |
|---|---|---|
shoppingList | ShoppingList | Updated shopping list information after line item operation |
shoppingListErrors | [ShoppingListLineItemsAddError!] | Error details if line item operation failed |
ShoppingListLineItemsRemoveResponse
| Field | Type | Description |
|---|---|---|
shoppingList | ShoppingList | Updated shopping list information after line item operation |
shoppingListErrors | [ShoppingListLineItemsRemoveError!] | Error details if line item operation failed |
ShoppingListLineItemsUpdateResponse
| Field | Type | Description |
|---|---|---|
shoppingList | ShoppingList | Updated shopping list information after line item operation |
shoppingListErrors | [ShoppingListLineItemsUpdateError!] | Error details if line item operation failed |
ShoppingListResult
Paginated result containing shopping lists and metadata
| Field | Type | Description |
|---|---|---|
items | [ShoppingList!]! | List of shopping lists returned in the result |
pagination | Pagination! | Where this page sits within the full result set |
ShoppingListUpdateResponse
| Field | Type | Description |
|---|---|---|
shoppingList | ShoppingList | Updated shopping list information |
shoppingListErrors | [ShoppingListUpdateError!] | Error details if update failed |
Input objects
ShoppingListInput
Input data for creating or updating a shopping list
| Field | Type | Description |
|---|---|---|
name | String! | Name for the shopping list |
description | String | Optional description for the shopping list |
ShoppingListLineItemAddInput
Input data for adding a new item to a shopping list
| Field | Type | Description |
|---|---|---|
sku | String! | SKU of the product variant to add |
quantity | Int | Quantity of the item (optional, defaults to 1) |
ShoppingListLineItemUpdateInput
Input data for updating an existing item in a shopping list
| Field | Type | Description |
|---|---|---|
id | ID! | ID of the line item to update |
quantity | Int | New quantity for the line item |
Unions
ShoppingListCreateError
One of ValidationError.
ShoppingListDeleteError
One of ValidationError.
ShoppingListLineItemsAddError
One of ValidationError.
ShoppingListLineItemsRemoveError
One of ValidationError.
ShoppingListLineItemsUpdateError
One of ValidationError.
ShoppingListUpdateError
One of ValidationError.