Zoey REST API reference ยท Interactive version: apidocs.zoey.com

Accounts

Accounts: Addresses

Get All

GET https://container-url.zoeysite.com/api/rest/companyAccounts/locationAddresses?location_id=1

Query parameters:

NameExampleNotes
location_id1ID of location to fetch info. ( Required )

Example response (Get All), HTTP 200:

[
    {
        "address_id": "1",
        "city": "NEW YORK",
        "company": null,
        "country_id": "US",
        "customer_address_id": null,
        "email": null,
        "fax": null,
        "firstname": "Zoey",
        "is_default_billing": "1",
        "is_default_shipping": "0",
        "lastname": "Dev",
        "middlename": null,
        "postcode": "10019",
        "prefix": null,
        "region": "New York",
        "region_id": "43",
        "street": [
            "123 Main St."
        ],
        "suffix": null,
        "telephone": "(555) 555-5555",
        "vat_id": null,
        "zoey_shipping_type": "0"
    },
    {
        "address_id": "2",
        "city": "NEW YORK",
        "company": null,
        "country_id": "US",
        "customer_address_id": null,
        "email": null,
        "fax": null,
        "firstname": "Zoey",
        "is_default_billing": "0",
        "is_default_shipping": "1",
        "lastname": "Dev",
        "middlename": null,
        "postcode": "10019",
        "prefix": null,
        "region": "New York",
        "region_id": "43",
        "street": [
            "123 Main St."
        ],
        "suffix": null,
        "telephone": "(555) 555-5555",
        "vat_id": null,
        "zoey_shipping_type": "0"
    },
    {
        "address_id": "3",
        "city": "NEW YORK",
        "company": null,
        "country_id": "US",
        "customer_address_id": null,
        "email": null,
        "fax": null,
        "firstname": "Zoey",
        "is_default_billing": "0",
        "is_default_shipping": "0",
        "lastname": "Dev",
        "middlename": null,
        "postcode": "10019",
        "prefix": null,
        "region": "New York",
        "region_id": "43",
        "street": [
            "123 Main St."
        ],
        "suffix": null,
        "telephone": "(555) 555-5555",
        "vat_id": null,
        "zoey_shipping_type": "0"
    }
]