POST api/v1/HoldingOrderAdd

Special routine to add data to Caliq holding order - not normally used

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
WebOrderRef	Website Order reference	string	Required Max length: 50
ChannelID	List of channels can be retrieved via API	integer	Required
AccountNo	User entered unique customer account number	string	Required Max length: 10
Line1	Ordering customer address line 1	string	Required Max length: 50
Line2		string	Max length: 50
Line3		string	Max length: 50
Town		string	Max length: 50
County		string	Max length: 25
Postcode		string	Max length: 15
Country	Country code from the country list ISO3	string	Max length: 3
Firstname		string	Required Max length: 20
Surname		string	Required Max length: 30
Email		string	Required Max length: 70
Phone		string	Max length: 20
Mobile		string	Max length: 20
OrderLines		HoldingOrderLines	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WebOrderRef": "sample string 2",
  "ChannelID": 3,
  "AccountNo": "sample string 4",
  "Line1": "sample string 5",
  "Line2": "sample string 6",
  "Line3": "sample string 7",
  "Town": "sample string 8",
  "County": "sample string 9",
  "Postcode": "sample string 10",
  "Country": "sample string 11",
  "Firstname": "sample string 12",
  "Surname": "sample string 13",
  "Email": "sample string 14",
  "Phone": "sample string 15",
  "Mobile": "sample string 16",
  "OrderLines": {
    "OrderLine": [
      {
        "ProductCode": "sample string 1",
        "Quantity": 2,
        "UnitPrice": 3.0,
        "LineRef": "sample string 4"
      },
      {
        "ProductCode": "sample string 1",
        "Quantity": 2,
        "UnitPrice": 3.0,
        "LineRef": "sample string 4"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<HoldingOrderAddParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <WebOrderRef>sample string 2</WebOrderRef>
  <ChannelID>3</ChannelID>
  <AccountNo>sample string 4</AccountNo>
  <Line1>sample string 5</Line1>
  <Line2>sample string 6</Line2>
  <Line3>sample string 7</Line3>
  <Town>sample string 8</Town>
  <County>sample string 9</County>
  <Postcode>sample string 10</Postcode>
  <Country>sample string 11</Country>
  <Firstname>sample string 12</Firstname>
  <Surname>sample string 13</Surname>
  <Email>sample string 14</Email>
  <Phone>sample string 15</Phone>
  <Mobile>sample string 16</Mobile>
  <OrderLines>
    <HoldingOrderLine>
      <ProductCode>sample string 1</ProductCode>
      <Quantity>2</Quantity>
      <UnitPrice>3</UnitPrice>
      <LineRef>sample string 4</LineRef>
    </HoldingOrderLine>
    <HoldingOrderLine>
      <ProductCode>sample string 1</ProductCode>
      <Quantity>2</Quantity>
      <UnitPrice>3</UnitPrice>
      <LineRef>sample string 4</LineRef>
    </HoldingOrderLine>
  </OrderLines>
</HoldingOrderAddParams>

Response Information

Resource Description

Returns:
200 OK Returns created internal order ID and order number
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable
Messages returned for error: 1,2,3,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,41,46

OrderCreateResults

Name	Description	Type	Additional information
OrderCreateData		OrderCreateData	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderCreateData": {
    "OK": true,
    "OrderID": 2,
    "OrderNo": 3,
    "OrderCreateIssues": [
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      },
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<OrderCreateResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderCreateData>
    <OK>true</OK>
    <OrderID>2</OrderID>
    <OrderNo>3</OrderNo>
    <OrderCreateIssues>
      <OrderCreateIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </OrderCreateIssue>
      <OrderCreateIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </OrderCreateIssue>
    </OrderCreateIssues>
  </OrderCreateData>
</OrderCreateResults>