ServiceAddress

idstring<uuid>required

Address id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

typestringnullablerequired

What the address is used for.

Possible values: [BILLING, SHIPPING, WAREHOUSE, OFFICE, HOME, PICKUP, DELIVERY, RETURN, null]

labelstringnullablerequired

Short label.

Example: Head office

street1stringnullablerequired

Street, line 1.

Example: 1 Example Street

street2stringnullablerequired

Street, line 2.

Example: Suite 100

citystringnullablerequired

City.

Example: Exampleville

statestringnullablerequired

State or province.

Example: Example State

countrystringnullablerequired

Country.

Example: Exampleland

postalCodestringnullablerequired

Postal code.

Example: 12345

isDefaultbooleanrequired

True for the customer's default address of its type.

Example: true

isBranchbooleanrequired

True when the address is a branch location.

Example: false

isActivebooleannullablerequired

False when the address is retired.

Example: true

ServiceAddress

{
  "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
  "type": "BILLING",
  "label": "Head office",
  "street1": "1 Example Street",
  "street2": "Suite 100",
  "city": "Exampleville",
  "state": "Example State",
  "country": "Exampleland",
  "postalCode": "12345",
  "isDefault": true,
  "isBranch": false,
  "isActive": true
}