POST api/v1/Price

Retrieve the price data for specific products, customer and quantity combination

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
AccountNo	Customer account number to get price for	string	Required
Currency	Currency to retrieve price for	string	Required Max length: 3
CustomerID	Customer ID to get price for	integer	Required
Quantity	How many does the customer want to buy?	integer	Required
ProductIDs	The list of product IDs you want returned, can be empty if using codes	Collection of integer	None.
ProductCodes	The list of product Codes you want returned, can be empty if using ID's	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductIDs": [
    1,
    2
  ],
  "ProductCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "apiKey": "sample string 1",
  "AccountNo": "sample string 2",
  "Currency": "sample string 3",
  "CustomerID": 4,
  "Quantity": 5
}

application/xml, text/xml

Sample:

<PriceParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductIDs>
    <int>1</int>
    <int>2</int>
  </ProductIDs>
  <ProductCodes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ProductCodes>
  <apiKey>sample string 1</apiKey>
  <AccountNo>sample string 2</AccountNo>
  <Currency>sample string 3</Currency>
  <CustomerID>4</CustomerID>
  <Quantity>5</Quantity>
</PriceParams>

Response Information

Resource Description

Returns:
200 OK Returns price data as XML or JSON
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

ItemPriceData

Name	Description	Type	Additional information
PriceDetail		Collection of ItemPrice	None.

Response Formats

application/json, text/json

Sample:

{
  "PriceDetail": [
    {
      "OK": true,
      "ID": 2,
      "Code": "sample string 3",
      "Price": 4.0,
      "Promo": 5.0,
      "List": 6.0,
      "RRP": 7.0,
      "POA": true
    },
    {
      "OK": true,
      "ID": 2,
      "Code": "sample string 3",
      "Price": 4.0,
      "Promo": 5.0,
      "List": 6.0,
      "RRP": 7.0,
      "POA": true
    }
  ]
}

application/xml, text/xml

Sample:

<ItemPriceData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ItemPrice>
    <OK>true</OK>
    <ID>2</ID>
    <Code>sample string 3</Code>
    <Price>4</Price>
    <Promo>5</Promo>
    <List>6</List>
    <RRP>7</RRP>
    <POA>true</POA>
  </ItemPrice>
  <ItemPrice>
    <OK>true</OK>
    <ID>2</ID>
    <Code>sample string 3</Code>
    <Price>4</Price>
    <Promo>5</Promo>
    <List>6</List>
    <RRP>7</RRP>
    <POA>true</POA>
  </ItemPrice>
</ItemPriceData>