Skip to content

Additional Information

Retrieving supplier locations

Retrieve the list of locations configured for your supplier account. Location IDs are required when creating drivers.

Note

It is not possible to create new locations via the API. Contact your account manager to add or modify locations.

Request

GET /v1/locations

Response

Field Type Description
supplier_location_id String The location ID, used in the supplier_location_ids field when creating or updating a driver.
name String The name of the location (e.g. city, region, country).

HTTP 200 - OK

{
    "supplier_locations": [
        {
            "supplier_location_id": "123",
            "name": "Manchester"
        },
        {
            "supplier_location_id": "456",
            "name": "Liverpool"
        }
    ]
}

HTTP 401 - Unauthorized

HTTP 403 - Forbidden