customerLogout

Requires a customer (portal or buyer app) session.

Ends a customer's session so its tokens stop working.

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 CustomerLogout {
  customerLogout
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerLogout {\n  customerLogout\n}"
}
EOF

Response:

{
  "data": {
    "customerLogout": true
  }
}

customerLogout(
  sessionToken: String
): Boolean!

Arguments

customerLogout.sessionToken ● String scalar

The session to end.

Type

Boolean scalar

The Boolean scalar type represents true or false.