POST api/v1/StockAdjustment

Make a stock adjustment in Caliq

Request Information

URI Parameters

None.

Body Parameters

StockAdjustmentParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
Code

Unique part number

 string

Required

Max length: 25
WHID

ID of warehouse - contact Caliq for details

 integer

Required
Qty

Qty to adjust by. + or -

 integer

Required
ReasonCode

Reason code - contact Caliq for details part number

 string

Required

Max length: 5
Ref1

Reference 1

 string

Max length: 15
Ref2

Reference 2

 string

Max length: 15
Ref3

Reference 3

 string

Max length: 50

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1",
  "Code": "sample string 2",
  "WHID": 3,
  "Qty": 4,
  "ReasonCode": "sample string 5",
  "Ref1": "sample string 6",
  "Ref2": "sample string 7",
  "Ref3": "sample string 8"
}

application/xml, text/xml

Sample: 
<StockAdjustmentParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <Code>sample string 2</Code>
  <WHID>3</WHID>
  <Qty>4</Qty>
  <ReasonCode>sample string 5</ReasonCode>
  <Ref1>sample string 6</Ref1>
  <Ref2>sample string 7</Ref2>
  <Ref3>sample string 8</Ref3>
</StockAdjustmentParams>

Response Information

Resource Description

Returns:
200 OK Returns error list if failed
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,74,75,76

StockAdjResults
NameDescriptionTypeAdditional information
StockAdjResult

StockAdjResult

None.

Response Formats

application/json, text/json

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