Public previewBetter every weekSee what changed →
All guides

Getting started

View as Markdown

Glossary

TermMeaning
StorefrontYour registration with Groupon. Created in this portal: it holds your display name, contact details, inventory scope, and the API keys you mint against it.
API keyThe credential you send as Authorization: Bearer .... Acts as the storefront that created it. Format: grpn_ followed by 8 hex characters, _, and 56 hex characters.
Partner idYour storefront's stable id at Groupon. Quote it when you contact Groupon, for example to change your registration or add a CJ publisher ID.
ProductA Groupon deal, returned by the products list. Its id is the productId in cart requests.
OptionOne purchasable variant of a product, for example "One 60-Minute Massage". Its id is the optionId in cart requests, and the id of the cart line.
Minor unitsInteger money amounts in the currency's smallest unit (cents for USD). Divide by 10^currencyPrecision to display.
retailThe per-unit price the shopper pays. Send it as expectedPrice in cart requests.
originalThe strike-through price.
PromotionA promotional price the shopper gets by entering a code on Groupon's checkout page. Informational only: cart totals always use retail, and a promotion can be null at any time.
Inventory scopeThe US states and categories your storefront is registered for. The products list only returns deals inside it.
WalkReading every page of one products query, following nextCursor until hasMore is false.
CursorAn opaque token for the next page of a walk. Valid for 24 hours; send it back exactly as received.
Full load / delta refreshReading the whole catalog once, then only what changed since your last refresh, using updatedSince. See Syncing the catalog.
ListableA product you show: status is active, availabilityRequired is false, and at least one option is not inactive.
CartGroupon's mirror of your shopper's cart. Created together with its first item. It can later become empty when you remove its last line.
LineOne option in a cart, with a quantity. Its id equals the optionId.
buyLinkThe checkout URL on every cart response. Use the latest one verbatim.
CJ / PIDCommission Junction, the affiliate network, and your publisher ID in it. Adding your PID is how you earn commission on purchases made through buyLink.
grouponOrderUuidThe order id Groupon adds to your redirect URL after payment. Also the bookingId you read the order with.
BookingThe order as the booking endpoint reports it: a status and one item per product and option bought, each with one unit item per purchased unit.
Unit itemOne purchased unit of a booking item, with its own status and "View on Groupon" link.
requestIdThe id of a failed request, from the error body. Quote it when contacting support.