POST api/v1/WH_StockAdjustment_StoresReturn

Make a stores return adjustment (add to) to a bin qty

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
BinNo		string	Max length: 14
PartNo		string	Max length: 25
Qty	If doing a stock adjustment this should be positive (add stock to bin) or negative (remove from bin). For all other stores transactions it should be positive	decimal number	None.
Ref1		string	Max length: 15
Ref2		string	Max length: 15
Ref3		string	Max length: 50
ReasonCode		string	Max length: 5

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "EmployeeID": "sample string 3",
  "BinNo": "sample string 4",
  "PartNo": "sample string 5",
  "Qty": 6.0,
  "Ref1": "sample string 7",
  "Ref2": "sample string 8",
  "Ref3": "sample string 9",
  "ReasonCode": "sample string 10"
}

application/xml, text/xml

Sample:

<WH_StockAdjustment_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>
  <BinNo>sample string 4</BinNo>
  <PartNo>sample string 5</PartNo>
  <Qty>6</Qty>
  <Ref1>sample string 7</Ref1>
  <Ref2>sample string 8</Ref2>
  <Ref3>sample string 9</Ref3>
  <ReasonCode>sample string 10</ReasonCode>
</WH_StockAdjustment_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of reason codes
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,5,73,74,75,77,78,81,82

WH_StockAdjustment_Results

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

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "WH_StockAdjustment_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_StockAdjustment_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <WH_StockAdjustment_Results_Issues>
    <WH_StockAdjustment_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_StockAdjustment_Results_Issue>
    <WH_StockAdjustment_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_StockAdjustment_Results_Issue>
  </WH_StockAdjustment_Results_Issues>
</WH_StockAdjustment_Results>