Sign in
API / Location
Use case / Master data sync

Create Location

Create a new location.

post/v1/locations/location

Request body

latitudenumber nullable

Latitude of the location. When omitted on create, the coordinates are geocoded from the address.

longitudenumber nullable

Longitude of the location. When omitted on create, the coordinates are geocoded from the address.

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 required

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

postal_codestring nullable

Postal code of the location

namestring required

Name of the location.

Example request

{
  "latitude": 51.0543,
  "longitude": 3.7174,
  "code": "LOC123",
  "display_name": "Main Office",
  "address": "Gaston Crommenlaan 4",
  "city": "Ghent",
  "country": "BE",
  "postal_code": "9050",
  "name": "Ghent Warehouse",
  "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"
        }
      ]
    }
  }
}

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

No recorded changes to this endpoint across all 1 revision of this API.