POST api/v1/WH_Deliverable_Move

Change handling area for a deliverable

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
DeliverableID	Caliq unique shipment identifier	integer	Required
HandlingArea		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "DeliverableID": 2,
  "HandlingArea": 3
}

application/xml, text/xml

Sample:

<WH_Deliverable_Move_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <DeliverableID>2</DeliverableID>
  <HandlingArea>3</HandlingArea>
</WH_Deliverable_Move_Params>

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: 88,90

WH_Deliverable_Move_Results

Name	Description	Type	Additional information
OK		boolean	None.
WH_Deliverable_Move_Results_Issues		Collection of WH_Deliverable_Move_Results_Issue	None.

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "WH_Deliverable_Move_Results_Issues": [
    {
      "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:

<WH_Deliverable_Move_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <WH_Deliverable_Move_Results_Issues>
    <WH_Deliverable_Move_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Deliverable_Move_Results_Issue>
    <WH_Deliverable_Move_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Deliverable_Move_Results_Issue>
  </WH_Deliverable_Move_Results_Issues>
</WH_Deliverable_Move_Results>