Public previewSee what changed →
All guides

Build on the Partner API

View as Markdown

Get your API key (AI builders)

Nobody reads documentation.

Here are the instructions for your agent. Give it this prompt: it reads the guides and the API contract, then walks you through the integration step by step, what to do, where and how.

Download agent instructions

This guide is for builders, and the coding assistants they use, who need a key for the LivingSocial Partner API.

You get the key yourself on this site: no email, no approval. The open agent API needs no key and earns no commission: see LivingSocial for agents.

The flow

  1. Sign in with Google on this site. An email and password works too.

  2. Register a storefront under Account (/account/storefronts/new), with the fields below. The storefront is your registration with Groupon.

  3. Create its API key on the storefront's page: give it a name and, optionally, the day it stops working.

  4. Copy the key once, into your server's secret store. It is shown only at creation.

  5. Check it. This call answers the registration the key acts as:

    bash
    curl -s "https://api-core.livingsocial.com/partner_storefront/me" \
      -H "Authorization: Bearer $GROUPON_API_KEY"
  6. To earn commission, email req.partner.api@groupon.com your storefront's partner id (on the storefront page) and your CJ publisher ID. It is optional and your code does not change. Commission is per the CJ program terms.

Next: Syncing the catalog.

Storefront fields

FieldRequiredRules
Display nameYesAt most 60 characters, and no "Groupon" or "LivingSocial" in any spelling. Shown to shoppers on Groupon's checkout page.
Contact nameYesUp to 255 characters.
Contact emailYesA monitored address. Groupon uses it to reach you.
Logo URLNoAbsolute https:// URL. Groupon's checkout page shows the logo only when the address is on Groupon's own image CDN (*.grouponcdn.com); a logo on your own host is stored but does not render there.
Redirect URLNoAbsolute https:// URL, with no username or password in it. After checkout, Groupon sends the shopper here with grouponOrderUuid added as a query parameter.
Inventory scope: statesNoFull US state names, exactly as listed below. Leave empty for every state.
Inventory scope: category1NoGroupon category permalinks. Leave empty for every category.
Inventory scope: category2NoGroupon subcategory permalinks. Leave empty for every category.

The products list only returns offers inside your inventory scope, and a filter that names a state or category outside it is rejected.

States (50) inventoryStates, state

Alabama, Alaska, Arizona, Arkansas, California, Colorado, Connecticut, Delaware, Florida, Georgia, Hawaii, Idaho, Illinois, Indiana, Iowa, Kansas, Kentucky, Louisiana, Maine, Maryland, Massachusetts, Michigan, Minnesota, Mississippi, Missouri, Montana, Nebraska, Nevada, New Hampshire, New Jersey, New Mexico, New York, North Carolina, North Dakota, Ohio, Oklahoma, Oregon, Pennsylvania, Rhode Island, South Carolina, South Dakota, Tennessee, Texas, Utah, Vermont, Virginia, Washington, West Virginia, Wisconsin, Wyoming

Top-level category (1) category0

local

Categories (38) category1

air-inclusive, all-inclusive, auto-and-home-improvement, automotive, baby-kids-and-toys, beach-destinations, beauty-and-spas, casinos, city, cruises, culinary, electronics, entertainment-and-media, family-trips, food-and-drink, for-the-home, gift-cards, grocery-and-household, health-and-beauty, health-and-fitness, home-improvement, hotel-travel, jewelry-and-watches, luxury, mens-clothing-shoes-and-accessories, outdoor-activities-recreation, personal-services, pet-supplies, retail, romantic, spa-and-wellness, sports-and-outdoors, things-to-do, toys, unique-lodging, v1-personalized-items, waterparks, womens-clothing-shoes-and-accessories

Subcategories (207) category2

africa-and-middle-east, alcohol, apparel-local, appliances-goods, art, art-and-home-decor, arts-and-crafts, arts-and-entertainment-local, australia-and-nz, auto-cleaning, auto-parts-and-accessories, auto-repair, baby-gear, baby-toys, babys-fashion, bars, bath, bath-and-body, bath-and-potty, bedding, bird-supplies, blow-outs-and-styling, books-music-and-movies, breweries-wineries-and-distilleries, brow-and-lash, building-sets, cafes-and-treats, camera-video-and-surveillance, camping, camping-trips, car-electronics-and-gps, cat-supplies, cbd, cell-phones-and-accessories, charity, child-car-seats, childrens-books, childrens-jewelry, classes, cleaning-services, clothing-and-shoes, collectibles, computers-and-tablets, consultants, contractors, cosmetic-procedures, cosmetics, custom-baby-and-kids-items, custom-household-essentials, custom-jewelry, custom-kitchen-accessories, custom-novelty-items, custom-photo-prints, dental, diamond-jewelry, dog-supplies, dolls-and-action-figures, drinks, educational-toys, electrical, electronic-toys, electronics-local, electronics-repair, europe, event-rental-services, exercise-and-fitness, fan-shop, fashion-jewelry, fine-metal-jewelry, fire-pits-and-outdoor-heaters, fitness-classes, floor-care-and-cleaning, flooring, flowers-sweets-and-gift-baskets, food, fragrances, fun-and-leisure-activities, furniture, furniture-stores, games-and-puzzles, gemstone-and-pearl-jewelry, golf-goods, groceries-and-markets, gyms, hair-removal, hair-salons, hand-and-power-tools, health-and-beauty-local, health-and-safety, health-care, heating-and-cooling, home-and-garden-local, home-improvement-goods, home-repairs, hvac-and-electrical, interior-design, jewelry-accessories-and-storage, kids-activities, kids-bikes-and-ride-on-toys, kids-local, kitchen-and-dining, lab-grown-diamond-jewelry, lawn-and-garden, local-services, luggage, magazines, makeup, massage, massage-and-relaxation, maternity-clothes, medical, men, mens-accessories, mens-clothing, mens-jewelry, mens-shoes, mountains, movies-and-tv, musical-instruments, nail-salons, natural-medicine, nightlife, office-and-school-supplies, outdoor-decor, outdoor-grills-and-accessories, outdoors, parking, parks, party-supplies, patio-and-garden, patio-and-garden-products, personalized-bags, personalized-clothing-and-accessories, personalized-items, personalized-pets-items, personalized-stationery, pets, photo-book, photography, plumbing, plus-size-womens-clothing, portable-audio, pretend-play, recreation, remodeling, restaurants, rv-camper, salons, seasonal-decor, sightseeing-and-tours, ski-resorts, skin-care, small-animal-supplies, smart-home, software, spa, spa-getaways, sports, sports-and-outdoor-activities, sports-local, strollers, subscriptions, tanning, team-sports, television-and-home-theater, tickets-and-events, tobacco, toddler-and-baby-toys, toddler-and-kids-fashion, transportation, usa, v-books, v-food, v-heating-and-cooling, v-office-and-school-supplies, v-outdoor-power-equipment, v1-aromatherapy, v1-baby-feeding, v1-dental-care, v1-diapers, v1-gaming, v1-hair-care, v1-home-automation, v1-lighting, v1-maternity-clothes, v1-mattresses, v1-nursery, v1-outdoor-garden-decor, v1-outdoor-play, v1-personal-care, v1-personalized-home-decor, v1-sexual-health, v1-shaving, v1-skin-care, v1-storage-and-organization, v2-cycling, v2-gaming, v3-vitamins-and-supplements, vision, watches, wearable-technology, weight-loss, weight-loss-v2, womens-accessories, womens-clothing, womens-intimates, womens-shoes

Limits

  • At most 5 open storefronts per person, and 3 new ones per 24 hours.
  • At most 10 active API keys per storefront.
  • A key works for at most 90 days, and for 90 days when you set no day. The key list shows the date. An expired key answers HTTP 401, like a revoked one.
  • A key is grpn_, 8 hex characters, _, then 56 hex characters. It acts as its own storefront only, on the endpoints of the API documentation: it cannot change the registration or manage keys.
  • Call the API from your server only. Never put the key in a browser, an app, a log or a repository.

Rotating a key

Create the new key, deploy it, then revoke the old one. There is no downtime, and nobody to email.

Changing or closing a storefront

You change the display name, contact, logo, redirect URL and inventory scope yourself on the storefront's page; its keys keep working.

Closing a storefront is permanent: its catalog and carts stop answering, every one of its keys is revoked, and it no longer counts towards your five.