erp
Customers

Get ERP Customer

Changed on

Returns a single Customer for the ERP connection with the associated customer id.

get/erp/customers/{customer_id}

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/erp/customers/{customer_id}
  • Auth
    none required

Path parameters

customer_idstring required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Response

Successful response

Example response

{
  "data": {
    "id": "cust_1",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "customer_number": "CUS0001",
    "name": "Acme Co.",
    "email": "buyer@example.com",
    "phone": "415-555-0142",
    "active": true,
    "billing_address": {
      "full_name": "John Doe",
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States"
    },
    "shipping_address": {
      "full_name": "John Doe",
      "company": "Company",
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States",
      "phone_number": "123-456-7890",
      "email_address": "johndoe@example.com"
    },
    "custom_fields": {
      "custom_field_example": {
        "value": "example_value",
        "type": "string",
        "title": "Example Field"
      }
    },
    "external_system_url": "https://example.com/customer/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-03-15T13:45:30Z",
    "trackstar_updated_date": "2023-03-15T13:45:30Z"
  }
}

Changes