Sales

GET /reports/sales

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
locationId optional Comma separated numerical IDs of the desired location(s). 1,2,3
sellerId optional Comma separated numerical IDs of the desired seller(s). 1,2,3
customerId optional Comma separated numerical IDs of the desired customer(s). 1,2,3
minDate optional Returns sales created after the given date. Date should be formatted as ISO 8601. 2019-01-01T00:00:00.000Z
maxDate optional Returns sales created before the given date. Date should be formatted as ISO 8601. 2019-12-31T00:00:00.000Z
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1

Response


{
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "totalPages": 1,
  "itemCount": 54,
  "items": [
    {
      "paymentId": 3844926,
      "type": "creditCard",
      "processor": "froogalpay",
      "status": "paid",
      "quantity": 3,
      "cost": 10,
      "expenses": 1.01,
      "purchaseTime": "2019-03-12 12:11:37",
      "webOrderId": 0,
      "sellerId": 50001,
      "sellerName": "test",
      "eventId": 449,
      "paymentReference": "IN3JS9AB48",
      "customerId": 0,
      "latitude": 0,
      "longitude": 0,
      "locationId": 1,
      "locationName": "Sector 1  Seats 100-500",
      "inVenue": 0,
      "addonProduct": false
    },
    ...
  ],
  "aggregates":  [
    {
      "quantity": 5,
      "cost": 5,
      "sales": {
        "gross": 55,
        "net": 49.5,
        "cash": 25,
        "creditCard": 30,
        "debitCard": 0,
        "refunded": 0,
        "expenses": 5.5
      },
      "transactions": {
        "gross": 11,
        "net": 11,
        "cash": 5,
        "creditCard": 6,
        "debitCard": 0,
        "refunded": 0
      }
    },
    ...
  ]
}

GET /reports/sales/items

Resource information
Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
locationId optional Comma separated numerical IDs of the desired location(s). 1,2,3
sellerId optional Comma separated numerical IDs of the desired seller(s). 1,2,3
customerId optional Comma separated numerical IDs of the desired customer(s). 1,2,3
minDate optional Returns sales created after the given date. Date should be formatted as ISO 8601. 2019-01-01T00:00:00.000Z
maxDate optional Returns sales created before the given date. Date should be formatted as ISO 8601. 2019-12-31T00:00:00.000Z
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1

Response

{
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "totalPages": 1,
  "itemCount": 54,
  "items": [
    {
      "paymentId": 3844926,
      "type": "creditCard",
      "processor": "froogalpay",
      "status": "paid",
      "quantity": 3,
      "cost": 10,
      "expenses": 1.01,
      "purchaseTime": "2019-03-12 12:11:37",
      "webOrderId": 0,
      "sellerId": 50001,
      "sellerName": "test",
      "eventId": 449,
      "paymentReference": "IN3JS9AB48",
      "customerId": 0,
      "latitude": 0,
      "longitude": 0,
      "locationId": 1,
      "locationName": "Sector 1  Seats 100-500",
			"inVenue": 0,
			"addonProduct": false
    },
    ...
  ],
  "aggregates":  [
    {
      "quantity": 5,
      "cost": 5,
      "sales": {
        "gross": 55,
        "net": 49.5,
        "cash": 25,
        "creditCard": 30,
        "debitCard": 0,
        "refunded": 0,
        "expenses": 5.5
      },
      "transactions": {
        "gross": 11,
        "net": 11,
        "cash": 5,
        "creditCard": 6,
        "debitCard": 0,
        "refunded": 0
      }
    },
    ...
  ]
}

GET /reports/sales/locations

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
locationId optional Comma separated numerical IDs of the desired location(s). 1,2,3
sellerId optional Comma separated numerical IDs of the desired seller(s). 1,2,3
customerId optional Comma separated numerical IDs of the desired customer(s). 1,2,3
minDate optional Returns sales created after the given date. Date should be formatted as ISO 8601. 2019-01-01T00:00:00.000Z
maxDate optional Returns sales created before the given date. Date should be formatted as ISO 8601. 2019-12-31T00:00:00.000Z
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1

Response

---

GET /reports/sales/sellers

Resource information
Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
locationId optional Comma separated numerical IDs of the desired location(s). 1,2,3
sellerId optional Comma separated numerical IDs of the desired seller(s). 1,2,3 

{
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "totalPages": 1,
  "itemCount": 54,
  "items": [
    {
      "paymentId": 3844926,
      "type": "creditCard",
      "processor": "froogalpay",
      "status": "paid",
      "quantity": 3,
      "cost": 10,
      "expenses": 1.01,
      "purchaseTime": "2019-03-12 12:11:37",
      "webOrderId": 0,
      "sellerId": 50001,
      "eventId": 449,
      "paymentReference": "IN3JS9AB48",
      "customerId": 0,
      "latitude": 0,
      "longitude": 0,
      "locationId": 1,
      "locationName": "Sector 1  Seats 100-500",
			"inVenue": 0,
			"addonProduct": false
    },
    ...
  ],
  "aggregates":[
    {
      "locationId": "1",
      "locationName": "Somewhere Fun",
      "sales": {
        "gross": 7738528,
        "net": 7268115,
        "cash": 4271440,
        "creditCard": 2996065,
        "debitCard": 610,
        "refunded": 470413,
        "expenses": 0
      },
      "transactions": {
        "gross": 174742,
        "net": 169636,
        "cash": 117716,
        "creditCard": 51878,
        "debitCard": 22,
        "refunded": 5106
      }
    },
    ...
  ]
}
---

GET /reports/sales/sellers

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
locationId optional Comma separated numerical IDs of the desired location(s). 1,2,3
sellerId optional Comma separated numerical IDs of the desired seller(s). 1,2,3
customerId optional Comma separated numerical IDs of the desired customer(s). 1,2,3
minDate optional Returns sales created after the given date. Date should be formatted as ISO 8601. 2019-01-01T00:00:00.000Z
maxDate optional Returns sales created before the given date. Date should be formatted as ISO 8601. 2019-12-31T00:00:00.000Z
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1

Response


{
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "totalPages": 1,
  "itemCount": 54,
  "items": [
    {
      "paymentId": 3844926,
      "type": "creditCard",
      "processor": "froogalpay",
      "status": "paid",
      "quantity": 3,
      "cost": 10,
      "expenses": 1.01,
      "purchaseTime": "2019-03-12 12:11:37",
      "webOrderId": 0,
      "sellerId": 50001,
      "sellerName": "test",
      "eventId": 449,
      "paymentReference": "IN3JS9AB48",
      "customerId": 0,
      "latitude": 0,
      "longitude": 0,
      "locationId": 1,
      "locationName": "Sector 1  Seats 100-500"
    },
    ...
  ],
  "aggregates": [
    {
      "sellerId": 50000,
      "sellerName": "Web Sales",
      "sales": {
        "gross": 335,
        "cash": 0,
        "creditCard": 335,
        "refunded": 30,
        "expenses": 30.28,
        "net": 274.72
      },
      "transactions": {
        "gross": 18,
        "refunded": 2,
        "net": 16,
        "cash": 0,
        "creditCard": 16
      }
    },
    ...
  ]
}
---

GET /reports/sales/customers

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
locationId optional Comma separated numerical IDs of the desired location(s). 1,2,3
sellerId optional Comma separated numerical IDs of the desired seller(s). 1,2,3
customerId optional Comma separated numerical IDs of the desired customer(s). 1,2,3
minDate optional Returns sales created after the given date. Date should be formatted as ISO 8601. 2019-01-01T00:00:00.000Z
maxDate optional Returns sales created before the given date. Date should be formatted as ISO 8601. 2019-12-31T00:00:00.000Z
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1

Response

{
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "totalPages": 1,
  "itemCount": 54,
  "items": [
    {
      "paymentId": 3844926,
      "type": "creditCard",
      "processor": "froogalpay",
      "status": "paid",
      "quantity": 3,
      "cost": 10,
      "expenses": 1.01,
      "purchaseTime": "2019-03-12 12:11:37",
      "webOrderId": 0,
      "sellerId": 50001,
      "sellerName": "test",
      "eventId": 449,
      "paymentReference": "IN3JS9AB48",
      "customerId": 0,
      "latitude": 0,
      "longitude": 0,
      "locationId": 1,
      "locationName": "Sector 1  Seats 100-500"
    },
    ...
  ],
  "aggregates": [
    {
      "customerId": 193,
      "sales": {
        "gross": 335,
        "cash": 0,
        "creditCard": 335,
        "refunded": 30,
        "expenses": 30.28,
        "net": 274.72
      },
      "transactions": {
        "gross": 18,
        "refunded": 2,
        "net": 16,
        "cash": 0,
        "creditCard": 16
      }
    },
    ...
  ]
}
---