Confirm a Shipment

Use this method to confirm a partial set of boxes from an order has been shipped.

Valid Tokens: Company.

 

Related Articles

Request


URL: https://api.kometsales.com/api/box.invoice.shipment.confirm

Method: POST

Content-Type: URL Parameters


Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.


orderNumber (required)(integer:10)

The Komet Sales order number.

You can get this value from the invoice.details.list API method.


boxCodes (required)(string:200)

The list of Komet Sales box codes that belong to the order and will be marked as Shipped. These codes must be separated by commas.

You can get this value from the invoice.details.list API method.


{ "authenticationToken": "token_info_goes_here", "orderNumber": 212199, "boxCodes": [ "KS5704495","KS5704496"] }

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


updatedBoxes (integer:10)

The number of boxes that were successfully confirmed


{ "status": "1", "message": "success", "updatedBoxes" : "25" }

 


Peacock