Skip to content

Create Location

Request

Create a new location.

Security
oAuth2ClientCredentials
Bodyapplication/jsonrequired
latitudenumber or null(Latitude)
Any of:

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

number
longitudenumber or null(Longitude)
Any of:

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

number
descriptionstring or null(Description)
Any of:

Free-text description of the location.

string
selectable_on_customer_portalboolean or null(Selectable On Customer Portal)
Any of:

Whether the location can be selected on the customer portal.

boolean
codestring or null(Code)
Any of:

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

string
display_namestring or null(Display Name)
Any of:

Human-readable label for a location in operational views.

string
external_idstring or null(External Id)
Any of:

Identifier from an external (master data) system.

string
addressstring or null(Address)
Any of:

First address line of the location

string
address_second_linestring or null(Address Second Line)
Any of:

Second address line of the location

string
citystring or null(City)
Any of:

City of the location

string
statestring or null(State)
Any of:

State of the location

string
countrystring(Country)required

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

postal_codestring or null(Postal Code)
Any of:

Postal code of the location

string
namestring(Name)required

Name of the location.

opening_hoursWeekScheduleInput (object) or null
Any of:

Weekly opening hours for all seven days. Replaces the full schedule when provided.

POST
/v1/locations/location
{
  "latitude": 51.0543,
  "longitude": 3.7174,
  "description": "string",
  "selectable_on_customer_portal": true,
  "code": "LOC123",
  "display_name": "Main Office",
  "external_id": "string",
  "address": "Gaston Crommenlaan 4",
  "address_second_line": "",
  "city": "Ghent",
  "state": "",
  "country": "BE",
  "postal_code": "9050",
  "name": "Ghent Warehouse",
  "opening_hours": {
    "monday": { … },
    "tuesday": { … },
    "wednesday": { … },
    "thursday": { … },
    "friday": { … },
    "saturday": { … },
    "sunday": { … }
  }
}

Responses

Successful Response

Bodyapplication/json
latitudenumber or null(Latitude)
Any of:

Latitude of the location.

number
longitudenumber or null(Longitude)
Any of:

Longitude of the location.

number
descriptionstring or null(Description)
Any of:

Free-text description of the location.

string
selectable_on_customer_portalboolean or null(Selectable On Customer Portal)
Any of:

Whether the location can be selected on the customer portal.

boolean
codestring or null(Code)
Any of:

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

string
display_namestring or null(Display Name)
Any of:

Human-readable label for a location in operational views.

string
external_idstring or null(External Id)
Any of:

Identifier from an external (master data) system.

string
addressstring or null(Address)
Any of:

First address line of the location

string
address_second_linestring or null(Address Second Line)
Any of:

Second address line of the location

string
citystring or null(City)
Any of:

City of the location

string
statestring or null(State)
Any of:

State of the location

string
countrystring or null(Country)
Any of:

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

string
postal_codestring or null(Postal Code)
Any of:

Postal code of the location

string
namestring or null(Name)
Any of:

Name of the location

string
idstring or null(Id)
Any of:

Unique identifier of the location.

string (uuid)
opening_hoursWeekSchedule (object) or null
Any of:

Weekly opening hours.

Response
{
  "latitude": 51.0543,
  "longitude": 3.7174,
  "description": "string",
  "selectable_on_customer_portal": true,
  "code": "LOC123",
  "display_name": "Main Office",
  "external_id": "string",
  "address": "Gaston Crommenlaan 4",
  "address_second_line": "",
  "city": "Ghent",
  "state": "",
  "country": "BE",
  "postal_code": "9050",
  "name": "Qargo HQ",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "opening_hours": {
    "monday": { … },
    "tuesday": { … },
    "wednesday": { … },
    "thursday": { … },
    "friday": { … },
    "saturday": { … },
    "sunday": { … }
  }
}