Zoey REST API reference · Interactive version: apidocs.zoey.com

Orders

Orders: Address

Get

GET https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses

Update

PUT https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses/:addressType

Order Address Update API

Update a billing or shipping address on an existing order.

Endpoint

PUT /api/rest/orders/:order_id/addresses/:address_type
Parameter Description
order_id The numeric order ID
address_type billing or shipping

Request Headers

Header Value
Content-Type application/json
Accept application/json

Request Body

All fields are optional — only include what you want to update.

Field Type Description
firstname string First name
lastname string Last name
middlename string Middle name
prefix string Name prefix
suffix string Name suffix
company string Company name
street string or array Street lines. Pass as an array for multi-line (["123 Main St", "Apt 2E"]) or a single string
city string City
region string State/region name or code (e.g. "New York" or "NY"). Automatically resolves to the correct region_id.
region_id integer Region ID. Use instead of region if you already have the ID.
postcode string ZIP / postal code
country_id string Two-letter country code (e.g. "US")
telephone string Phone number
email string Email address
vat_id string VAT number
destination_type string Destination type
zoey_shipping_type string Zoey shipping type

Example Request

{
    "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",
}

Responses

Status Meaning
200 OK Address updated successfully
400 Bad Request Invalid or missing data
404 Not Found Order or address type not found
500 Internal Server Error Unexpected error during save

Notes

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 Billing

GET https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses/billing

Get Shipping

GET https://container-url.zoeysite.com/api/rest/orders/:orderId/addresses/shipping