API Documentation

This service is in BETA. For access please Fill out the application

CONTENTS
RESOURCES
MACROS
VERBS
REPORTS
RESEARCH API

Reports API - itemsOrderedByPeriod

This report is intended to be quick summary sales report. It will group sales by the specified period and provide the number of units sold, total revenue, shipping fees charged, etc

https://api.sellerlabs.com/reports/itemsOrderedByPeriod?period=month

Available filters

You may use the following request parameters to filter down the report to specific products and/or venues:

period The time period by which the results should be grouped.
Must be one of [date, week, month, year]
productId A specific product ID for which the report should be generated
productIds A comma-separated list of product ID for which the report should be generated (all must use the same productIdType)
productIdType Use in conjunction with productId. One of [ASIN, UPC, EAN, ISBN]
msku A specific MSKU for which the report should be generated
mskuLike An SQL-compatible LIKE expression to use for matching the MSKU.
(Use percent (%) characters as wildcards.)

Example: '%abc%' will match all products with 'abc' in the msku.
'xyz%' will match all products with an msku that begins with the characters 'xyz'
venueId A specific venueId for which the report should be generated
start specify as start date in the format YYYY-MM-DD
end specify as end date in the format YYYY-MM-DD

Response

A response will be returned in this format:
https://api.sellerlabs.com/v1/reports/itemsOrderedByPeriod?period=month&mskuLike=ABC%
{
  "status": "success",
  "code": 200,
  "httpCode": "200",
  "user": "116",
  "data": {
    "offset": 0,
    "limit": 50,
    "count": "4",
    "prev": "",
    "next": "",
    "first": "\/reports?limit=50&period=month&mskuLike=ABC%25&offset=0",
    "last": "\/reports?limit=50&period=month&mskuLike=ABC%25&offset=0",
    "pages": 1,
    "reports": [
      {
        "period": "2",
        "year": "2015",
        "count": "2264",
        "quantity": "2188",
        "sumPriceItem": "30043.15",
        "sumPriceDiscount": "0.00",
        "sumPriceShipping": "1291.79",
        "sumPriceTax": "45.25"
      },
      {
        "period": "1",
        "year": "2015",
        "count": "192",
        "quantity": "188",
        "sumPriceItem": "2507.75",
        "sumPriceDiscount": "0.00",
        "sumPriceShipping": "273.82",
        "sumPriceTax": "4.49"
      },
    ]
  }
}