myAddresses

Requires a customer (portal or buyer app) session.

Returns the buyer's owned addresses.

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 MyAddresses {
  myAddresses {
    id
    postalCode
    name
    createdAt
    addressLine1
    addressType
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MyAddresses {\n  myAddresses {\n    id\n    postalCode\n    name\n    createdAt\n    addressLine1\n    addressType\n  }\n}"
}
EOF

Response:

{
  "data": {
    "myAddresses": [
      {
        "id": "id",
        "postalCode": "string",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "addressLine1": "string",
        "addressType": "BILLING"
      }
    ]
  }
}

myAddresses: [MyAddress!]!

Type

MyAddress object

A buyer-owned ordering location, backed by an Address row (type SHIPPING/DELIVERY). isActive: false means the address is pending a seller's approval and cannot be ordered against.