GET api/product/{id}/history/sales.{format}?storeID={storeID}
Get sales history for a product exported as a file
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Product identifier |
globally unique identifier |
Required |
| format |
Summary sales export file format |
string |
Required |
| storeID |
Store to restrict sales information to |
integer |
Default value is 0 |
| PLUG_UID | Collection of byte |
None. |
|
| PluGuid |
Product to get sales history of |
globally unique identifier |
None. |
| SummaryPeriod |
Period to summarise |
SalesHistorySummaryPeriod |
None. |
| StartDate |
Start of period to get history for |
date |
Required |
| EndDate |
End of period to get history for |
date |
Required |
| IncludeExternalSales |
Whether external sales should be included |
boolean |
None. |
| Stores |
List of stores to restrict sales records to |
Collection of integer |
None. |
| Skip |
Number of records to skip over |
integer |
None. |
| Take |
Number of records to take |
integer |
None. |
| TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Body Parameters
None.
Response Information
Resource Description
Sales history export file
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel
Sample:
Sample not available.