GET /locations

Per physical restaurant location, there will be a Location. This endpoint can be used to query them. You can have to specify an account, otherwise the locations of your own account will be returned

Query parameters

  • where string

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Server string
    • Date string
    • Content-Type string
    • Content-Length integer
    • Connection string
    • X-Total-Count integer
    • Cache-Control string
    • Expires string
    • Last-Modified string
    • Access-Control-Allow-Origin string
    • Access-Control-Allow-Headers string
    • Access-Control-Allow-Methods string
    • Access-Control-Allow-Credentials boolean
GET /locations
curl \
 --request GET 'https://api.staging.deliverect.com/locations' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "_meta": {
    "page": 1,
    "total": 1,
    "max_results": 25
  },
  "_items": [
    {
      "_id": "5c1a40f6c6489f00bac4c252",
      "name": "Partner Jelte",
      "_etag": "ad515c7db898b7004253d8ea46d07a3b7e0cbd99",
      "users": [
        "5c2496cbc6489f00169462a3"
      ],
      "_links": {
        "self": {
          "href": "accounts/5c1a40f6c6489f00bac4c252",
          "title": "accounts"
        }
      },
      "_created": "2018-12-19T13:00:38.000000Z",
      "_deleted": false,
      "_updated": "2019-02-14T13:57:59.000000Z",
      "accounts": [
        {
          "_id": "5c3f8a90c6489f002c85dd3d",
          "name": "Gastrofixies",
          "_etag": "56f924441a4de194e96f3d9f6ebc962b7a8d524c",
          "_created": "2019-01-16T19:48:32.000000Z",
          "_deleted": false,
          "_updated": "2019-01-16T19:49:37.000000Z",
          "locations": [
            {
              "_id": "5c3f8ad1c6489f002c85dd3e",
              "name": "Gastro gefixed (10905)",
              "_etag": "11b454d7423e292c4455c5c142ebc12d2563f8ea",
              "account": "5c3f8a90c6489f002c85dd3d",
              "_created": "2019-01-16T19:49:37.000000Z",
              "_deleted": false,
              "_updated": "2019-01-28T12:19:19.000000Z",
              "channelLinks": [
                "5c3f8aeac6489f002c85dd41",
                "5c4ef347c6489f0001594856"
              ]
            }
          ],
          "accountType": 2
        }
      ],
      "locations": [
        "5c1a4117c6489f00bac4c253",
        "5c20ea48c6489f0016a132f7",
        "5c20f1cec6489f0035972273",
        "5c6573e7c6489f00014c507c"
      ],
      "accountType": 1
    }
  ],
  "_links": {
    "self": {
      "href": "accounts",
      "title": "accounts"
    },
    "parent": {
      "href": "/",
      "title": "home"
    }
  }
}
{
  "_meta": {
    "page": 1,
    "total": 4,
    "max_results": 25
  },
  "_items": [
    {
      "_id": "5bf02f38c6489f002c******",
      "name": "Test location 1",
      "_etag": "ef043a0519e16ba48d7b4b2f5af928c9324760e0",
      "_links": {
        "self": {
          "href": "locations/5bf02f38c6489f002c******",
          "title": "Locations"
        }
      },
      "status": "INTEGRATOR",
      "account": "5be9c971c6489f0029******",
      "_created": "2018-11-17T15:09:44.000000Z",
      "_deleted": false,
      "_updated": "2019-02-14T11:16:20.000000Z",
      "channelLinks": [
        "5bf02f38c6489f002******1",
        "5bf02f38c6489f002******2"
      ]
    },
    {
      "_id": "5bf02f38c6489f002c******",
      "name": "Test Location 2",
      "_etag": "c9a39040acd03086bcd9abfd00af7acb5c5e748f",
      "_links": {
        "self": {
          "href": "locations/5bf02f38c6489f002c******",
          "title": "Locations"
        }
      },
      "status": "INTEGRATOR",
      "account": "5be9c971c6489f0029******",
      "_created": "2018-11-17T15:09:44.000000Z",
      "_deleted": false,
      "_updated": "2019-01-16T17:30:40.000000Z",
      "channelLinks": [
        "5bf02f38c6489f002******1"
      ]
    }
  ],
  "_links": {
    "self": {
      "href": "locations?where={account: {{accountId}}}",
      "title": "locations"
    },
    "parent": {
      "href": "/",
      "title": "home"
    }
  }
}