Skip to main content

Fetch customer addresses

Retrieve all delivery addresses for a company, useful for the address book and checkout address selector.

Query​

query GetCompanyAddresses($companyId: Float!, $type: AddressType) {
  addressesByCompanyId(companyId: $companyId, type: $type) {
    id
    firstName
    lastName
    company
    street
    number
    numberExtension
    postalCode
    city
    country
    isDefault
    type
    name
    phone
    email
  }
}

Variables​

{
  "companyId": 141,
  "type": "delivery"
}

Response​

{
  "data": {
    "addressesByCompanyId": [
      {
        "id": 81166,
        "firstName": "Philippe",
        "lastName": "Barril",
        "company": "ASML Veldhoven",
        "street": "De Run",
        "number": "6501",
        "numberExtension": null,
        "postalCode": "5504 DR",
        "city": "Veldhoven",
        "country": "NL",
        "isDefault": "N",
        "type": "delivery",
        "name": "",
        "phone": null,
        "email": null
      },
      {
        "id": 82101,
        "firstName": "Andre",
        "lastName": "Vries",
        "company": "ASML Veldhoven",
        "street": "De Run",
        "number": "1120",
        "numberExtension": null,
        "postalCode": "5503 LA",
        "city": "Veldhoven",
        "country": "NL",
        "isDefault": "Y",
        "type": "delivery",
        "name": "",
        "phone": null,
        "email": null
      }
    ]
  }
}

How it works​

Pass the companyId from the logged-in user's profile. The optional type argument filters by address type — use delivery, invoice, or home. Omit it to get all addresses. The isDefault field indicates which address should be pre-selected in the checkout. The id field can be used to populate the cart address via cartUpdateAddress. There is also addressesByCustomerId for B2C customers and addressesByUserId for direct user lookups.

See also​