Get Customer
GET /locations/{location_id}/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
2021/04/07
200Response Body- DispatchCustomerLocationModel
customer_idwas renamed toid.
- DispatchCustomerLocationModel
Request
- Sample Request
- Sample Response
GET /locations/{location_id}/customers/{customer_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Allow: GET
Content-Length: 1031
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:38:30 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: f78b6187-9be7-46d2-ab61-9647dacd4e24
{
"account_number_1": null,
"account_number_2": null,
"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.867000",
"customer_id": 1,
"is_active": true,
"is_commercial": false,
"last_updated_on": "2020-04-22T17:23:17.363000",
"location_id": 1,
"name": "George Jones!!!?",
"note": "Exempt from billing???",
"parent_id": null,
"reference_number": null,
"renewal_date": null,
"sales_rep": "Shane",
"sales_rep_id": null,
"suspension_id": null
}
Path Parameters
customer_id Integer, Required
Customer identifier.
location_id Integer, Required
Location identifier.
Query Parameters
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
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 DispatchCustomerLocationModel for more details.
account_number_1 String
Customer account number.
- At least 0 and no more than 128 characters.
account_number_2 String
Customer account number.
- At least 0 and no more than 128 characters.
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.
customer_id Integer
Customer identifier.
is_active Boolean
Records marked inactive are treated as deleted (soft delete).
- One of 0, 1, True, False (case insensitive).
is_commercial Boolean, Conditional
Commercial address if true, private if false.
- One of 0, 1, True, False (case insensitive).
last_updated_on String
- Date occurring in the past in an ISO 8601 compatible format.
location_id Integer
Location identifier.
name String
Name (free text).
- At least 1 and no more than 64 characters.
note String, Conditional
Notes (free text).
- At least 0 and no more than 2048 characters.
parent_id Integer
Parent record identifier.
reference_number String, Conditional
Reference number (free text).
- At least 1 and no more than 256 characters.
renewal_date String
Renewal date.
- Date in an ISO 8601 format.
sales_rep String, Conditional
Name of sales representative.
- At least 1 and no more than 64 characters.
sales_rep_id String, Conditional
Sales rep identifier.
suspension_id Integer, Conditional
Suspension identifier.
Code Samples
- cURL
- Python
- CSharp 2.0
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/locations/{location_id}/customers/{customer_id}
import requests, json
response = requests.get(
'http://localhost:8003/locations/{location_id}/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)
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 = "/locations/{location_id}/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);
}
}
}