v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Customers

Create customer address

Add new customer address

post/customers/{customer_id}/addresses

Request body

fnamestring required

Address first name.

lnamestring required

Address last name.

organizationstring

Address organization.

address1string required

Address line 1.

address2string

Address line 2.

citystring required

Address city.

countrystring required

Address country code, 2 letters (example : US).

statestring

Address state. Required when customers address billing ID is empty and bill_county is US or CA.

zipcodestring required

Address zipcode.

make_defaultboolean

Pass as true to update the address on recurring and pending orders.

ordersinteger[]

Pass an array of order ids to update.

address_type'shipping' | 'billing' | 'both'

Define which address to update or both. Updating the shipping address on an order will also update any pending shipments associated with the order. Required when passing make_default or orders.

Response

customer_address_idinteger

fnamestring

lnamestring

organizationstring

address1string

address2string

citystring

countrystring

statestring

zipcodestring

address_validboolean

date_createdstring date-time

date_modifiedstring date-time

created_byinteger

modified_byinteger

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}