Get Customer

GET /customers/{customer_id}

Get a customer by id.

Roles

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

Sample Request

GET /customers/{customer_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET,PATCH
Access-Control-Allow-Origin: *
Allow: GET,PATCH
Content-Length: 1859
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:39:18 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: 474cdb8c-461a-4a2f-be39-d01d258eeb86

{
"addresses": [
  {
    "country": null,
    "id": 1,
    "is_active": true,
    "is_billing": true,
    "is_physical": false,
    "is_shipping": false,
    "latitude": 48.080076,
    "line_1": "520 E Washington St",
    "line_2": null,
    "line_3": null,
    "line_4": null,
    "locality": "Sequim",
    "longitude": -123.0952858,
    "postcode": "98382",
    "region": "WA"
  }
],
"contacts": [
  {
    "email": "shaneduty@gmail.com",
    "fax": null,
    "id": 1,
    "name": "George",
    "notify_on_acknowledged_request": false,
    "notify_on_completed_request": true,
    "notify_on_dispatched_request": true,
    "notify_on_failed_request": true,
    "notify_on_new_request": true,
    "number": "360-555-1212"
  }
],
"created_on": "2018-06-13T19:50:20.447000",
"id": 1,
"last_updated_on": "2020-04-22T17:23:17.363000",
"locations": [
  {
    "created_on": "2018-06-13T19:50:20.867000",
    "customer_id": 1,
    "is_active": true,
    "is_commercial": false,
    "location_id": 1,
    "note": "Exempt from billing???",
    "reference_number": null,
    "renewal_date": null,
    "sales_rep": "Shane",
    "sales_rep_id": null,
    "suspension_id": null
  },
  {
    "created_on": "2018-06-13T19:54:16.223000",
    "customer_id": 1,
    "is_active": true,
    "is_commercial": false,
    "location_id": 2,
    "note": "Exempt from billing??",
    "reference_number": null,
    "renewal_date": null,
    "sales_rep": "",
    "sales_rep_id": null,
    "suspension_id": null
  },
  {
    "created_on": "2018-12-13T06:08:47.247000",
    "customer_id": 1,
    "is_active": true,
    "is_commercial": false,
    "location_id": 20,
    "note": "Exempt from billing??",
    "reference_number": null,
    "renewal_date": null,
    "sales_rep": null,
    "sales_rep_id": null,
    "suspension_id": null
  },
  {
    "created_on": "2018-12-13T06:11:32.497000",
    "customer_id": 1,
    "is_active": true,
    "is_commercial": false,
    "location_id": 21,
    "note": "Exempt from billing??",
    "reference_number": null,
    "renewal_date": null,
    "sales_rep": null,
    "sales_rep_id": null,
    "suspension_id": null
  }
],
"name": "George Jones!!!?",
"parent_id": null
}

Path Parameters

customer_id Integer, Required

Customer identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

• Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
• No longer than 256 characters.
• At least 1 characters long.

---

x-api-version String, Optional

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-request-id String

Request identifier.

• Valid UUID.

Response Body

Refer to CustomerModel for more details.

addresses Array[CustomerAddressModel]

Refer to CustomerAddressModel.

---

contacts Array[CustomerContactModel]

Refer to CustomerContactModel.

---

created_on String

Timestamp of creation (must be in past).

• Date occurring in the past in an ISO 8601 compatible format.

---

id Integer

Customer identifier.

---

last_updated_on String

• Date occurring in the past in an ISO 8601 compatible format.

---

locations Array[DispatchCustomerSettingsModel]

Refer to DispatchCustomerSettingsModel.

---

name String

Name (free text).

• At least 1 and no more than 64 characters.

---

parent_id Integer

Parent record identifier.

Code Samples

cURL

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/customers/{customer_id}

Python

import requests, json

response = requests.get(
  'http://localhost:8003/customers/{customer_id}',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json',
    'x-tenant-id': '{your-tenant-id}'
  },
  parameters={
  }
)
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/customers/{customer_id}";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        string json = client.DownloadString(url);
        Console.WriteLine(json);
    }
}
}