customerDeleteBuyingList

Requires a customer (portal or buyer app) session.

Soft-delete a 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 CustomerDeleteBuyingList($listId: ID!) {
  customerDeleteBuyingList(listId: $listId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerDeleteBuyingList($listId: ID!) {\n  customerDeleteBuyingList(listId: $listId)\n}",
  "variables": {
    "listId": "id"
  }
}
EOF

Variables:

{
  "listId": "id"
}

Response:

{
  "data": {
    "customerDeleteBuyingList": true
  }
}

customerDeleteBuyingList(
  listId: ID!
): Boolean!

Arguments

customerDeleteBuyingList.listId ● ID! non-null scalar

The ID of the buying list.

Type

Boolean scalar

The Boolean scalar type represents true or false.