GET api/inventory/InventoryPrice/{ID}
To get the price and other rank price related values of a given InventoryPriceID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
InventoryPriceViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| InventoryPriceID |
The InventoryPriceID is the record for the Inventory Price record itself (not the InventoryID) |
integer |
None. |
| ProductID |
This is the Product ID or item number |
string |
None. |
| RankPriceTypeID |
Combination PriceType and Rank associated with this price |
integer |
None. |
| RankTypeID |
RankTypeID - Can be used in combination with PriceText instead of RankPriceTypeID. See the ~/api/admin/rankType API endpoint to get the IDs for the RankTypes configured in your system |
integer |
None. |
| PriceType |
PriceType- Can be used in combination with RankTypeID instead of RankPriceTypeID (e.g. Wholesale, Retail, etc.) |
string |
None. |
| Price |
Main value of the item. |
decimal number |
None. |
| CustomerService |
True if the price can be used on Freedom BackOffice (employee area). |
boolean |
None. |
| AutoShip |
True if the price can be used to make the item available as an Autoship item. |
boolean |
None. |
| AutoshipExt |
True if the price can be used to make the item available as an Autoship item in Extranet. |
boolean |
None. |
| Customers |
True if the price can be used for Customer Orders. |
boolean |
None. |
| Web |
True if the price can be used on Extranet. |
boolean |
None. |
| Party |
True if the price can be used to make the item available as a Party item. |
boolean |
None. |
| Signup |
True if the price can be used on Enrollment Pages. |
boolean |
None. |
| Volume |
Main volume value for the item. |
decimal number |
None. |
| Volume2 |
Value of the second type of volume associated with this item. |
decimal number |
None. |
| Volume3 |
Value of the third type of volume associated with this item. |
decimal number |
None. |
| Volume4 |
Value of the fourth type of volume associated with this item. |
decimal number |
None. |
| OtherPrice |
Value of the second type of price associated with this item. |
decimal number |
None. |
| OtherPrice2 |
Value of the third type of price associated with this item. |
decimal number |
None. |
| OtherPrice3 |
Value of the fourth type of price associated with this item. |
decimal number |
None. |
| OtherPrice4 |
Value of the fifth type of price associated with this item. |
decimal number |
None. |
| Compare |
Used to compare item price to full retail price. You can write the difference. |
decimal number |
None. |
| TaxableAmount |
Taxable amount value of the item |
decimal number |
None. |
| ShippingValue |
The Shipping Value field is used to calculate shipping charges if shipping is being calculated off the price of the inventory item. This field will be considered the price for shipping calculation purposes. If shipping is computed based on WEIGHT rules, then this field is not used. |
decimal number |
None. |
| ReturnPrice |
If a value is entered here, any return order created for this inventory item will use this value instead of the original purchase price. |
decimal number |
None. |
| StartDate |
Setup the start date when the price start to be applicable. |
date |
None. |
| EndDate |
Setup the limit date of the price availability. |
date |
None. |
| MultiUnitPriceType |
This is the MUP type appropriate to this item. |
integer |
None. |
| MultiUnitQtyStart |
This is the starting quantity for this price point. I.E. the starting total quantity of items in this type needed to qualify for this price point. |
integer |
None. |
| MultiUnitQtyEnd |
This is the ending quantity for this price point. I.E. the highest quantity of items in this type allowed to qualify for this price point. |
integer |
None. |
Response Formats
application/xml, text/xml
<InventoryPriceViewModel> <InventoryPriceID>1</InventoryPriceID> <ProductID>sample string 1</ProductID> <RankPriceTypeID>1</RankPriceTypeID> <RankTypeID>1</RankTypeID> <PriceType>sample string 2</PriceType> <Price>3</Price> <CustomerService>True</CustomerService> <AutoShip>True</AutoShip> <AutoshipExt>True</AutoshipExt> <Customers>True</Customers> <Web>True</Web> <Party>True</Party> <Signup>True</Signup> <Volume>11</Volume> <Volume2>12</Volume2> <Volume3>13</Volume3> <Volume4>14</Volume4> <OtherPrice>15</OtherPrice> <OtherPrice2>16</OtherPrice2> <OtherPrice3>17</OtherPrice3> <OtherPrice4>18</OtherPrice4> <Compare>19</Compare> <TaxableAmount>20</TaxableAmount> <ShippingValue>21</ShippingValue> <ReturnPrice>22</ReturnPrice> <StartDate>01/09/2025 02:08:25</StartDate> <EndDate>01/09/2025 02:08:25</EndDate> <MultiUnitPriceType>25</MultiUnitPriceType> <MultiUnitQtyStart>26</MultiUnitQtyStart> <MultiUnitQtyEnd>27</MultiUnitQtyEnd> </InventoryPriceViewModel>
application/json, text/json
{
"InventoryPriceID": 1,
"ProductID": "sample string 1",
"RankPriceTypeID": 1,
"RankTypeID": 1,
"PriceType": "sample string 2",
"Price": 3.0,
"CustomerService": true,
"AutoShip": true,
"AutoshipExt": true,
"Customers": true,
"Web": true,
"Party": true,
"Signup": true,
"Volume": 11.0,
"Volume2": 12.0,
"Volume3": 13.0,
"Volume4": 14.0,
"OtherPrice": 15.0,
"OtherPrice2": 16.0,
"OtherPrice3": 17.0,
"OtherPrice4": 18.0,
"Compare": 19.0,
"TaxableAmount": 20.0,
"ShippingValue": 21.0,
"ReturnPrice": 22.0,
"StartDate": "2025-01-09T02:08:25.6624061-05:00",
"EndDate": "2025-01-09T02:08:25.6624061-05:00",
"MultiUnitPriceType": 25,
"MultiUnitQtyStart": 26,
"MultiUnitQtyEnd": 27
}