Get Customer Location

GET /customers/{customer_id}/locations/{customer_location_id}

Get customer location by id.

Roles

Users with the following roles may access this endoint:

Admin
CrmUser
Dispatcher
Driver
ThirdPartyAdmin
ThirdPartyCrmUser
ThirdPartyDispatcher
ThirdPartyDriver

Request

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

Path Parameters

customer_id Integer, Required

Customer identifier.


customer_location_id Integer, Required

Customer location 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-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.

Accept String

Mime type (e.g. application/json).

  • At least 1 and no more than 256 characters.

x-request-id String

Request identifier.

  • Valid UUID.

Response Body

Refer to DispatchCustomerLocationModel 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.

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 --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}/locations/{customer_location_id}