POST api/v1/APACDailyOrder

APAC Specific - Allows updating of APAC holding order and also despatch confirmations

Request Information

URI Parameters

None.

Body Parameters

APACDailyOrderParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
Mode

(DESP)atched, (HOLD)ing order update

 string

Required

Max length: 4
APACDailyOrderLines

APACDailyOrderLines

None.

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1",
  "Mode": "sample string 2",
  "APACDailyOrderLines": {
    "APACDailyOrderLine": [
      {
        "ProductID": 1,
        "ProductCode": "sample string 2",
        "Quantity": 3,
        "UnitPrice": 4.0,
        "WebOrderRef": "sample string 5"
      },
      {
        "ProductID": 1,
        "ProductCode": "sample string 2",
        "Quantity": 3,
        "UnitPrice": 4.0,
        "WebOrderRef": "sample string 5"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<APACDailyOrderParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <Mode>sample string 2</Mode>
  <APACDailyOrderLines>
    <APACDailyOrderLine>
      <ProductID>1</ProductID>
      <ProductCode>sample string 2</ProductCode>
      <Quantity>3</Quantity>
      <UnitPrice>4</UnitPrice>
      <WebOrderRef>sample string 5</WebOrderRef>
    </APACDailyOrderLine>
    <APACDailyOrderLine>
      <ProductID>1</ProductID>
      <ProductCode>sample string 2</ProductCode>
      <Quantity>3</Quantity>
      <UnitPrice>4</UnitPrice>
      <WebOrderRef>sample string 5</WebOrderRef>
    </APACDailyOrderLine>
  </APACDailyOrderLines>
</APACDailyOrderParams>

Response Information

Resource Description

Returns:
200 OK
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: 3,4,5,18,24,44,45

APACDailyOrderResults
NameDescriptionTypeAdditional information
APACDailyOrderData

APACDailyOrderData

None.

Response Formats

application/json, text/json

Sample: 
{
  "APACDailyOrderData": {
    "OK": true,
    "APACDailyOrderIssues": [
      {
        "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: 
<APACDailyOrderResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APACDailyOrderData>
    <OK>true</OK>
    <APACDailyOrderIssues>
      <APACDailyOrderIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </APACDailyOrderIssue>
      <APACDailyOrderIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </APACDailyOrderIssue>
    </APACDailyOrderIssues>
  </APACDailyOrderData>
</APACDailyOrderResults>