API / Location
Use case / Master data sync

Get Location

Changed on

Fetches a location.

get/v1/locations/location/{location_id}

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/locations/location/{location_id}
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Path parameters

location_idstring uuid required

Response

Successful Response

latitudenumber nullable

Latitude of the location.

longitudenumber nullable

Longitude of the location.

descriptionstring nullable

Free-text description of the location.

selectable_on_customer_portalboolean nullable

Whether the location can be selected on the customer portal.

codestring nullable

Technical code for integrations/mapping logic; should be treated as stable once set.

display_namestring nullable

Human-readable label for a location in operational views.

external_idstring nullable

Identifier from an external (master data) system.

addressstring nullable

First address line of the location

address_second_linestring nullable

Second address line of the location

citystring nullable

City of the location

statestring nullable

State of the location

countrystring nullable

Country code (ISO 3166-1 alpha-2) of the location

postal_codestring nullable

Postal code of the location

namestring nullable

Name of the location

idstring uuid nullable

Unique identifier of the location.

Example response

{
  "latitude": 51.0543,
  "longitude": 3.7174,
  "code": "LOC123",
  "display_name": "Main Office",
  "address": "Gaston Crommenlaan 4",
  "city": "Ghent",
  "country": "BE",
  "postal_code": "9050",
  "name": "Qargo HQ",
  "opening_hours": {
    "monday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    },
    "tuesday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    },
    "wednesday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    },
    "thursday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    },
    "friday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    },
    "saturday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    },
    "sunday": {
      "intervals": [
        {
          "start_time": "08:00",
          "end_time": "17:30"
        }
      ]
    }
  }
}

Changes

  • 6abdfcd1a541Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status