Add an External Box Code

Use this method to set an external code to a specific array of box codes in Komet Sales.

Valid Tokens: Company

Related Articles

Request


URL: https://api.kometsales.com/api/box.externalcode.update

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


boxes (required)(array)

An array containing the items that will be updated.


boxCode (required)(string:20)

The box code that you want to update.


externalCode (required)(string:20)

The external box code.


{ "authenticationToken": "token_info_goes_here", "boxes": [ { "boxCode":"KS001001", "externalCode":"PT991001" }, { "boxCode":"KS001002", "externalCode":"PT991002" }, { "boxCode":"KS001003", "externalCode":"PT991003" } ] }

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


boxes (array)

An array containing boxes with their corresponding transaction results.


boxCode (string:20)

The box code given in the input parameters.


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


{ "status": "1", "message": "2 boxes were successfully updated. 1 boxes could not be updated", "boxes": [ { "boxCode":"KS001001", "status":"1", "message":"success" }, { "boxCode":"KS001002", "status":"1", "message":"success" }, { "boxCode":"KS001003", "status":"0", "message":"Box code does not exist" } ] }

Peacock