For all operations listed below you will need to provide HTTP Request Header Authorization param. For more details see Login/Auth page.

Get the list of Customers associated with your account

Route: /customer

Method: GET

Example result

{
    "entities": [
        {
            "account": "Customer Account Number",
            "name": "name of the Customer",
            "is_active": "1",
            "physical_street1": "",
            "physical_street2": "",
            "physical_city": "",
            "physical_code": "",
            "physical_state": "",
            "physical_country": "",
            "mailing_street1": "",
            "mailing_street2": "",
            "mailing_city": "",
            "mailing_code": "",
            "mailing_state": "",
            "mailing_country": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "email1": "",
            "email2": "",
            "email3": "",
            "branch_id": "1",
            "import_number": "",
            "export_number": "",
            "vat_number": "",
            "eori": "",
            "customer_group_1_id": "0",
            "customer_group_2_id": "0",
            "customer_invoice_group_id": "0",
            "salesforce_id": "",
            "power_of_attorney": "0",
            "fish_wildlife": "0",
            "bond": "0",
            "consent_to_scan": "0",
            "sales_rep_id": "0",
            "ksmsid": "",
            "communication_digest": "0",
            "communication_milestone": "0",
            "user_created_id": "0",
            "broker_name": "",
            "broker_street1": "",
            "broker_street2": "",
            "broker_code": "",
            "broker_city": "",
            "broker_country": "",
            "broker_tel1": "",
            "broker_tel2": "",
            "broker_fax": "",
            "commodity": "",
            "is_active_note": "0",
            "create_method": "0",
            "reference_required": "0",
            "show_customer_notes": "0",
            "currency": "",
            "pp_id": "",
            "id": "",
            "created_at": "",
            "updated_at": "",
            "broker_state": "",
            "locale": "",
            "invoice_by_cost_center": "0",
            "auto_consolidate_invoice": "0",
            "finance_query_email": "",
            "is_intercompany": "0",
            "financial_comments": "",
            "invoice_auto_creation": "0",
            "auto_invoice_to_contact": "0",
            "auto_invoice_to_default": "0",
            "invoice_target_email": "",
            "is_person": "0",
            "branch_name": "New York",
            "customer_group_1_name": null,
            "customer_group_2_name": null,
            "customer_invoice_group_name": null,
            "sales_rep_name": null
        },
        {
            ...
        }
        ...
    "total": 123,
    "result": true
}

Get customer by internal ID

Route: /customer/{internal_id}

Method: GET

Example result

{
    "entity": {
        "account": "Customer Account Number",
        "name": "name of the Customer",
        "is_active": "1",
        "physical_street1": "",
        "physical_street2": "",
        "physical_city": "",
        "physical_code": "",
        "physical_state": "",
        "physical_country": "",
        "mailing_street1": "",
        "mailing_street2": "",
        "mailing_city": "",
        "mailing_code": "",
        "mailing_state": "",
        "mailing_country": "",
        ...
        rest of the fields
    },
    "result": true
}