Data models

Every object the Management API returns and every request body it accepts, field by field. Each model links to the endpoints that use it. The same models are in openapi-management.yaml, so you can generate types from them.

Fields marked required are always present in responses and must be sent in requests. nullable fields can be null.

Common#

Problem#

RFC 9457 problem details, served as application/problem+json.

typestring (uri)Required
Link to the docs for this error.
titlestringRequired
statusintegerRequired
codeErrorCodeRequired
Show valuesHide values
- invalid_request
- invalid_param
- missing_param
- invalid_api_key
- token_expired
- missing_scope
- not_found
- member_not_found
- member_deleted
- external_id_taken
- phone_in_use
- idempotency_key_required
- idempotency_key_reused
- request_in_progress
- rate_limited
- insufficient_points
- reward_not_found
- reward_not_applicable
- reward_expired
- reward_already_used
- code_invalid
- code_expired
- code_limit_reached
- redemption_expired
- redemption_not_reserved
- one_redemption_per_order
- order_already_exists
- refund_exceeds_order
- location_not_found
- challenge_not_joinable
- invalid_state
- internal_error
- service_unavailable
detailstring
A sentence about this occurrence.
paramstringNullable
The request field at fault, when there is one.
order_idstring (uuid)
Only on order_already_exists: the order that was already credited.
request_idstringRequired
Same as the Request-Id header.

ErrorCode#

Machine-readable error code. May grow.

One of invalid_request, invalid_param, missing_param, invalid_api_key, token_expired, missing_scope, not_found, member_not_found, member_deleted, external_id_taken, phone_in_use, idempotency_key_required, idempotency_key_reused, request_in_progress, rate_limited, insufficient_points, reward_not_found, reward_not_applicable, reward_expired, reward_already_used, code_invalid, code_expired, code_limit_reached, redemption_expired, redemption_not_reserved, one_redemption_per_order, order_already_exists, refund_exceeds_order, location_not_found, challenge_not_joinable, invalid_state, internal_error, service_unavailable

CursorList#

Cursor-paginated list. ?limit= (1 to 100, default 25) and ?cursor=.

dataarray of objectRequired
has_morebooleanRequired
True when another page exists.
next_cursorstringRequiredNullable
Pass as cursor to get the next page.

Program and catalog#

TierRef#

idstring (uuid)Required
namestringRequired

Rules#

Empty arrays mean no limit.

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)

Discount#

typestringRequired
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

AvailableTime#

daysarray of string
Show valuesHide values
- mon
- tue
- wed
- thu
- fri
- sat
- sun
startstring
Local time, HH:MM.
endstring
Local time, HH:MM.

Members and tokens#

Member#

Used by

POST/v1/members/{id}/mergeresponse

idstring (uuid)Required
unPLUG's id for the member. Store it next to your user record.
external_idstringNullable
Your id for the guest, up to 128 characters. null for a guest who has only earned at the register and isn't linked to your login yet.
Max Length 128
statusstringRequired
active. The member.deleted webhook carries deleted; after that, calls about the member return 410 member_deleted.
One of active, deleted
first_namestringNullable
last_namestringNullable
emailstring (email)Nullable
Saved in lowercase.
phonestringNullable
E.164, for example +15125550142.
phone_verifiedboolean
true when you confirmed the guest owns the number, for example with an SMS code. Only verified phones link to existing members.
birthdaystring (date)Nullable
YYYY-MM-DD.
points_balanceintegerRequired
Points the member has now. Never below zero.
lifetime_pointsintegerRequired
All points ever earned, used for tiers. Spending doesn't lower it.
tierTierRefRequired
id and name of the current tier.
Show attributesTierRef
- idstring (uuid)Required
- namestringRequired
next_tierobjectNullable
id, name and points_needed (lifetime points still to earn). null at the top tier.
Show attributesHide attributes
- idstring (uuid)
- namestring
- points_neededinteger
communication_preferencesobject
Marketing consent: email_marketing, sms_marketing, push_marketing. See communication preferences.
Show attributesHide attributes
- email_marketingboolean
- sms_marketingboolean
- push_marketingboolean
metadataobject
Your own string values. Up to 20 keys, 500 characters each. Don't put personal data here.
linked_existingboolean
Only on create: true when an existing member was linked by verified phone.
enrolled_atstring (date-time)
When the guest joined the program.
created_atstring (date-time)Required
updated_atstring (date-time)Required

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20{
  "id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
  "external_id": "usr_10482",
  "status": "active",
  "first_name": "Maya",
  "last_name": "Lopez",
  "email": "maya@example.com",
  "phone": "+15125550142",
  "phone_verified": true,
  "birthday": "1994-03-18",
  "points_balance": 420,
  "lifetime_points": 1880,
  "tier": { "id": "2b9e4f7a-1c3d-4e6b-8a5f-9d0c2e7b4a13", "name": "Green" },
  "next_tier": { "id": "6f1a8c3d-9b2e-4d7a-b5c6-3e0f8a1d2b47", "name": "Gold", "points_needed": 120 },
  "communication_preferences": { "email_marketing": true, "sms_marketing": false, "push_marketing": true },
  "metadata": { "favorite_store": "south-congress" },
  "enrolled_at": "2025-06-14T15:02:44Z",
  "created_at": "2025-06-14T15:02:44Z",
  "updated_at": "2026-11-01T16:12:41Z"
}

MergeRequest#

Used by

POST/v1/members/{id}/mergerequest body

source_member_idstring (uuid)Required

Activity and wallet#

ActivityEntry#

Used by

POST/v1/members/{id}/points_adjustmentsresponse

idstring (uuid)Required
typestringRequired
What happened. See the table below. May grow.
One of earn, bonus, redeem, adjust, reverse, expire
pointsintegerRequired
Signed change: 62 for an earn, -500 for a redeem.
balance_afterintegerRequired
The member's points_balance right after this entry.
descriptionstring
A short line you can show the guest, for example Visit at South Congress or Free drip coffee.
order_idstring (uuid)Nullable
The order that caused it, for earn, bonus, redeem and reverse.
reward_idstring (uuid)Nullable
The reward bought, for redeem.
adjustment_reasonstringNullable
For adjust: goodwill, correction, migration or other.
One of goodwill, correction, migration, other
created_atstring (date-time)Required

`type`	Meaning	Sign
`earn`	Points from an order, in your app or at the register.	+
`bonus`	Extra points from a promotion, a birthday or a tier upgrade.	+
`redeem`	Points spent on a reward, when the order is credited.	-
`adjust`	Points added or removed with a points adjustment.	+ or -
`reverse`	Points taken back or returned by a refund.	+ or -
`expire` Coming soon	Points that expired after a period with no activity.	-

Example

1
2
3
4
5
6
7
8
9
10
11{
  "id": "c2e8a4f1-6b3d-4e9a-8c7f-1d5b0e3a9c26",
  "type": "earn",
  "points": 62,
  "balance_after": 420,
  "description": "Visit at South Congress",
  "order_id": "5d9b3e7f-1a4c-4f8e-b2d6-0c7a9e1f3b58",
  "reward_id": null,
  "adjustment_reason": null,
  "created_at": "2026-11-01T16:12:40Z"
}

PointsAdjustmentRequest#

Used by

POST/v1/members/{id}/points_adjustmentsrequest body

pointsintegerRequired
Signed. Negative values never take the balance below zero.
reasonstringRequired
One of goodwill, correction, migration, other
notestring
counts_toward_tierboolean
Default false

Offers#

Offer Coming soon#

Coming soon.

Used by

idstring (uuid)Required
The offer.
namestringRequired
Shown to guests on wallet items and in checkout.
descriptionstring
One or two lines for guests.
statusstringRequired
draft, scheduled, live, paused or ended.
One of draft, scheduled, live, paused, ended
versionintegerRequired
Starts at 1. Goes up each time a scheduled or live offer is edited. Members keep the version they got.
discountDiscountRequired
Same shape as a reward's discount: type is amount (amount_cents), percent (percent), free_item (items or categories, max_items) or bogo.
Show attributesDiscount
- typestringRequired
  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
Same shape as a reward's rules: min_subtotal_cents, channels, location_ids, fulfillment, available_times, tier_ids. Empty lists mean no limit.
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)
distributionstringRequired
granted (lands in the wallet), shared_code (one code for everyone) or unique_codes (single-use codes from batches).
One of granted, shared_code, unique_codes
shared_codestringNullable
The code, for shared_code offers. Otherwise null.
per_member_limitintegerNullable
How many times one member can use the offer. null for no limit.
budgetBudget
max_redemptions and max_discount_cents (either can be null), and the running totals used_redemptions and used_discount_cents. Enforced at checkout.
Show attributesBudget
- max_redemptionsintegerNullable
- max_discount_centsintegerNullable
- used_redemptionsinteger
- used_discount_centsinteger
starts_atstring (date-time)Nullable
When it goes live. null to go live on publish.
ends_atstring (date-time)Nullable
When it ends. null for no end date.
wallet_expiry_daysintegerNullable
For granted offers: days a wallet item lasts after it's granted.
created_bystring
api, dashboard or campaign.
One of api, dashboard, campaign

Example

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{
  "id": "71c3e8a5-4b2d-4f60-a9e1-58d7b0c2f346",
  "name": "$3 off your next order",
  "description": "Any order of $8 or more.",
  "status": "draft",
  "version": 1,
  "discount": {
    "type": "amount",
    "amount_cents": 300
  },
  "rules": {
    "min_subtotal_cents": 800,
    "channels": [
      "app",
      "web"
    ],
    "location_ids": [],
    "fulfillment": [],
    "available_times": [],
    "tier_ids": []
  },
  "distribution": "granted",
  "shared_code": null,
  "per_member_limit": 1,
  "budget": {
    "max_redemptions": 300,
    "max_discount_cents": 90000,
    "used_redemptions": 0,
    "used_discount_cents": 0
  },
  "starts_at": "2026-11-02T06:00:00Z",
  "ends_at": "2026-11-30T06:00:00Z",
  "wallet_expiry_days": 14,
  "created_by": "api"
}

OfferWrite#

Coming soon.

Used by

POST/v1/offersrequest body
PATCH/v1/offers/{id}request body

namestring
descriptionstring
discountDiscount
Show attributesDiscount
- typestringRequired
  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)
distributionstring
One of granted, shared_code, unique_codes
shared_codestring
per_member_limitinteger
budgetobject
Show attributesHide attributes
- max_redemptionsinteger
- max_discount_centsinteger
starts_atstring (date-time)
ends_atstring (date-time)
wallet_expiry_daysinteger

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24{
  "name": "$3 off your next order",
  "description": "Any order of $8 or more.",
  "discount": {
    "type": "amount",
    "amount_cents": 300
  },
  "rules": {
    "min_subtotal_cents": 800,
    "channels": [
      "app",
      "web"
    ]
  },
  "distribution": "granted",
  "per_member_limit": 1,
  "budget": {
    "max_redemptions": 300,
    "max_discount_cents": 90000
  },
  "starts_at": "2026-11-02T06:00:00Z",
  "ends_at": "2026-11-30T06:00:00Z",
  "wallet_expiry_days": 14
}

OfferPreview#

Used by

POST/v1/offers/{id}/previewresponse

eligible_membersinteger
expected_redemptionsinteger
expected_cost_centsinteger
warningsarray of string

Example

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."
  ]
}

Budget#

max_redemptionsintegerNullable
max_discount_centsintegerNullable
used_redemptionsinteger
used_discount_centsinteger

GrantRequest#

Used by

POST/v1/offers/{id}/grantsrequest body

grant_refstringRequired
member_idsarray of string (uuid)Required
Max Items 500

GrantResult#

Used by

POST/v1/offers/{id}/grantsresponse

grantedinteger
skippedarray of Skipped
Show attributesSkipped
- member_idstring (uuid)
- reasonstring

Skipped#

member_idstring (uuid)
reasonstring

CodeBatchRequest#

Used by

POST/v1/offers/{id}/code_batchesrequest body

prefixstringRequired
quantityintegerRequired

CodeBatch#

Used by

POST/v1/offers/{id}/code_batchesresponse
POST/v1/offers/{id}/code_batches/{batch_id}/voidresponse

idstring (uuid)
offer_idstring (uuid)
prefixstring
quantityinteger
statusstring
created_atstring (date-time)

Example

1
2
3
4
5
6
7
8{
  "id": "f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094",
  "offer_id": "e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475",
  "prefix": "HOLIDAY",
  "quantity": 5000,
  "status": "generating",
  "created_at": "2026-11-04T17:30:12Z"
}

PromoCode#

Used by

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

codestring
statusstring

Challenges#

Challenge Coming soon#

Coming soon.

Used by

GET/v1/challengesresponse
POST/v1/challengesresponse
PATCH/v1/challenges/{id}response
POST/v1/challenges/{id}/publishresponse
POST/v1/challenges/{id}/pauseresponse
POST/v1/challenges/{id}/endresponse

idstring (uuid)Required
The challenge.
namestringRequired
Shown to guests.
descriptionstring
One or two lines for guests.
image_urlstring (uri)Nullable
HTTPS image for the challenge card.
typestringRequired
visits, streak, spend or menu_discovery.
One of visits, streak, spend, menu_discovery
goalobjectRequired
target (number to reach) and unit (visits, periods, cents or items). Streaks add period (day or week) and grace_periods. Menu discovery adds item_set: items (pos_item_id, name) or categories (pos_category_id, name). Fields that don't apply are null or empty.
Show attributesHide attributes
- targetinteger
- unitstring
  One of visits, periods, cents, items
- periodstringNullable
  One of day, week
- grace_periodsintegerNullable
- item_setarray of object
qualifyingobject
Which orders count: min_subtotal_cents, channels, location_ids, fulfillment, available_times (same shapes as reward rules; empty lists mean no limit) and max_counted_per_day (default 1).
Show attributesHide attributes
- min_subtotal_centsinteger
  Integer cents.
  Min 0
- channelsarray of string
- 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.
- max_counted_per_dayinteger
windowobject or objectRequired
{ "kind": "fixed", "starts_at", "ends_at" } for the same dates for everyone, or { "kind": "rolling", "days" } for a window per member that starts when they join.
enrollmentstringRequired
automatic or opt_in.
One of automatic, opt_in
rewardobject or objectRequired
{ "kind": "points", "points" } for bonus points, or { "kind": "reward", "reward_id" } for a catalog reward that lands in the wallet.
max_completions_per_memberinteger
Usually 1.
budgetobject
max_completions across all members, or null for no limit.
Show attributesHide attributes
- max_completionsintegerNullable
statusstringRequired
draft, scheduled, live, paused or ended.
One of draft, scheduled, live, paused, ended
versioninteger
Goes up each time a scheduled or live challenge is edited. Members keep the rules of the version they joined.

Example

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{
  "id": "4f9a2d61-3e8b-4c15-a7d0-b26e81f5c93a",
  "name": "Weekly regular",
  "description": "Visit 3 times this week and get 50 bonus Beans.",
  "image_url": "https://cdn.unplugdining.com/demo/challenges/weekly-regular.jpg",
  "type": "visits",
  "goal": {
    "target": 3,
    "unit": "visits",
    "period": null,
    "grace_periods": null,
    "item_set": []
  },
  "qualifying": {
    "min_subtotal_cents": 300,
    "channels": [],
    "location_ids": [],
    "fulfillment": [],
    "available_times": [],
    "max_counted_per_day": 1
  },
  "window": {
    "kind": "fixed",
    "starts_at": "2026-11-02T06:00:00Z",
    "ends_at": "2026-11-09T06:00:00Z"
  },
  "enrollment": "automatic",
  "reward": {
    "kind": "points",
    "points": 50
  },
  "max_completions_per_member": 1,
  "budget": {
    "max_completions": 2000
  },
  "status": "live",
  "version": 1
}

ChallengeWrite#

Coming soon.

Used by

POST/v1/challengesrequest body
PATCH/v1/challenges/{id}request body

namestring
descriptionstring
image_urlstring (uri)Nullable
typestring
One of visits, streak, spend, menu_discovery
goalobject
Show attributesHide attributes
- targetinteger
- unitstring
  One of visits, periods, cents, items
- periodstringNullable
  One of day, week
- grace_periodsintegerNullable
- item_setarray of object
qualifyingobject
Show attributesHide attributes
- min_subtotal_centsinteger
  Integer cents.
  Min 0
- channelsarray of string
- 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.
- max_counted_per_dayinteger
windowobject or object
enrollmentstring
One of automatic, opt_in
rewardobject or object
max_completions_per_memberinteger
budgetobject
Show attributesHide attributes
- max_completionsintegerNullable

Example

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{
  "name": "4-week streak",
  "description": "Visit once a week for 4 weeks and get a free drip coffee. You can miss one week.",
  "image_url": "https://cdn.unplugdining.com/demo/challenges/streak.jpg",
  "type": "streak",
  "goal": {
    "target": 4,
    "unit": "periods",
    "period": "week",
    "grace_periods": 1
  },
  "qualifying": {
    "min_subtotal_cents": 300,
    "max_counted_per_day": 1
  },
  "window": {
    "kind": "fixed",
    "starts_at": "2026-11-02T06:00:00Z",
    "ends_at": "2026-12-07T06:00:00Z"
  },
  "enrollment": "opt_in",
  "reward": {
    "kind": "reward",
    "reward_id": "9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98"
  },
  "budget": {
    "max_completions": 800
  }
}

ChallengePreview#

Used by

POST/v1/challenges/{id}/previewresponse

audience_membersinteger
expected_completionsinteger
expected_pointsinteger
expected_cost_centsinteger
warningsarray of string

EnrollmentRequest#

Used by

POST/v1/challenges/{id}/enrollmentsrequest body

member_idsarray of string (uuid)Required
Max Items 500

EnrollmentResult#

Used by

POST/v1/challenges/{id}/enrollmentsresponse

enrolledinteger
skippedarray of Skipped
Show attributesSkipped
- member_idstring (uuid)
- reasonstring

ChallengeTemplate#

Used by

GET/v1/challenge_templatesresponse

idstring
namestring
descriptionstring
typestring
goalobject
qualifyingobject
window_kindstring
One of fixed, rolling
window_daysinteger
enrollmentstring
One of automatic, opt_in
suggested_rewardstring

Example

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{
  "id": "weekly_regular",
  "name": "Weekly regular",
  "description": "3 visits Monday to Sunday.",
  "type": "visits",
  "goal": {
    "target": 3,
    "unit": "visits",
    "period": null,
    "grace_periods": null,
    "item_set": []
  },
  "qualifying": {
    "min_subtotal_cents": 300,
    "channels": [],
    "location_ids": [],
    "fulfillment": [],
    "available_times": [],
    "max_counted_per_day": 1
  },
  "window_kind": "fixed",
  "window_days": 7,
  "enrollment": "automatic",
  "suggested_reward": "Bonus points worth about one add-on"
}

Reports#

ReportFigures#

membersobject
Show attributesHide attributes
- totalinteger
- newinteger
- activeinteger
pointsobject
Show attributesHide attributes
- issuedinteger
- redeemedinteger
- adjustedinteger
- outstandinginteger
rewardsobject
Show attributesHide attributes
- issuedinteger
- redeemedinteger
- discount_centsinteger
ordersobject
Show attributesHide attributes
- member_ordersinteger
- member_sales_centsinteger
- non_member_ordersinteger
- non_member_sales_centsinteger

ProgramSummaryReport Coming soon#

Coming soon.

Used by

GET/v1/reports/program_summaryresponse

fromstring (date)
tostring (date)
location_idstring (uuid)Nullable
time_zonestring
currencystring
ISO 4217 code. USD.
totalsReportFigures
Show attributesReportFigures
- membersobject
  Show attributesHide attributes
  - totalinteger
  - newinteger
  - activeinteger
- pointsobject
  Show attributesHide attributes
  - issuedinteger
  - redeemedinteger
  - adjustedinteger
  - outstandinginteger
- rewardsobject
  Show attributesHide attributes
  - issuedinteger
  - redeemedinteger
  - discount_centsinteger
- ordersobject
  Show attributesHide attributes
  - member_ordersinteger
  - member_sales_centsinteger
  - non_member_ordersinteger
  - non_member_sales_centsinteger
daysarray of object + ReportFigures

Example

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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83{
  "from": "2026-11-05",
  "to": "2026-11-06",
  "location_id": null,
  "time_zone": "America/Chicago",
  "currency": "USD",
  "totals": {
    "members": {
      "total": 8431,
      "new": 42,
      "active": 1020
    },
    "points": {
      "issued": 114150,
      "redeemed": 58500,
      "adjusted": -210,
      "outstanding": 2131500
    },
    "rewards": {
      "issued": 77,
      "redeemed": 148,
      "discount_cents": 50900
    },
    "orders": {
      "member_orders": 1373,
      "member_sales_cents": 1336360,
      "non_member_orders": 2241,
      "non_member_sales_cents": 1981105
    }
  },
  "days": [
    {
      "date": "2026-11-05",
      "members": {
        "total": 8412,
        "new": 23,
        "active": 611
      },
      "points": {
        "issued": 58940,
        "redeemed": 30500,
        "adjusted": -120,
        "outstanding": 2104380
      },
      "rewards": {
        "issued": 41,
        "redeemed": 77,
        "discount_cents": 26500
      },
      "orders": {
        "member_orders": 702,
        "member_sales_cents": 683950,
        "non_member_orders": 1148,
        "non_member_sales_cents": 1012330
      }
    },
    {
      "date": "2026-11-06",
      "members": {
        "total": 8431,
        "new": 19,
        "active": 588
      },
      "points": {
        "issued": 55210,
        "redeemed": 28000,
        "adjusted": -90,
        "outstanding": 2131500
      },
      "rewards": {
        "issued": 36,
        "redeemed": 71,
        "discount_cents": 24400
      },
      "orders": {
        "member_orders": 671,
        "member_sales_cents": 652410,
        "non_member_orders": 1093,
        "non_member_sales_cents": 968775
      }
    }
  ]
}

RewardReportRow#

reward_idstring (uuid)
namestring
kindstring
One of points, wallet
points_costintegerNullable
issuedinteger
redeemedinteger
points_spentinteger
discount_centsinteger

RewardsReport Coming soon#

Coming soon.

Used by

GET/v1/reports/rewardsresponse

fromstring (date)
tostring (date)
time_zonestring
currencystring
ISO 4217 code. USD.
dataarray of RewardReportRow
Show attributesRewardReportRow
- reward_idstring (uuid)
- namestring
- kindstring
  One of points, wallet
- points_costintegerNullable
- issuedinteger
- redeemedinteger
- points_spentinteger
- discount_centsinteger

Example

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{
  "from": "2026-11-05",
  "to": "2026-11-06",
  "time_zone": "America/Chicago",
  "currency": "USD",
  "data": [
    {
      "reward_id": "9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98",
      "name": "Free drip coffee",
      "kind": "points",
      "points_cost": 500,
      "issued": 0,
      "redeemed": 70,
      "points_spent": 35000,
      "discount_cents": 22750
    },
    {
      "reward_id": "5e8b1f4c-2d9a-4b6e-8c3f-7a0d2e9b1c65",
      "name": "Free pastry",
      "kind": "points",
      "points_cost": 700,
      "issued": 0,
      "redeemed": 22,
      "points_spent": 15400,
      "discount_cents": 7900
    },
    {
      "reward_id": "b3d7a9e2-6f1c-4a8d-9e5b-2c4f7a1d3e86",
      "name": "$5 off",
      "kind": "points",
      "points_cost": 900,
      "issued": 0,
      "redeemed": 9,
      "points_spent": 8100,
      "discount_cents": 4500
    },
    {
      "reward_id": "d4c2e8a6-7b3f-4e1d-9a5c-1f8b6d3e0a92",
      "name": "Fall pastry on us",
      "kind": "wallet",
      "points_cost": null,
      "issued": 77,
      "redeemed": 43,
      "points_spent": 0,
      "discount_cents": 15250
    }
  ]
}