Get all merchandise sold for an organization
GET api/V3/{language}/org/{orgIdentifier}/merchandise/sold
?from={from}
&to={to}
&page={page}
&perPage={perPage}
Returns all the merchandise that was sold for your organization (defaults to last 30 days).
Request Information
URI Parameters
| PARAMETERS | ||
|---|---|---|
| language (string) |
Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en' |
Required |
| orgIdentifier (string) |
Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'. |
Required |
| from (date) |
Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null |
Optional |
| to (date) |
End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null |
Optional |
| page (integer) |
Result page number that appears first. Default value is 1 |
Optional |
| perPage (integer) |
Number of results per page. Default value is 200 |
Optional |
Body Parameters
None.
Response Information
Resource Description
| PARAMETERS | ||
|---|---|---|
| InvoiceItemId (integer) | ||
| PurchasedDate (date) |
Date when resource was purchased. Format is 9999-12-31 |
|
| ProductId (integer) | ||
| Name (string) |
Resource name |
|
| Status (string) |
Object containing the possible status values (case-insensitive). |
|
| Quantity (integer) | ||
| Person (PersonSummaryApiModelV3) | ||
| PurchaseLinked (LinkedItemModelV3) | ||