Get Location

GET /locations/{location_id}

Get location configuration.

Roles

Users with the following roles may access this endoint:

Admin
CrmUser
Dispatcher
Driver
ThirdPartyAdmin
ThirdPartyCrmUser
ThirdPartyDispatcher
ThirdPartyDriver

Request

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

Path Parameters

location_id Integer, Required

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 LocationModel for more details.

address Object

LocationAddressModel

Location address profile.


allow_new_asset_numbers Boolean

Allow input of new asset numbers.

  • One of 0, 1, True, False (case insensitive).

asset_number_required Boolean

Require assets to have numbers.

  • One of 0, 1, True, False (case insensitive).

auto_billing_setup Boolean

Automatically open billing when a customer is created through the CC.

  • One of 0, 1, True, False (case insensitive).

auto_complete_dumps Boolean

Automatically complete dump jobs.

  • One of 0, 1, True, False (case insensitive).

auto_rollover_enabled Boolean

Automatically move pending jobs scheduled for a date in the past to the current date.

  • One of 0, 1, True, False (case insensitive).

bar_code_type String

(deprecated) Set to any value to enable barcode scanning.

  • At least 1 and no more than 64 characters.

billing_accounts_global Boolean

Share billing accounts between locations.

  • One of 0, 1, True, False (case insensitive).

contact Object

LocationContactModel

Location contact profile.


delivery_hidden Boolean

Hide delivery job type in user interfaces, except for existing delivery jobs (job type 'L').

  • One of 0, 1, True, False (case insensitive).

delivery_name String

Name used in the UI which replaces the word 'Delivery' for job types (job type 'L').

  • At least 1 and no more than 12 characters.

distance_factor Float

Conversion factor to get from kilometers to the desired distance unit of measurement

  • Greater than or equal to 0.0.

distance_label String

Distance unit of measurement

  • At least 0 and no more than 20 characters.

do_share_drivers Boolean

Share drivers between locations

  • One of 0, 1, True, False (case insensitive).

driver_self_assignment Boolean

Driver can self assign.

  • One of 0, 1, True, False (case insensitive).

dropoff_hidden Boolean

Hide dropoff job type in user interfaces, except for existing delivery jobs (job type 'D').

  • One of 0, 1, True, False (case insensitive).

dropoff_name String

Name used in the UI which replaces the word 'Dropoff' for job types (job type 'D').

  • At least 1 and no more than 12 characters.

dtt_enabled Boolean

Enables the Daily Truck Timeline.

  • One of 0, 1, True, False (case insensitive).

exchange_hidden Boolean

Hide exchange job type in user interfaces, except for existing exchange jobs (job type 'E').

  • One of 0, 1, True, False (case insensitive).

exchange_name String

Name used in the UI which replaces the word 'Exchange' for job types (job type 'E').

  • At least 1 and no more than 12 characters.

id Integer

Location identifier.


is_active Boolean

Records marked inactive are treated as deleted (soft delete).

  • One of 0, 1, True, False (case insensitive).

leed_enabled Boolean

Enable LEED features.

  • One of 0, 1, True, False (case insensitive).

main_inventory_name String

Name of the location's main inventory.

  • At least 0 and no more than 64 characters.

name String

Name for a location.

  • At least 1 and no more than 64 characters.

notify_on_acknowledged_job Boolean

Send email notification to the location's contact when a job is acknowledged.

  • One of 0, 1, True, False (case insensitive).

notify_on_completed_job Boolean

Send email notification to the location's contact when a job is completed.

  • One of 0, 1, True, False (case insensitive).

notify_on_dispatched_job Boolean

Send email notification to the location's contact when a job is dispatched.

  • One of 0, 1, True, False (case insensitive).

notify_on_failed_job Boolean

Send email notification to the location's contact when a job is failed.

  • One of 0, 1, True, False (case insensitive).

pickup_hidden Boolean

Hide pickup job type in user interfaces, except for existing pickup jobs (job type 'P').

  • One of 0, 1, True, False (case insensitive).

pickup_name String

Name used in the UI which replaces the word 'Pickup' for job types (job type 'P').

  • At least 1 and no more than 12 characters.

require_reason_fail_delay Boolean

Require drivers to input the reason that a job was failed or delayed

  • One of 0, 1, True, False (case insensitive).

require_reference_number Boolean

Require reference numbers when creating or editing jobs.

  • One of 0, 1, True, False (case insensitive).

require_signature Boolean

Require drivers to collect signatures when completing jobs.

  • One of 0, 1, True, False (case insensitive).

service_disclaimer String

Service disclaimer text presented to customers when drivers acquire signatures.

  • At least 0 and no more than 10485760 characters.

service_hidden Boolean

Hide service job type in user interfaces, except for existing service jobs (job type 'R').

  • One of 0, 1, True, False (case insensitive).

service_name String

Name used in the UI which replaces the word 'Service' for job types (job type 'R').

  • At least 1 and no more than 12 characters.

use_additional_items Boolean

Use additional items.

  • One of 0, 1, True, False (case insensitive).

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