Address

The address object

A saved address that can be used for billing and shipping on sales orders, invoices, and shipments.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

The most specific link in the receiving chain: set it when one of a customer's sites keeps different days from the rest. Null falls through to the customer, then their group, then the account default.

geolocationgeolocationnullable

Street-level location details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate SandboxSandbox GETList SandboxesSandbox GETRetrieve SandboxSandbox GETList Request LogsRequest Log GETRetrieve Request LogRequest Log GETList Audit EventsAudit Event GETRetrieve Audit EventAudit Event POSTCreate UnitUnits PATCHUpdate UnitUnits GETList UnitsUnits GETRetrieve UnitUnits POSTCreate Unit GroupUnit Groups PATCHUpdate Unit GroupUnit Groups GETList Unit GroupsUnit Groups GETRetrieve Unit GroupUnit Groups POSTCreate Account PriceAccount Prices PATCHUpdate Account PriceAccount Prices GETList Account PricesAccount Prices GETRetrieve Account PriceAccount Prices POSTCreate Payment TermPayment Terms PATCHUpdate Payment TermPayment Terms GETList Payment TermsPayment Terms GETRetrieve Payment TermPayment Terms POSTCreate Shipping TermShipping Terms PATCHUpdate Shipping TermShipping Terms GETList Shipping TermsShipping Terms GETRetrieve Shipping TermShipping Terms POSTCreate AddressAddress PATCHUpdate AddressAddress GETList AddressesAddress GETRetrieve AddressAddress DELETEDelete AddressAddress POSTCreate Sales TargetSales Targets PUTUpsert Sales TargetSales Targets GETList Sales TargetsSales Targets POSTCreate CarrierCarriers PATCHUpdate CarrierCarriers GETList CarriersCarriers GETRetrieve CarrierCarriers POSTCreate Service LevelService Levels PATCHUpdate Service LevelService Levels GETList Service LevelsService Levels GETRetrieve Service LevelService Levels POSTCreate Item CategoryItem Categories PATCHUpdate Item CategoryItem Categories GETList Item CategoriesItem Categories GETRetrieve Item CategoryItem Categories DELETEDelete MaterialMaterials DELETEDelete PartParts POSTCreate CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers GETRetrieve Customer Lead TimeCustomers POSTMerge CustomersCustomers POSTFind Contact by EmailContacts POSTCreate Product LineProduct Lines PATCHUpdate Product LineProduct Lines GETList Product LinesProduct Lines GETRetrieve Product LineProduct Lines POSTGenerate Production ScheduleProduction Schedules GETList Production SchedulesProduction Schedules GETRetrieve Current Production ScheduleProduction Schedules GETRetrieve Production ScheduleProduction Schedules GETList Production Schedule DeviationsProduction Schedules PUTArchive Production ScheduleProduction Schedules PUTPublish Production ScheduleProduction Schedules PUTRegenerate Production ScheduleProduction Schedules POSTRelease Production Schedule WeekProduction Schedules POSTCreate Sales OrderSales Orders PATCHUpdate Sales OrderSales Orders GETList Sales OrdersSales Orders GETRetrieve Sales OrderSales Orders PUTClose Sales OrderSales Orders PUTIssue Sales OrderSales Orders PUTReopen Sales OrderSales Orders POSTQuote Sales Order FreightSales Orders PUTUnissue Sales OrderSales Orders POSTRate ShopShipment POSTCreate RoleRoles PATCHUpdate RoleRoles GETList RolesRoles GETRetrieve RoleRoles

address example

{
  "id": "ad_j8cz0b79pwdb",
  "object": "address",
  "name": "Headquarters",
  "phone": "+1-614-555-0142",
  "email": "receiving@acme.example.com",
  "type": "standard",
  "receive_calendar_id": null,
  "geolocation": {
    "id": "gl_betrf3v346k5",
    "object": "geolocation",
    "street_line_1": "4200 Industrial Pkwy",
    "street_line_2": null,
    "locality": "Columbus",
    "state": "OH",
    "postal_code": "43204",
    "country": "US"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ad_j8cz0b79pwdb",
  "object": "address",
  "name": "Headquarters",
  "phone": "+1-614-555-0142",
  "email": "receiving@acme.example.com",
  "type": "standard",
  "receive_calendar_id": null,
  "geolocation": {
    "id": "gl_betrf3v346k5",
    "object": "geolocation",
    "street_line_1": "4200 Industrial Pkwy",
    "street_line_2": null,
    "locality": "Columbus",
    "state": "OH",
    "postal_code": "43204",
    "country": "US"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Address

Attributes

Used by