Preview an offer Coming soon

POST/v1/offers/{id}/preview

A dry run with no side effects. It checks the offer's rules against your members and their past orders and estimates what the offer will cost. Works on drafts and on published offers.

Permissions: Secret key with offers:write.

Guide

Run offers from your server

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Path parameters#

idstring (uuid)Required

Request body#

Field	Description
`member_ids`array	Up to 500 members you plan to grant to. Leave it out to check all members.

Response fields#

Returns 200 with OfferPreview

eligible_membersinteger
expected_redemptionsinteger
expected_cost_centsinteger
warningsarray of string

POST/v1/offers/{id}/preview

1
2curl -X POST https://api.unplugdining.com/v1/offers/71c3e8a5-4b2d-4f60-a9e1-58d7b0c2f346/preview \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch("https://api.unplugdining.com/v1/offers/71c3e8a5-4b2d-4f60-a9e1-58d7b0c2f346/preview", {
  method: "POST",
  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.post(
    "https://api.unplugdining.com/v1/offers/71c3e8a5-4b2d-4f60-a9e1-58d7b0c2f346/preview",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8{
  "eligible_members": 1840,
  "expected_redemptions": 410,
  "expected_cost_cents": 123000,
  "warnings": [
    "The budget covers 300 redemptions. About 410 are expected, so the offer will stop early."
  ]
}

Error descriptions#

400Bad request

invalid_param

More than 500 member_ids.

404Not found

not_found

No such offer.

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": "More than 500 member_ids."
}