Overview

This method allows you to set an external code to a specific array of box codes in Komet Sales. 

Request

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): array of items that will be updated.
    • boxCode (required)(string:20): box code that you want to update.
    • externalCode (required)(string:20): external box code.

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

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • boxes (array): array of boxes with their corresponding transaction results.
    • boxCode (string:20): box code given in the input parameters.
    • status (integer:1): transaction status. 1 for success or 0 for failure.
    • message (string:500): description of the status of the transaction.

Sample
{
  "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"
       }  
      ]
 }
Related Articles