GET /locations
Bearer auth

Deliverect creates a location for each physical Retailer location. A customer can therefore have multiple locations. This endpoint allows you to query all locations belonging to a specific account.

Query parameters

  • where string

Responses

  • 200 application/json

    OK
  • 401 application/json

    UNAUTHORIZED
GET /locations 
curl \
 --request GET 'https://api.staging.deliverect.com/locations' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "_items": [
    {
      "_id": "5bf02f38c6489f002c******",
      "_created": "2018-11-17T15:09:44.000000Z",
      "_updated": "2019-02-14T11:16:20.000000Z",
      "_etag": "ef043a0519e16ba48d7b4b2f5af928c9324760e0",
      "name": "Test location 1",
      "status": "INTEGRATOR",
      "channelLinks": [
        "5bf02f38c6489f002******1",
        "5bf02f38c6489f002******2"
      ],
      "account": "5be9c971c6489f0029******",
      "_deleted": false,
      "_links": {
        "self": {
          "title": "Locations",
          "href": "locations/5bf02f38c6489f002c******"
        }
      }
    },
    {
      "_id": "5bf02f38c6489f002c******",
      "_created": "2018-11-17T15:09:44.000000Z",
      "_updated": "2019-01-16T17:30:40.000000Z",
      "_etag": "c9a39040acd03086bcd9abfd00af7acb5c5e748f",
      "name": "Test Location 2",
      "status": "INTEGRATOR",
      "channelLinks": [
        "5bf02f38c6489f002******1"
      ],
      "account": "5be9c971c6489f0029******",
      "_deleted": false,
      "_links": {
        "self": {
          "title": "Locations",
          "href": "locations/5bf02f38c6489f002c******"
        }
      }
    }
  ],
  "_links": {
    "parent": {
      "title": "home",
      "href": "/"
    },
    "self": {
      "title": "locations",
      "href": "locations?where={\"account\": \"5be9c971c6489f00297746d4\"}"
    }
  },
  "_meta": {
    "page": 1,
    "max_results": 25,
    "total": 4
  }
}
Response examples (401) 
{
  "_status": "ERR",
  "_error": {
    "code": 401,
    "message": "Please provide proper credentials"
  }
}