customerCreateBuyingList

Requires a customer (portal or buyer app) session.

Create an empty buying list. screen 12.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CustomerCreateBuyingList($input: CustomerCreateBuyingListInput!) {
  customerCreateBuyingList(input: $input) {
    id
    name
    createdByName
    canDelete
    canEdit
    currency
    items {
      id
      addedByName
      productName
      variantName
      imageUrl
      lineTotal
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerCreateBuyingList($input: CustomerCreateBuyingListInput!) {\n  customerCreateBuyingList(input: $input) {\n    id\n    name\n    createdByName\n    canDelete\n    canEdit\n    currency\n    items {\n      id\n      addedByName\n      productName\n      variantName\n      imageUrl\n      lineTotal\n    }\n  }\n}",
  "variables": {
    "input": {
      "name": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "name": "string"
  }
}

Response:

{
  "data": {
    "customerCreateBuyingList": {
      "id": "id",
      "name": "string",
      "createdByName": "string",
      "canDelete": true,
      "canEdit": true,
      "currency": "string",
      "items": [
        {
          "id": "id",
          "addedByName": "string",
          "productName": "string",
          "variantName": "string",
          "imageUrl": "string",
          "lineTotal": 0
        }
      ]
    }
  }
}

customerCreateBuyingList(
  input: CustomerCreateBuyingListInput!
): CustomerBuyingListView!

Arguments

customerCreateBuyingList.input ● CustomerCreateBuyingListInput! non-null input

The details of the customer create buying list request.

Type

CustomerBuyingListView object

A durable partner-shared buying list. screen 12.