TAG LINE
TAG LINE
SMALL TITLE
System defined options for tiered pricing such as not-tiered, bracketed, or progressive.
identity READ-ONLY | "identity": 27 Type: Number This is the unique numeric identifier for the PricePlanTierType |
name READ-ONLY | "name": "Tiered Bracketed" Type: String System defined name for the Tier Type. |
sortOrder READ-ONLY | "sortOrder": 25 Type: Number Unused |
| GET | api/v4/PricePlan/TierType/ |
| Retrieve all of the PricePlanTierType objects. | |
Retrieve all of the PricePlanTierType objects. GET api/v4/PricePlan/TierType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Tiered Bracketed",
"sortOrder": 12
}
]
} | |
| GET | api/v4/PricePlan/TierType/Paged |
| Retrieve all of the PricePlanTierType 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 PricePlanTierType objects in a paged fashion. GET api/v4/PricePlan/TierType/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": "Tiered Bracketed",
"sortOrder": 11
}
]
}
} | |
| GET | api/v4/PricePlan/TierType/{id} |
| Retrieve an instance of the PricePlanTierType object by its ID. | |
| {id} | Unique identifier for the PricePlanTierType object. |
Retrieve an instance of the PricePlanTierType object by its ID. GET api/v4/PricePlan/TierType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Tiered Bracketed",
"sortOrder": 18
}
} | |
| POST | api/v4/PricePlan/TierType/Search |
| Retreive a list of PricePlanTierType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST. | |
Retreive a list of PricePlanTierType objects based on search criteria. POST api/v4/PricePlan/TierType/Search
{
"query": {
"top": 20,
"search": [
{
"name": "MyFieldName",
"operator": "startsWith",
"value": "a"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"itemCount": 1,
"items": [
{
"identity": 1,
"name": "Tiered Bracketed",
"sortOrder": 23
}
]
} | |