myAddressAccess

Requires a customer (portal or buyer app) session.

Whether this buyer may manage their own addresses. The app reads canAddAddress to show or hide its add/edit controls; the server enforces the rule independently on every address mutation.

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 MyAddressAccess {
  myAddressAccess {
    assignedCount
    canAddAddress
    isScoped
  }
}

cURL

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

Response:

{
  "data": {
    "myAddressAccess": {
      "assignedCount": 0,
      "canAddAddress": true,
      "isScoped": true
    }
  }
}

myAddressAccess: MobileAddressAccess!

Type

MobileAddressAccess object

Whether the buyer may add or edit addresses, and whether they are limited to assigned ones.