Locations

List locations

Requires locations:read. Lists all active fulfillment locations for the store, including child locations, without pagination. When none exist, data is an empty array. Use a returned ID as fulfillment_orders[].location_id when creating an order. Addresses are outbound shipping addresses, not return addresses.

get/api/external/v1/locations

Request

  • Base URL: http://localhost
  • URL: http://localhost/api/external/v1/locations
  • Auth: HTTP bearer

Response

Example response

{
  "data": [
    {
      "id": "loc_x7Kq9",
      "name": "Main warehouse",
      "contact_name": "Warehouse reception",
      "type": "WAREHOUSE",
      "opening_hours": null,
      "address": {
        "company": "Acme AB",
        "address1": "Warehouse Road 10",
        "address2": null,
        "postal_code": "41502",
        "city": "Göteborg",
        "state": null,
        "country": "SE",
        "phone": null,
        "email": null,
        "latitude": 57.7089,
        "longitude": 11.9746
      }
    }
  ]
}

Changes

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