Get a reward

GET/v1/rewards/{id}

Returns one reward from the catalog.

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

Guide

Points and rewards

Path parameters#

idstring (uuid)Required
The reward id.

Response fields#

Returns 200 with Reward

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.

GET/v1/rewards/{id}

1
2curl $UNPLUG_API/rewards/9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98 \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/rewards/9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98`, {
  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/9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98",
    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{
  "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
}

Error descriptions#

404Not found

reward_not_found

No reward with this id in your brand.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#reward_not_found",
  "title": "Not found",
  "status": 404,
  "code": "reward_not_found",
  "detail": "No reward with this id in your brand."
}