List locations

GET/v1/locations

Returns every location in your brand, including ones that are not_live. Use it to fill a store picker and to map your own store ids to unPLUG location ids once, on your server.

Permissions: Secret key with program:read, or a member token.

Guide

Points and rewards

Query parameters#

limitinteger
1 to 100. Default 25.
Min 1Max 100Default 25
cursorstring
next_cursor from the previous page. See Pagination.

Response fields#

Returns 200 with list of Location

dataarray of Location
Show attributesLocation
- idstring (uuid)
  Send this as location_id on previews, redemptions and orders.
- namestring
  For example South Congress.
- addressAddress
  line1, line2 (or null), city, region, postal_code, country (ISO 3166-1 alpha-2).
  Show attributesAddress
  - line1string
  - line2stringNullable
  - citystring
  - regionstring
  - postal_codestring
  - countrystring
    ISO 3166-1 alpha-2.
- time_zonestring
  IANA time zone. Reward times and visit days at this location use it.
- posstring
  The location's point of sale. square.
  One of square
- pos_location_idstring
  The Square location id. Match it against your own ordering system's location ids.
- statusstring
  live or not_live. Only offer ordering at live locations.
  One of live, not_live
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/locations

1
2curl $UNPLUG_API/locations \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/locations`, {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    f"{os.environ['UNPLUG_API']}/locations",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24{
  "data": [
    {
      "id": "8d4e2a17-3b9c-4f5e-a6d1-7c0b9e2f4a53",
      "name": "South Congress",
      "address": { "line1": "1412 S Congress Ave", "line2": null, "city": "Austin", "region": "TX", "postal_code": "78704", "country": "US" },
      "time_zone": "America/Chicago",
      "pos": "square",
      "pos_location_id": "LQ7H2XK9M3RTB",
      "status": "live"
    },
    {
      "id": "1c7f9b3e-5a2d-4e8c-b9f0-6d3a2e1c8b74",
      "name": "Riverside",
      "address": { "line1": "2201 E Riverside Dr", "line2": "Suite 110", "city": "Austin", "region": "TX", "postal_code": "78741", "country": "US" },
      "time_zone": "America/Chicago",
      "pos": "square",
      "pos_location_id": "L5VDN8P2WZ4KC",
      "status": "live"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Error descriptions#

400Bad request

invalid_param

limit is outside 1 to 100, or the cursor is not one we issued.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#invalid_param",
  "title": "Bad request",
  "status": 400,
  "code": "invalid_param",
  "detail": "limit is outside 1 to 100, or the cursor is not one we issued."
}