Get list of discounts
Request
GET https://api.nexway.store/discounts
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| page | int32 | number of page you want to hit |
|
| size | int32 | number of items into the current page |
|
| sort | string | sort a specific column to a direction (columnName,asc) |
|
| id | string | Filter discounts by ID |
|
| name | string | Filter discounts by name |
|
| code | string | Filter discounts by code |
|
| storeId | string | Filter discounts by store ID |
|
| model | string | Filter discounts by model |
|
| rebate | string | Filter discounts by rebate |
|
| type | string | Filter discounts by type |
|
| startingDate | string | Filter discounts by starting date with format yyyy-MM-dd'T'HH:mm:ss. The < symbol allows filtering before (<X), after (X<), and between a range of dates (X<<Y) |
|
| endingDate | string | Filter discounts by ending date with format yyyy-MM-dd'T'HH:mm:ss. The < symbol allows filtering before (<X), after (X<), and between a range of dates (X<<Y) |
|
| customerId | string | Filter discounts by customer ID |
|
| status | ref | Filter discounts by status |
Authorisation
This request requires the use of one of following authorisation methods:
OAuth2.
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK Success |
SearchResult«Discount» |
| 401 | Unauthorized Unauthorized |
|
| 403 | Forbidden Forbidden |
|
| 404 | Not Found Not Found |
|
| 500 | Internal Server Error Failure |