customerPortalSession

Requires a customer (portal or buyer app) session.

True when the signed-in buyer's portal session belongs to the site the request came from. A session from another seller's site is refused as unauthenticated.

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

query CustomerPortalSession {
  customerPortalSession
}

cURL

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

Response:

{
  "data": {
    "customerPortalSession": true
  }
}

customerPortalSession: Boolean!

Type

Boolean scalar

The Boolean scalar type represents true or false.