POST api/v1/PriceListRRP

Retrieve RRP prices for all products, for specific currency or all
Optionally just return prices for a collection of part numbers or ID's

Request Information

URI Parameters

None.

Body Parameters

PriceListParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
Currency	Currency to retrieve price for. Leave blank for all matching	string	Required Max length: 3
ExcludeCustomerPrices	When calling (N)ormal, set to true to suppress returning of customer specific price lists	boolean	None.
CustomerIDs	When calling (N)ormal,The list of customer IDs you want returned where the customer has custom pricing, can be empty if using codes	Collection of integer	None.
AccountNumbers	When calling (N)ormal,The list of account numbers you want returned where the customer has custom pricing, can be empty if using ID's	Collection of string	None.
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:

{
  "CustomerIDs": [
    1,
    2
  ],
  "AccountNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "ProductIDs": [
    1,
    2
  ],
  "ProductCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "apiKey": "sample string 1",
  "Currency": "sample string 2",
  "ExcludeCustomerPrices": true
}

application/xml, text/xml

Sample:

<PriceListParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerIDs>
    <int>1</int>
    <int>2</int>
  </CustomerIDs>
  <AccountNumbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </AccountNumbers>
  <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>
  <Currency>sample string 2</Currency>
  <ExcludeCustomerPrices>true</ExcludeCustomerPrices>
</PriceListParams>

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

PriceLists

Name	Description	Type	Additional information
PriceDetail		Collection of PriceList	None.

Response Formats

application/json, text/json

Sample:

{
  "PriceDetail": [
    {
      "ID": 1,
      "Currency": "sample string 2",
      "Type": "sample string 3",
      "Source": "sample string 4",
      "Description": "sample string 5",
      "VATInc": true,
      "Items": {
        "ItemPLDetail": [
          {
            "ID": 1,
            "Code": "sample string 2",
            "Q": 3,
            "P": 4.0,
            "W": 5.0,
            "C": true,
            "POA": true
          },
          {
            "ID": 1,
            "Code": "sample string 2",
            "Q": 3,
            "P": 4.0,
            "W": 5.0,
            "C": true,
            "POA": true
          }
        ]
      },
      "PLCusts": {
        "PLCustDetail": [
          {
            "ID": 1,
            "AccountNo": "sample string 2"
          },
          {
            "ID": 1,
            "AccountNo": "sample string 2"
          }
        ]
      }
    },
    {
      "ID": 1,
      "Currency": "sample string 2",
      "Type": "sample string 3",
      "Source": "sample string 4",
      "Description": "sample string 5",
      "VATInc": true,
      "Items": {
        "ItemPLDetail": [
          {
            "ID": 1,
            "Code": "sample string 2",
            "Q": 3,
            "P": 4.0,
            "W": 5.0,
            "C": true,
            "POA": true
          },
          {
            "ID": 1,
            "Code": "sample string 2",
            "Q": 3,
            "P": 4.0,
            "W": 5.0,
            "C": true,
            "POA": true
          }
        ]
      },
      "PLCusts": {
        "PLCustDetail": [
          {
            "ID": 1,
            "AccountNo": "sample string 2"
          },
          {
            "ID": 1,
            "AccountNo": "sample string 2"
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<PriceLists xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PriceList>
    <ID>1</ID>
    <Currency>sample string 2</Currency>
    <Type>sample string 3</Type>
    <Source>sample string 4</Source>
    <Description>sample string 5</Description>
    <VATInc>true</VATInc>
    <Items>
      <Item>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Q>3</Q>
        <P>4</P>
        <W>5</W>
        <C>true</C>
        <POA>true</POA>
      </Item>
      <Item>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Q>3</Q>
        <P>4</P>
        <W>5</W>
        <C>true</C>
        <POA>true</POA>
      </Item>
    </Items>
    <PLCusts>
      <PLCust>
        <ID>1</ID>
        <AccountNo>sample string 2</AccountNo>
      </PLCust>
      <PLCust>
        <ID>1</ID>
        <AccountNo>sample string 2</AccountNo>
      </PLCust>
    </PLCusts>
  </PriceList>
  <PriceList>
    <ID>1</ID>
    <Currency>sample string 2</Currency>
    <Type>sample string 3</Type>
    <Source>sample string 4</Source>
    <Description>sample string 5</Description>
    <VATInc>true</VATInc>
    <Items>
      <Item>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Q>3</Q>
        <P>4</P>
        <W>5</W>
        <C>true</C>
        <POA>true</POA>
      </Item>
      <Item>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Q>3</Q>
        <P>4</P>
        <W>5</W>
        <C>true</C>
        <POA>true</POA>
      </Item>
    </Items>
    <PLCusts>
      <PLCust>
        <ID>1</ID>
        <AccountNo>sample string 2</AccountNo>
      </PLCust>
      <PLCust>
        <ID>1</ID>
        <AccountNo>sample string 2</AccountNo>
      </PLCust>
    </PLCusts>
  </PriceList>
</PriceLists>