List codes in a batch Coming soon

GET/v1/offers/{id}/code_batches/{batch_id}/codes

Returns the codes and their status. Send Accept: text/csv for the whole batch as one CSV file, or page through JSON with limit and cursor. The batch must be ready.

holiday-codes.csv

1
2
3
4code,status,used_at,order_id
HOLIDAY-7K2P9Q,available,,
HOLIDAY-M4XW8T,used,2026-12-02T15:41:09Z,d27a6c90-5e3b-4f18-b9a4-6c0e81f2d375
HOLIDAY-3RZB6N,available,,

A code's status is available, reserved (held by a checkout), used or void.

Permissions: Secret key with offers:write.

Guide

Run offers from your server

Path parameters#

idstring (uuid)Required
batch_idstring (uuid)Required

Query parameters#

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

Response fields#

Returns 200 with list of PromoCode

dataarray of PromoCode
Show attributesPromoCode
- codestring
- statusstring
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/offers/{id}/code_batches/{batch_id}/codes

1
2
3
4curl https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches/f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094/codes \
  -H "Authorization: Bearer $UNPLUG_KEY" \
  -H "Accept: text/csv" \
  -o holiday-codes.csv

1
2
3
4
5
6
7
8
9import { writeFile } from "node:fs/promises";

const response = await fetch("https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches/f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094/codes", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
    Accept: "text/csv",
  },
});
await writeFile("holiday-codes.csv", await response.text());

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

response = requests.get(
    "https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches/f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094/codes",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
        "Accept": "text/csv",
    },
)
with open("holiday-codes.csv", "wb") as f:
    f.write(response.content)

JSON response200

1
2
3
4
5
6
7
8{
  "data": [
    { "code": "HOLIDAY-7K2P9Q", "status": "available", "used_at": null, "order_id": null },
    { "code": "HOLIDAY-M4XW8T", "status": "used", "used_at": "2026-12-02T15:41:09Z", "order_id": "d27a6c90-5e3b-4f18-b9a4-6c0e81f2d375" }
  ],
  "has_more": true,
  "next_cursor": "Y29kZV8wMDAwMg"
}

Error descriptions#

404Not found

not_found

No such offer or batch.

409Conflict

invalid_state

The batch is still generating. Try again in a few seconds.

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#not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No such offer or batch."
}