addShoppingListItems

Deprecated

Example Query

mutation ExampleMutation($input: AddShoppingListItemsInput!) {
  company {
    addShoppingListItems(input: $input) {
      entityIds
      errors
    }
  }
}

Variables

{
  "input": {
    "shoppingListEntityId": 0,
    "items": [
      {
        "productEntityId": 0,
        "variantEntityId": 0,
        "quantity": 0,
        "selectedOptions": {
          "multipleChoices": [
            {
              "optionEntityId": 0,
              "optionValueEntityId": 0
            }
          ],
          "checkboxes": [
            {
              "optionEntityId": 0,
              "optionValueEntityId": 0
            }
          ],
          "textFields": [
            {
              "optionEntityId": 0,
              "text": "example"
            }
          ],
          "multiLineTextFields": [
            {
              "optionEntityId": 0,
              "text": "example"
            }
          ],
          "numberFields": [
            {
              "optionEntityId": 0,
              "number": 0
            }
          ],
          "dateFields": [
            {
              "optionEntityId": 0,
              "date": "2026-11-13T19:25:55.902Z"
            }
          ]
        },
        "sortOrder": 0,
        "productNote": "example"
      }
    ]
  }
}

Example response

{
  "data": {
    "company": {
      "addShoppingListItems": {
        "entityIds": [
          0
        ],
        "errors": [
          {
            "path": [
              "example"
            ],
            "message": "example"
          }
        ]
      }
    }
  }
}

Add products to a shopping list. Adding an item that already exists (same product, variant and options) increases its quantity.

Deprecated: Alpha version. Do not use in production.

Arguments

inputAddShoppingListItemsInputRequired

The list to add to and the products to add.

Returns

an optional AddShoppingListItemsResult

errorslist of AddShoppingListItemsErrors

Errors encountered by the mutation, empty on success.

entityIdslist of IntegersOptional

The ids of the items, in the same order as the input items, or null if the mutation failed. An item merged into an existing one returns the existing item's id, so an id can repeat.