Gets a list of promotion types.
Name | Description | Usage |
---|---|---|
className | This will filter the request by class name. | GET promotiontypes?filter=classname~{operator}~{value} |
classType | This will filter the request by class type. | GET promotiontypes?filter=classtype~{operator}~{value} |
isActive | This will filter the request by the is active flag. | GET promotiontypes?filter=isactive~{operator}~{value} |
name | This will filter the request by name. | GET promotiontypes?filter=name~{operator}~{value} |
Name | Description | Usage |
---|---|---|
className | This will sort the response by class name. | GET promotiontypes?sort=classname |
name | This will sort the response by name. | GET promotiontypes?sort=name |
promotionTypeId | This will sort the response by promotion type ID. | GET promotiontypes?sort=promotiontypeid |
Name | Description | Usage |
---|---|---|
index | The index to retrieve when requesting paged results. | GET promotiontypes?page=index~{value} |
size | The size of the page when retrieving paged results. | GET promotiontypes?page=size~{value} |
If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.
{
"PromotionTypes": [
{
"ClassName": "ZnodeCartPromotionAmountOffProduct",
"ClassType": "CART",
"Description": "Applies an amount off a product for an order; affects the shopping cart.",
"IsActive": true,
"Name": "Amount Off Product",
"PromotionTypeId": 6,
"UserType": null
}
],
"PageIndex": null,
"PageSize": null,
"TotalPages": null,
"TotalResults": null,
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}