List rewards

GET/v1/rewards

Returns the rewards catalog: every points reward. It is the same for every member. To know what a member can use on a specific cart, call preview; to see rewards a member already holds, read their wallet.

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.

Response fields#

Returns 200 with list of Reward

dataarray of Reward
Show attributesReward
- idstring (uuid)
  Send this as reward_id on previews and redemptions.
- namestring
  For example Free drip coffee.
- descriptionstring
  Short text for the guest.
- image_urlstring (uri)Nullable
  HTTPS image URL.
- kindstring
  points (catalog) or wallet (given to one member). May grow.
  One of points, wallet
- points_costinteger
  Points the reward costs. Only on points rewards; wallet rewards don't have it.
- discountDiscount
  Show attributesDiscount
  - typestring
    One of amount, percent, free_item, bogo
  - amount_centsinteger
    For amount.
  - percentnumber
    For percent.
  - itemsarray of object
    Item scope, by Square variation id.
    Show attributesHide attributes
    pos_item_idstring
    namestring
  - categoriesarray of object
    Category scope.
    Show attributesHide attributes
    pos_category_idstring
    namestring
  - max_itemsinteger
- rulesRules
  Show attributesRules
  - min_subtotal_centsinteger
    Integer cents.
    Min 0
  - channelsarray of string
    One of app, web
  - location_idsarray of string (uuid)
  - fulfillmentarray of string
    One of pickup, delivery, curbside, dine_in
  - available_timesarray of AvailableTime
    Show attributesAvailableTime
    daysarray of string
    Show valuesHide values
    mon
    tue
    wed
    thu
    fri
    sat
    sun
    startstring
    Local time, HH:MM.
    endstring
    Local time, HH:MM.
  - tier_idsarray of string (uuid)
- starts_atstring (date-time)Nullable
  When the reward becomes available. null means it already is.
- ends_atstring (date-time)Nullable
  When it stops being available. null means no end date.
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/rewards

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

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/rewards`, {
  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']}/rewards",
    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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50{
  "data": [
    {
      "id": "9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98",
      "name": "Free drip coffee",
      "description": "One 12 oz drip coffee.",
      "image_url": "https://cdn.unplugdining.com/rewards/9a6e3d21.jpg",
      "kind": "points",
      "points_cost": 500,
      "discount": {
        "type": "free_item",
        "items": [ { "pos_item_id": "3NZQ7XKJ2Y5PLVKCW6RQ4G2T", "name": "Drip coffee" } ],
        "max_items": 1
      },
      "rules": { "min_subtotal_cents": 0, "channels": [], "location_ids": [], "fulfillment": [], "available_times": [], "tier_ids": [] },
      "starts_at": null,
      "ends_at": null
    },
    {
      "id": "5e8b1f4c-2d9a-4b6e-8c3f-7a0d2e9b1c65",
      "name": "Free pastry",
      "description": "Any pastry from the case.",
      "image_url": "https://cdn.unplugdining.com/rewards/5e8b1f4c.jpg",
      "kind": "points",
      "points_cost": 700,
      "discount": {
        "type": "free_item",
        "categories": [ { "pos_category_id": "P9MT2XQ6KZR4WLN8HCB3J7VD", "name": "Pastries" } ],
        "max_items": 1
      },
      "rules": { "min_subtotal_cents": 0, "channels": [], "location_ids": [], "fulfillment": [], "available_times": [], "tier_ids": [] },
      "starts_at": null,
      "ends_at": null
    },
    {
      "id": "b3d7a9e2-6f1c-4a8d-9e5b-2c4f7a1d3e86",
      "name": "$5 off",
      "description": "On orders of $5 or more.",
      "image_url": "https://cdn.unplugdining.com/rewards/b3d7a9e2.jpg",
      "kind": "points",
      "points_cost": 900,
      "discount": { "type": "amount", "amount_cents": 500 },
      "rules": { "min_subtotal_cents": 500, "channels": ["app", "web"], "location_ids": [], "fulfillment": [], "available_times": [], "tier_ids": [] },
      "starts_at": null,
      "ends_at": null
    }
  ],
  "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."
}