Zoey REST API reference · Interactive version: apidocs.zoey.com
GET https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses
PUT https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses/:addressType
Update a billing or shipping address on an existing order.
PUT /api/rest/orders/:order_id/addresses/:address_type
All fields are optional — only include what you want to update.
{
"firstname": "John",
"lastname": "Smith",
"street": ["123 Main Street", "Apartment 2E"],
"city": "New York",
"region": "New York",
"postcode": "10001",
"country_id": "US",
"telephone": "555-555-5555",
"vat_id": "",
"destination_type": "",
"zoey_shipping_type": "1",
}
region accepts either the full state name or the two-letter code and will automatically resolve the correct region_id.region and region_id are omitted, the existing values are preserved.Example request body:
{
"firstname": "John",
"lastname": "Smith",
"street": [
"123 Main Street",
"Apartment 5E"
],
"city": "New York",
"region_id": 43,
"postcode": "10001",
"country_id": "US",
"telephone": "555-555-5555",
"vat_id": "90-82345",
"address_valid": "EXACT_MATCH",
"destination_type": "23452345",
"zoey_shipping_type": "1",
"zoey_company_address_at_account_address_text_nr": "2345234",
"zoey_company_address_at_sales_rep": "119",
"zoey_company_address_external_id": "asdf2345234asdf"
}
GET https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses/billing
GET https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses/shipping