POST api/v1/WH_Relocate

Relocate stock from one bin to 1 or more others

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
WarehouseID		integer	Required
EmployeeID		string	Max length: 10
FromBinNo	Relocate stock from one bin to 1 or more others<br /> From and to bins can be populated with real bins if sending the full relocate in 1 call If splitting into a 'pick' and 'locate' call the stock will sit in the relocate bin while in between locations. In that case the 'pick' call should have a real "FromBin" but the destimation bins can be omitted The "locate" call can leave the "FromBin" empty but the "to" bins should be populated	string	Max length: 14
PartNo		string	Max length: 25
Qty		decimal number	None.
WH_RelocateToBins		Collection of WH_RelocateToBin	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "EmployeeID": "sample string 3",
  "FromBinNo": "sample string 4",
  "PartNo": "sample string 5",
  "Qty": 6.0,
  "WH_RelocateToBins": [
    {
      "BinNo": "sample string 1",
      "Qty": 2.0
    },
    {
      "BinNo": "sample string 1",
      "Qty": 2.0
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Relocate_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>
  <EmployeeID>sample string 3</EmployeeID>
  <FromBinNo>sample string 4</FromBinNo>
  <PartNo>sample string 5</PartNo>
  <Qty>6</Qty>
  <WH_RelocateToBins>
    <WH_RelocateToBin>
      <BinNo>sample string 1</BinNo>
      <Qty>2</Qty>
    </WH_RelocateToBin>
    <WH_RelocateToBin>
      <BinNo>sample string 1</BinNo>
      <Qty>2</Qty>
    </WH_RelocateToBin>
  </WH_RelocateToBins>
</WH_Relocate_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_Relocate_Results

Name	Description	Type	Additional information
OK	If true the action was successfully processed	boolean	None.
WH_Relocate_Results_Issues	List of validation issues with the data supplied	Collection of WH_Relocate_Results_Issue	None.

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "WH_Relocate_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_Relocate_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <WH_Relocate_Results_Issues>
    <WH_Relocate_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Relocate_Results_Issue>
    <WH_Relocate_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Relocate_Results_Issue>
  </WH_Relocate_Results_Issues>
</WH_Relocate_Results>