POST api/v1/OrderLine

Retrieve the breakdown of a specific order, credit or customer return
You can send either order number or order ID dending on what you have stored

Request Information

URI Parameters

None.

Body Parameters

OrderBreakdownParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
OrderID	Internal Id of the order you want details for	integer	None.
OrderNo	Order number of the order you want details for. If using number rather than ID you MUST supply order type	integer	None.
OrderType	Retrieved in data when calling for order list. Order/Credit/Return	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "OrderNo": 2,
  "OrderType": "sample string 3",
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<OrderBreakdownParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderID>1</OrderID>
  <OrderNo>2</OrderNo>
  <OrderType>sample string 3</OrderType>
  <apiKey>sample string 1</apiKey>
</OrderBreakdownParams>

Response Information

Resource Description

Returns:
200 OK Returns a collection of order lines
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested filters dont match any data 503 Service Unavailable

OrderLines

Name	Description	Type	Additional information
OrderLineList		Collection of OrderLine	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderLineList": [
    {
      "OrderID": 1,
      "OrderNumber": 2,
      "LineID": 3,
      "Editable": true,
      "ID": 5,
      "Code": "sample string 6",
      "Description": "sample string 7",
      "Qty": 8,
      "QtyDespatched": 9,
      "QtyAllocated": 10,
      "QtyInWarehouse": 11,
      "QtyInvoiced": 12,
      "QtyProcessed": 13,
      "Status": "sample string 14",
      "Value": 15.0,
      "ValueIncVAT": 16.0,
      "UnitPrice": 17.0,
      "UnitPriceCust": 18.0,
      "UnitPriceList": 19.0,
      "RequiredDate": "sample string 20",
      "EstimatedDate": "sample string 21",
      "EstimatedDateText": "sample string 22",
      "LineText": "sample string 23",
      "IsKitHeader": true,
      "IsKitItem": true,
      "KitParentLineID": 26
    },
    {
      "OrderID": 1,
      "OrderNumber": 2,
      "LineID": 3,
      "Editable": true,
      "ID": 5,
      "Code": "sample string 6",
      "Description": "sample string 7",
      "Qty": 8,
      "QtyDespatched": 9,
      "QtyAllocated": 10,
      "QtyInWarehouse": 11,
      "QtyInvoiced": 12,
      "QtyProcessed": 13,
      "Status": "sample string 14",
      "Value": 15.0,
      "ValueIncVAT": 16.0,
      "UnitPrice": 17.0,
      "UnitPriceCust": 18.0,
      "UnitPriceList": 19.0,
      "RequiredDate": "sample string 20",
      "EstimatedDate": "sample string 21",
      "EstimatedDateText": "sample string 22",
      "LineText": "sample string 23",
      "IsKitHeader": true,
      "IsKitItem": true,
      "KitParentLineID": 26
    }
  ]
}

application/xml, text/xml

Sample:

<OrderLines xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderLine>
    <OrderID>1</OrderID>
    <OrderNumber>2</OrderNumber>
    <LineID>3</LineID>
    <Editable>true</Editable>
    <ID>5</ID>
    <Code>sample string 6</Code>
    <Description>sample string 7</Description>
    <Qty>8</Qty>
    <QtyDespatched>9</QtyDespatched>
    <QtyAllocated>10</QtyAllocated>
    <QtyInWarehouse>11</QtyInWarehouse>
    <QtyInvoiced>12</QtyInvoiced>
    <QtyProcessed>13</QtyProcessed>
    <Status>sample string 14</Status>
    <Value>15</Value>
    <ValueIncVAT>16</ValueIncVAT>
    <UnitPrice>17</UnitPrice>
    <UnitPriceCust>18</UnitPriceCust>
    <UnitPriceList>19</UnitPriceList>
    <RequiredDate>sample string 20</RequiredDate>
    <EstimatedDate>sample string 21</EstimatedDate>
    <EstimatedDateText>sample string 22</EstimatedDateText>
    <LineText>sample string 23</LineText>
    <IsKitHeader>true</IsKitHeader>
    <IsKitItem>true</IsKitItem>
    <KitParentLineID>26</KitParentLineID>
  </OrderLine>
  <OrderLine>
    <OrderID>1</OrderID>
    <OrderNumber>2</OrderNumber>
    <LineID>3</LineID>
    <Editable>true</Editable>
    <ID>5</ID>
    <Code>sample string 6</Code>
    <Description>sample string 7</Description>
    <Qty>8</Qty>
    <QtyDespatched>9</QtyDespatched>
    <QtyAllocated>10</QtyAllocated>
    <QtyInWarehouse>11</QtyInWarehouse>
    <QtyInvoiced>12</QtyInvoiced>
    <QtyProcessed>13</QtyProcessed>
    <Status>sample string 14</Status>
    <Value>15</Value>
    <ValueIncVAT>16</ValueIncVAT>
    <UnitPrice>17</UnitPrice>
    <UnitPriceCust>18</UnitPriceCust>
    <UnitPriceList>19</UnitPriceList>
    <RequiredDate>sample string 20</RequiredDate>
    <EstimatedDate>sample string 21</EstimatedDate>
    <EstimatedDateText>sample string 22</EstimatedDateText>
    <LineText>sample string 23</LineText>
    <IsKitHeader>true</IsKitHeader>
    <IsKitItem>true</IsKitItem>
    <KitParentLineID>26</KitParentLineID>
  </OrderLine>
</OrderLines>