Order API

This is deprecated. Please use Reporting Version V2

Introductionback to top

This service allows you to retrieve orders based on your clientId. You can find your clientId under the Account Profile section when you log into to your GPN account.

URLback to top

https://partner-api.groupon.com/v1/orders.json

Supported Formatsback to top

JSON

URL Parametersback to top

clientId
  • Required
  • The api key that identifies your client
  • Example: 01faac2db87949ba744486af455c30e03662bd78
startDate
  • 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-2014
endDate
  • 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-2014
orderId
  • Optional
  • The Groupon Order ID (or the first few digits of it)
  • Example: 151087914 ('151' will also match this order ID)
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)
start
  • Optional
  • Pagination parameter for specifying the starting record. Requires end parameter.
  • Example: 0
end
  • Optional
  • Pagination parameter for specifying the ending record. Requires start parameter.
  • Example: 50

Response Parametersback to top

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 2014: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 2014: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 Callback to top

Sample Response

Error Messageback to top

Response Elements

All error responses contain at least the top level error object with httpCode and message

  • httpCode
    HTTP status code
  • message
    Human readable message indicating why the API request failed

Sample Response