GET api/Retail/GetItemRetailBenefits?ItemID={ItemID}&CustomerID={CustomerID}&ShopID={ShopID}&Quantity={Quantity}&ShowLowestPrice={ShowLowestPrice}&Page={Page}&PageSize={PageSize}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemID | string |
Required |
|
| CustomerID | string |
None. |
|
| ShopID | string |
Required |
|
| Quantity | decimal number |
None. |
|
| ShowLowestPrice | boolean |
None. |
|
| Page | integer |
None. |
|
| PageSize | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ItemRetailBenefitsHeaderDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemID | string |
None. |
|
| ItemIDType | string |
None. |
|
| ItemTitle1 | string |
None. |
|
| ItemTitle2 | string |
None. |
|
| ItemUnitOfMeasure | string |
None. |
|
| ShopID | string |
None. |
|
| ShopTitle1 | string |
None. |
|
| ShopTitle2 | string |
None. |
|
| CustomerID | string |
None. |
|
| CustomerTitle1 | string |
None. |
|
| CustomerTitle2 | string |
None. |
|
| CustomerTitle3 | string |
None. |
|
| Quantity | decimal number |
None. |
|
| BenefitDate | date |
None. |
|
| PriceListID | string |
None. |
|
| RetailPrice | decimal number |
None. |
|
| CustomerDiscountPercentage | decimal number |
None. |
|
| GrossAmount | decimal number |
None. |
|
| BenefitAmount | decimal number |
None. |
|
| NetAmount | decimal number |
None. |
|
| NetPrice | decimal number |
None. |
|
| LowestPrice | decimal number |
None. |
|
| ItemRetailBenefitsLines | ItemRetailBenefitsLine_ |
None. |
Response Formats
application/xml, text/xml
Sample:
<ItemRetailBenefitsHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ItemID>sample string 1</ItemID>
<ItemIDType>sample string 2</ItemIDType>
<ItemTitle1>sample string 3</ItemTitle1>
<ItemTitle2>sample string 4</ItemTitle2>
<ItemUnitOfMeasure>sample string 5</ItemUnitOfMeasure>
<ShopID>sample string 6</ShopID>
<ShopTitle1>sample string 7</ShopTitle1>
<ShopTitle2>sample string 8</ShopTitle2>
<CustomerID>sample string 9</CustomerID>
<CustomerTitle1>sample string 10</CustomerTitle1>
<CustomerTitle2>sample string 11</CustomerTitle2>
<CustomerTitle3>sample string 12</CustomerTitle3>
<Quantity>1</Quantity>
<BenefitDate>2026-06-03T18:54:44.9683918+02:00</BenefitDate>
<PriceListID>sample string 13</PriceListID>
<RetailPrice>1</RetailPrice>
<CustomerDiscountPercentage>1</CustomerDiscountPercentage>
<GrossAmount>1</GrossAmount>
<BenefitAmount>1</BenefitAmount>
<NetAmount>1</NetAmount>
<NetPrice>1</NetPrice>
<LowestPrice>1</LowestPrice>
<ItemRetailBenefitsLines>
<ItemRetailBenefitsLine>
<BenefitID>sample string 1</BenefitID>
<BenefitTitle>sample string 2</BenefitTitle>
<BenefitPriority>3</BenefitPriority>
<BenefitsCombining>4</BenefitsCombining>
<BenefitApplied>true</BenefitApplied>
<BenefitStartDate>2026-06-03T18:54:44.9683918+02:00</BenefitStartDate>
<BenefitEndDate>2026-06-03T18:54:44.9683918+02:00</BenefitEndDate>
<BenefitStartTime>2026-06-03T18:54:44.9683918+02:00</BenefitStartTime>
<BenefitEndTime>2026-06-03T18:54:44.9683918+02:00</BenefitEndTime>
<BenefitThresholdValue>1</BenefitThresholdValue>
<BenefitThresholdType>sample string 6</BenefitThresholdType>
<BenefitDiscount>1</BenefitDiscount>
<BenefitDiscountType>sample string 7</BenefitDiscountType>
<BenefitDiscountQuantity>1</BenefitDiscountQuantity>
<BenefitPriceList>sample string 8</BenefitPriceList>
</ItemRetailBenefitsLine>
<ItemRetailBenefitsLine>
<BenefitID>sample string 1</BenefitID>
<BenefitTitle>sample string 2</BenefitTitle>
<BenefitPriority>3</BenefitPriority>
<BenefitsCombining>4</BenefitsCombining>
<BenefitApplied>true</BenefitApplied>
<BenefitStartDate>2026-06-03T18:54:44.9683918+02:00</BenefitStartDate>
<BenefitEndDate>2026-06-03T18:54:44.9683918+02:00</BenefitEndDate>
<BenefitStartTime>2026-06-03T18:54:44.9683918+02:00</BenefitStartTime>
<BenefitEndTime>2026-06-03T18:54:44.9683918+02:00</BenefitEndTime>
<BenefitThresholdValue>1</BenefitThresholdValue>
<BenefitThresholdType>sample string 6</BenefitThresholdType>
<BenefitDiscount>1</BenefitDiscount>
<BenefitDiscountType>sample string 7</BenefitDiscountType>
<BenefitDiscountQuantity>1</BenefitDiscountQuantity>
<BenefitPriceList>sample string 8</BenefitPriceList>
</ItemRetailBenefitsLine>
</ItemRetailBenefitsLines>
</ItemRetailBenefitsHeader>