Addresses Queries

Query addresses for contacts and companies.

Customer — Get customer's default addresses

GraphQL

query CustomerDefaultAddresses($id: ID) {
  Customer(id: $id) {
    id
    default_billing_address {
      id
      label
      country
      address_1
      postal_code
      city
      type
      default
    }
    default_shipping_address {
      id
      label
      country
      address_1
      postal_code
      city
      type
      default
    }
  }
}

JSON

{
  "id": 123
}

Order — Get order addresses

GraphQL

query GetOrderAddresses($id: ID) {
  Order(id: $id) {
    id
    billing_address { id label country address_1 postal_code city }
    shipping_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 100015 }

Invoice — Get invoice addresses

GraphQL

query GetInvoiceAddresses($id: ID) {
  Invoice(id: $id) {
    id
    billing_address { id label country address_1 postal_code city }
    shipping_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 200021 }

Estimate — Get estimate addresses

GraphQL

query GetEstimateAddresses($id: ID) {
  Estimate(id: $id) {
    id
    billing_address { id label country address_1 postal_code city }
    shipping_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 210045 }

Employee — Get employee address

GraphQL

query GetEmployeeAddress($id: ID) {
  Employee(id: $id) {
    id
    address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 7001 }

Purchase — Get purchase shipping address

GraphQL

query GetPurchaseShippingAddress($id: ID) {
  Purchase(id: $id) {
    id
    shipping_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 100012 }

ShippingOrder — Get shipping order shipping address

GraphQL

query GetShippingOrderAddress($id: ID) {
  ShippingOrder(id: $id) {
    id
    shipping_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 300078 }

CreditNote — Get credit note addresses

GraphQL

query GetCreditNoteAddresses($id: ID) {
  CreditNote(id: $id) {
    id
    billing_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 400033 }

Refund — Get refund address (if exposed)

GraphQL

query GetRefundAddress($id: ID) {
  Refund(id: $id) {
    id
    billing_address { id label country address_1 postal_code city }
  }
}

JSON

{ "id": 410010 }

---

Available fields

Field	Type	Description
id	Int	Unique identifier of the address.
label	String	Address label.
country	String	Country code (e.g. FR, US).
address_1	String	Address line 1.
address_2	String	Address line 2.
postal_code	String	Postal code.
city	String	City.
state	String	State / Region.
phone	String	Phone number.
dependent_locality	String	Dependent locality.
type	String	Address type (e.g. billing, shipping).
default	Boolean	Whether the address is default.

Filters

There is no Addresses list query. Addresses are read through relations of other entities, hence no dedicated filters/sorting.

---

Example of data returned

JSON

{
  "data": {
    "Purchase": {
      "id": 100012,
      "shipping_address": {
        "id": 501,
        "label": "Paris Office",
        "country": "FR",
        "address_1": "10 Rivoli Street",
        "postal_code": "75001",
        "city": "Paris",
        "type": "shipping",
        "default": true
      }
    }
  }
}