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": 22 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": 24 Type: Number Unused |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| GET | api/v3/DiscountType/ |
| Retrieve all of the DiscountType objects. | |
Retrieve all of the DiscountType objects. GET api/v3/DiscountType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Percentage",
"sortOrder": 0
}
]
} | |
| GET | api/v3/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/v3/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": 12
}
]
}
} | |
| GET | api/v3/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/v3/DiscountType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Percentage",
"sortOrder": 6
}
} | |