TAG LINE
TAG LINE
SMALL TITLE
This system defined entity represents a list of different types of discounts. For example percentage or fixed.
identity READ-ONLY | "identity": 3 Type: Number This is the unique numeric identifier for the DiscountType |
name READ-ONLY | "name": "Percentage" Type: String The system defined Discount Type. |
sortOrder READ-ONLY | "sortOrder": 3 Type: Number Unused |
| GET | api/v5/DiscountType/ |
| Retrieve all of the DiscountType objects. | |
Retrieve all of the DiscountType objects. GET api/v5/DiscountType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Percentage",
"sortOrder": 3
}
]
} | |
| GET | api/v5/DiscountType/Paged |
| Retrieve all of the DiscountType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the DiscountType objects in a paged fashion. GET api/v5/DiscountType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Percentage",
"sortOrder": 17
}
]
}
} | |
| GET | api/v5/DiscountType/{id} |
| Retrieve an instance of the DiscountType object by its ID. | |
| {id} | Unique identifier for the DiscountType object. |
Retrieve an instance of the DiscountType object by its ID. GET api/v5/DiscountType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Percentage",
"sortOrder": 27
}
} | |