input CreateOrderAddressInput

Order type for addresses. Orders have addresses with more details than the rest of the system so we use our own types

Fields

FieldTypeDescription
first_nameString

First name for the address or contact.

last_nameString

Last name for the address or contact.

companyString

Company for the address or contact.

address1String

Address line 1 for the address or contact.

address2String

Address line 2 for the address or contact.

cityString

City for the address or contact.

stateString

Send the state code here (e.g., NY, CA).

state_codeStringDEPRECATED Use the state field instead and send the state code

State or province code for state code.

zipString

Postal or ZIP code.

countryString

Send the ISO country code here (e.g., US, CA).

country_codeStringDEPRECATED Use the country field instead and send the country code

ISO country code for country code.

emailString

Order email takes precedence, followed by shipping address email, then billing address email.

phoneString

Phone number for the contact.

Referenced By

Example

{
  "first_name": "Ada",
  "last_name": "Lovelace",
  "company": "Acme Corp",
  "address1": "123 Fulfillment Ave",
  "address2": "Suite 100",
  "city": "New York",
  "state": "NY",
  "state_code": "NY",
  "zip": "10001",
  "country": "US",
  "country_code": "US",
  "email": "customer@example.com",
  "phone": "+1-555-0100"
}