Request
URL: https://api.kometsales.com/api/box.code.change
Method: POST
Content-Type: application/JSON
Input Parameters
authenticationToken (required)(string:50)
Komet Sales security token.
boxes (required)(array)
Array of items to update.
currentBoxCode (required)(string:20)
The current Box Code.
newBoxCode (required)(string:20)
The new Box Code.
Code Block |
---|
{ "authenticationToken": "token_info_goes_here", "boxes": [ { "currentBoxCode": "KS001001", "newBoxCode": "PT991001" }, { "currentBoxCode": "KS001002", "newBoxCode": "PT991002" }, { "currentBoxCode": "KS001003", "newBoxCode": "PT991003" } ] } |
Response
Output
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure.
message (string:500)
Transaction status description.
boxes (array)
The Box array with corresponding transaction results.
newBoxCode (string:20)
The new Box code given in the input parameters.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
Code Block |
---|
{ "status": "1", "message": "2 boxes were successfully updated. 1 boxes could not be updated", "boxes": [ { "newBoxCode": "PT991001", "status": "1", "message": "success" }, { "newBoxCode": "PT991002", "status": "1", "message": "success" }, { "newBoxCode": "PT991003", "status": "0", "message": "Box code does not exist" } ] } |