POST api/pricing/v2/tiers

Retrieves the pricing chart for an item.

Request Information

URI Parameters

None.

Body Parameters

Request that specified what tier to retrieve.

Name	Description	Type	Additional information
CompanyId	Represents the Id of the company to retrieve pricing for. Depending upon privileges this is either required or prohibited.	integer	Minimum value: 1
PriceSheetId	Represents the Id of the pricing sheet to retrieve pricing for. Depending upon privileges this is either required or prohibited.	integer	Minimum value: 1
PriceAsOf	The date for which to price the item.	date	Default value is the day of the request
ItemCode	Item code of item to get tiers for.	string	Required Min length: 1 String length: inclusive between 0 and 30

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "PriceSheetId": 1,
  "PriceAsOf": "2024-05-19T00:01:54.7744304-04:00",
  "ItemCode": "sample string 2"
}

application/xml, text/xml

Sample:

<ItemTierLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CompanyId>1</CompanyId>
  <PriceSheetId>1</PriceSheetId>
  <PriceAsOf>2024-05-19T00:01:54.7744304-04:00</PriceAsOf>
  <ItemCode>sample string 2</ItemCode>
</ItemTierLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Pricing chart for given item.

ItemTierLookupResponse

Name	Description	Type	Additional information
CompanyName	The company for which the tiers were calculated.	string	None.
PricingSheetName	The name of the pricing sheet used to calculate tiers.	string	None.
PricingSheetNumber	The number of the pricing sheet used to calcuate tiers.	string	None.
ItemCode	The item code for the item tier request.	string	None.
Tiers	A list containing the pricing tiers for the item.	Collection of Tier	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "PricingSheetName": "sample string 2",
  "PricingSheetNumber": "sample string 3",
  "ItemCode": "sample string 4",
  "Tiers": [
    {
      "TieringType": 0,
      "StartingQuantity": 1,
      "EndingQuantity": 2,
      "Price": 3.0
    },
    {
      "TieringType": 0,
      "StartingQuantity": 1,
      "EndingQuantity": 2,
      "Price": 3.0
    }
  ]
}

application/xml, text/xml

Sample:

<ItemTierLookupResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CompanyName>sample string 1</CompanyName>
  <PricingSheetName>sample string 2</PricingSheetName>
  <PricingSheetNumber>sample string 3</PricingSheetNumber>
  <ItemCode>sample string 4</ItemCode>
  <Tiers>
    <Tier>
      <TieringType>TotalCount</TieringType>
      <StartingQuantity>1</StartingQuantity>
      <EndingQuantity>2</EndingQuantity>
      <Price>3</Price>
    </Tier>
    <Tier>
      <TieringType>TotalCount</TieringType>
      <StartingQuantity>1</StartingQuantity>
      <EndingQuantity>2</EndingQuantity>
      <Price>3</Price>
    </Tier>
  </Tiers>
</ItemTierLookupResponse>