Model: globalAddresses

1 min

Model Parameters

globalAddresses
- addressesobject[]
  Description
  Array introducing the addresses block.
  - addressIDstring
    Example
    23kj423klj234j
    Description
    Optional. Identifier you define to an address to differentiate orders with multiples. Maximum field length = 20 characters.
  - addressTypestring<account | billing | bopis | curbside | departure | destination | fulfillment | listing | lodging | pickup | return | shipping | venue | other>
    Description
    Optional. The type of address being collected.
    
    Options are:
    
    account
    
    billing
    
    bopis
    
    curbside
    
    departure
    
    destination
    
    fulfillment
    
    listing
    
    lodging
    
    pickup
    
    return
    
    shipping
    
    venue
    
    other
    Allowed
    accountbillingbopiscurbsidedeparturedestinationfulfillmentlistinglodgingpickupreturnshippingvenueother
  - primaryFlagboolean
    Description
    Optional. Whether the address is marked as user's primary address.
    
    Options are:
    
    true
    
    false
    Allowed
    truefalse
  - isAddressOnFileboolean
    Example
    Whether the shipping address is the same as the shipping address for this account.
    Description
    Optional. Whether the address for this action matches the address you have on file for this action.
    
    Options are:
    
    true
    
    false
    Allowed
    truefalse
  - firstNamestring
    Example
    Jane
    Description
    Optional. Address owners's first name. Maximum field length = 40 characters.
  - middleNamestring
    Example
    Marie
    Description
    Optional. Address owner's middle name. Maximum field length = 20 characters.
  - lastNamestring
    Example
    Doe
    Description
    Optional. Address owner's last name. Maximum field length = 40 characters.
  - emailAddressstring
    Example
    [email protected]
    Description
    Optional. User's supplied email address. Maximum field length = 100 characters.
  - phonestring
    Example
    2128387654
    Description
    Optional. User's supplied phone number. Maximum field length = 25 characters.
    
    Note: Do not include country prefix.
  - phoneCountryCodestring
    Example
    123
    Description
    Optional. Country prefix associated with the phone number.
    
    Note: Do not include the + symbol.
  - address1string
    Example
    123 Main Street
    Description
    Optional. Address line one of the address that belongs to the account. Maximum field length = 40 characters.
  - address2string
    Example
    Apartment 456
    Description
    Optional. Address line two of the address that belongs to the account. Maximum field length = 40 characters.
  - citystring
    Example
    Itasca
    Description
    Optional. Address city. Maximum field length = 40 characters.
  - regionstring
    Example
    IL
    Description
    Optional. ISO 3166-2 state, province, or region code. Minimum field length = 1 character. Maximum field length = 3 characters.
    
    Note: For US and Canada, must be state or province.
  - postCodestring
    Example
    60143-0001
    Description
    Optional. Address postal code. Maximum field length = 20 characters.
    
    Note: If you send the 9-digit extended postal code for U.S. addresses, you must include a hyphen to separate the last 4 digits from the first 5.
  - countrystring
    Example
    US
    Description
    Optional. Two-letter ISO code for country formatted in ISO 3166-1.
  - companyNamestring
    Example
    Accertify, Inc
    Description
    Optional. Company name associated with the address. Maximum field length = 50 characters.
  - locationTypestring<business | redirect | residence | siteToStore | other>
    Description
    Optional. Address location type.
    
    Options are:
    
    business
    
    redirect
    
    residence
    
    siteToStore
    
    other
    Allowed
    businessredirectresidencesiteToStoreother
  - addressCreatedDateTimestring<date-time>
    Example
    2020-03-28T17:07:24-07:00
    Description
    Optional. The date the address was created formatted yyyy-MM-dd'T'HH:mm
    .
    Format
    date-time
  - addressUpdatedDateTimestring<date-time>
    Example
    2021-03-28T17:07:24-07:00
    Description
    Optional. The date the address was updated formatted yyyy-MM-dd'T'HH:mm
    .
    Format
    date-time