POST api/pricing/v2/lookup

Requests the pricing for a single item.

Request Information

URI Parameters

None.

Body Parameters

Pricing request

ItemPricingLookupRequest
NameDescriptionTypeAdditional 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
ItemsToPrice

List of items to price

 Collection of ItemPricingRequestItem

Minimum Count: 1

Request Formats

application/json, text/json

Sample: 
{
  "CompanyId": 1,
  "PriceSheetId": 1,
  "PriceAsOf": "2024-12-25T08:57:45.1895928-05:00",
  "ItemsToPrice": [
    {
      "ItemCode": "sample string 1",
      "OriginalCount": 2,
      "CopyCount": 3,
      "WidthInInches": 1.0,
      "LengthInInches": 1.0,
      "SizeInSquareFeet": 1.0
    },
    {
      "ItemCode": "sample string 1",
      "OriginalCount": 2,
      "CopyCount": 3,
      "WidthInInches": 1.0,
      "LengthInInches": 1.0,
      "SizeInSquareFeet": 1.0
    }
  ]
}

application/xml, text/xml

Sample: 
<ItemPricingLookupRequest 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-12-25T08:57:45.1895928-05:00</PriceAsOf>
  <ItemsToPrice>
    <ItemPricingRequestItem>
      <ItemCode>sample string 1</ItemCode>
      <OriginalCount>2</OriginalCount>
      <CopyCount>3</CopyCount>
      <WidthInInches>1</WidthInInches>
      <LengthInInches>1</LengthInInches>
      <SizeInSquareFeet>1</SizeInSquareFeet>
    </ItemPricingRequestItem>
    <ItemPricingRequestItem>
      <ItemCode>sample string 1</ItemCode>
      <OriginalCount>2</OriginalCount>
      <CopyCount>3</CopyCount>
      <WidthInInches>1</WidthInInches>
      <LengthInInches>1</LengthInInches>
      <SizeInSquareFeet>1</SizeInSquareFeet>
    </ItemPricingRequestItem>
  </ItemsToPrice>
</ItemPricingLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Pricing for the specified request

ItemPricingLookupResponse
NameDescriptionTypeAdditional information
CompanyName

The company for which the price was calculated.

 string

None.
PricingSheetName

The name of the pricing sheet used to calculate pricing.

 string

None.
PricingSheetNumber

The number of the pricing sheet used to calcuate pricing.

 string

None.
PricingResponses

The result of the price request.

 Collection of ItemPricingResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "CompanyName": "sample string 1",
  "PricingSheetName": "sample string 2",
  "PricingSheetNumber": "sample string 3",
  "PricingResponses": [
    {
      "ItemCode": "sample string 1",
      "UnitPrice": 2.0,
      "TotalPrice": 3.0,
      "PriceSource": "sample string 4",
      "ItemPriced": true,
      "Error": "sample string 6"
    },
    {
      "ItemCode": "sample string 1",
      "UnitPrice": 2.0,
      "TotalPrice": 3.0,
      "PriceSource": "sample string 4",
      "ItemPriced": true,
      "Error": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample: 
<ItemPricingLookupResponse 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>
  <PricingResponses>
    <ItemPricingResponse>
      <ItemCode>sample string 1</ItemCode>
      <UnitPrice>2</UnitPrice>
      <TotalPrice>3</TotalPrice>
      <PriceSource>sample string 4</PriceSource>
      <ItemPriced>true</ItemPriced>
      <Error>sample string 6</Error>
    </ItemPricingResponse>
    <ItemPricingResponse>
      <ItemCode>sample string 1</ItemCode>
      <UnitPrice>2</UnitPrice>
      <TotalPrice>3</TotalPrice>
      <PriceSource>sample string 4</PriceSource>
      <ItemPriced>true</ItemPriced>
      <Error>sample string 6</Error>
    </ItemPricingResponse>
  </PricingResponses>
</ItemPricingLookupResponse>