Groupon Partner API Version 1 - Deprecated
Home
v1 - API Errors
v1 - Order API
v1 - Ledger API
Order API
URL
http://partner-api.groupon.com/v1/orders.json
Formats
JSON
URL parameters
clientId
Required
The api key that identifies your client
Example: cee15b12a7518bdf220a92234996195db4639614
Required
Date should be formatted as dd-MM-yyyy
Start date must be less than or equal to current date in the affiliate time zone
Example: 01-01-2013
Required
Date should be formatted as dd-MM-yyyy
End date must be less than or equal to current date in the affiliate's time zone
Example: 31-01-2013
Optional
The Groupon Order ID (or the first few digits of it)
Example: 151087914 ('151' will also match this order ID)
startDate
endDate
orderId
sid
Optional
SID of any of your users who placed an order (or the starting substring of the
SID)
Example: 4dcdb57209723187da4918d1bcc9091a ('4dcdb' will also match the
above SID)
wid
Optional
Website ID: One of the registered WIDs on your account (or the starting substring
of the WID)
Example: http://www.foo.com ('http://www.f' will also match the above WID)
permalink
Optional
Groupon permalink of the orders (or the starting substring of the permalink)
Example: gl-the-orlando-improv-1 ('gl-the-or' will also match the above
permalink)
Optional
Pagination parameter for specifying the starting record. Requires end parameter.
Example: 0
Optional
Pagination parameter for specifying the ending record. Requires start parameter.
Example: 50
Optional
The column number of the response to sort by. Column 0 is date, Column 1 is
orderID etc (see the full sequence in the sample response below). Default sort is
by date (column 0)
Example: 2
start
end
column
ascending
Optional
true/false to indicate if the sorting on the column is ascending or descending.
Default false
Example: true
Response Elements
Summary
grossMinorUnits
Total sales amount in the date range, in minor units (for USD decimal value,
divide by 100)
commissionMinorUnits
Total commission amount in the date range, in minor units (for USD decimal
value, divide by 100)
orders
Total number of orders in the date range
Records
date
Order timestamp of when the order was placed in the affiliate's time-zone. The
format is YYYY-MM-DDThh:mm:ss.. Example 2013:02:27T06:39:25
orderId
Groupon's order ID. String. Example: 151087
permalink
The Groupon permalink of the order. Example: gl-the-orlando-improv-1
affiliateId
Your affiliate ID
grossMinorUnits
Sale amount in minor units in the affiliate's currency. E.g 4025 (divide by 100 to
get decimal value)
commissionMinorUnits
Commission amount in minor units in the affiliate's currency. Example: 425
(divide by 100 to get decimal value in USD)
lastUpdated
Timestamp of the last update on the order status (e.g., status changed to
refunded). Example 2013:02:27:06:39:25
sid
SID corresponding to the order. Example: 4dcdb57209723187da4918d1bcc9091a
wid
WID corresponding to the order. Example: http://www.foo.com
orders
Number of orders in this record element (typically 1 for this endpoint)
Sample Call
http://partner-api.groupon.com/v1/orders.json?clientId=
cee15b12a7518bdf220a92234996195db4639614&startDate=01-01-2013&endDate=31-01-2013
Sample Response
{"total":2777,"summary":{"grossMinorUnits":11453035,"commissionMinorUnits":11
34876,"orders":2777},"records":[{"date":"2013-0220T23:59:42","orderId":"149693411","lastUpdated":"2013-0220T23:59:42","permalink":"abstractartworkcom","affiliateId":1029,"grossMinorUnits":5800,"commissionMinorUnits":928,"si
d":"tV_AgnoXEeKSnqLST36xpQoUr5_0_0_63I6_0","wid":null,"orders":1},{"date":"20
13-02-20T23:52:53","orderId":"149692741","lastUpdated":"2013-0220T23:52:53","permalink":"gg-ekobrew-reusable-single-serve-coffee-filter1","affiliateId":1029,"grossMinorUnits":1299,"commissionMinorUnits":78,"sid":
"dG8OXHvoEeKse5LRDiclhQ0_yG7S3_0_0_0","wid":null,"orders":1},{"date":"201302-20T23:51:29","orderId":"149692592","lastUpdated":"2013-0220T23:51:29","permalink":"beach-town-tours1","affiliateId":1029,"grossMinorUnits":3500,"commissionMinorUnits":560,"sid"
:"cKj7SHvoEeK2ikKlSFOw_Q0_0_0_8HJ6_0","wid":null,"orders":1},{"date":"201302-20T23:45:09","orderId":"149691978","lastUpdated":"2013-0220T23:45:09","permalink":"gg-ekobrew-reusable-single-serve-coffee-filter1","affiliateId":1029,"grossMinorUnits":1299,"commissionMinorUnits":78,"sid":
"TaziJnvoEeK9CxrqAdQZcA0_kb8S3_UyL_0_0","wid":null,"orders":1},{"date":"201302-20T23:31:30","orderId":"149690510","lastUpdated":"2013-0220T23:31:30","permalink":"gg-ekobrew-reusable-single-serve-coffee-filter1","affiliateId":1029,"grossMinorUnits":2598,"commissionMinorUnits":156,"sid"
:"WVeJnvmEeKi5gLjBHCCfw0_kb8S3_UyL_0_0","wid":null,"orders":1},{"date":"2013-0220T23:26:07","orderId":"149689883","lastUpdated":"2013-0220T23:26:07","permalink":"gg-ekobrew-reusable-single-serve-coffee-filter1","affiliateId":1029,"grossMinorUnits":2598,"commissionMinorUnits":156,"sid"
:"5ZWmFnvlEeK0aMr2W9izeweJj6_kb8S3_UyL_0_0","wid":null,"orders":1},{"date":"2
013-02-20T23:24:55","orderId":"149689735","lastUpdated":"2013-0220T23:24:55","permalink":"gg-pulse-massager2","affiliateId":1029,"grossMinorUnits":2699,"commissionMinorUnits":162,"sid"
:"lPpZFnuDEeKSUO4ky_MqHA0_yG7S3_0_0_0","wid":null,"orders":1},{"date":"201302-20T23:23:43","orderId":"149689589","lastUpdated":"2013-0220T23:23:43","permalink":"yoga-shakti-studio2","affiliateId":1029,"grossMinorUnits":7800,"commissionMinorUnits":1248,"sid
":"7K_Cxni0EeK9LO4ky_MqHA0_0_0_qSI6_0","wid":null,"orders":1},{"date":"201302-20T23:20:24","orderId":"149689177","lastUpdated":"2013-0220T23:20:24","permalink":"e-zs-brick-ovengrill","affiliateId":1029,"grossMinorUnits":900,"commissionMinorUnits":144,"s
id":"ag66KnslEeKVR8ZSIPVjAesu1_0_0_auH6_0","wid":null,"orders":1},{"date":"2013-0220T23:17:22","orderId":"149688778","lastUpdated":"2013-0220T23:17:22","permalink":"gg-ekobrew-reusable-single-serve-coffee-filter1","affiliateId":1029,"grossMinorUnits":2598,"commissionMinorUnits":156,"sid"
:"2tRoanu-EeK9Ycr2W9izeweP9_kb8S3_UyL_0_0","wid":null,"orders":1}]}}
Copyright 2013 Groupon, Inc. All Rights Reserved.
