POST api/v1/WH_Deliverable_PutAway

Relocate stock from deliverable

Request Information

URI Parameters

None.

Body Parameters

WH_Deliverable_PutAway_Params
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

string

Required

WarehouseID

integer

Required

DeliverableID

integer

Required

ShipmentID

Caliq unique shipment identifier

integer

Required

ShipmentLineID

Caliq unique shipment line identifier

integer

Required

EmployeeID

string

Max length: 10

PartNo

string

Max length: 25

Qty

decimal number

None.

WH_PutAwayToBins

Collection of WH_PutAwayToBin

None.

Request Formats

application/json, text/json

Sample:
{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "DeliverableID": 3,
  "ShipmentID": 4,
  "ShipmentLineID": 5,
  "EmployeeID": "sample string 6",
  "PartNo": "sample string 7",
  "Qty": 8.0,
  "WH_PutAwayToBins": [
    {
      "BinNo": "sample string 1",
      "Qty": 2.0
    },
    {
      "BinNo": "sample string 1",
      "Qty": 2.0
    }
  ]
}

application/xml, text/xml

Sample:
<WH_Deliverable_PutAway_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <WarehouseID>2</WarehouseID>
  <DeliverableID>3</DeliverableID>
  <ShipmentID>4</ShipmentID>
  <ShipmentLineID>5</ShipmentLineID>
  <EmployeeID>sample string 6</EmployeeID>
  <PartNo>sample string 7</PartNo>
  <Qty>8</Qty>
  <WH_PutAwayToBins>
    <WH_PutAwayToBin>
      <BinNo>sample string 1</BinNo>
      <Qty>2</Qty>
    </WH_PutAwayToBin>
    <WH_PutAwayToBin>
      <BinNo>sample string 1</BinNo>
      <Qty>2</Qty>
    </WH_PutAwayToBin>
  </WH_PutAwayToBins>
</WH_Deliverable_PutAway_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: 4,73,77,78,79,80

WH_Deliverable_PutAway_Results
NameDescriptionTypeAdditional information
OK

If true the action was successfully processed

boolean

None.

WH_Deliverable_PutAway_Results_Issues

List of validation issues with the data supplied

Collection of WH_Deliverable_PutAway_Results_Issue

None.

Response Formats

application/json, text/json

Sample:
{
  "OK": true,
  "WH_Deliverable_PutAway_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_PutAway_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <WH_Deliverable_PutAway_Results_Issues>
    <WH_Deliverable_PutAway_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Deliverable_PutAway_Results_Issue>
    <WH_Deliverable_PutAway_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Deliverable_PutAway_Results_Issue>
  </WH_Deliverable_PutAway_Results_Issues>
</WH_Deliverable_PutAway_Results>