Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This method allows you to add several PO items to an AWB at the same time.
Request
URL: https://api.kometsales.com/api/purchase.order.items.awb.add
Method: POST
Content-Type: application/
jsonJSON
Input Parameters
:authenticationToken (required)(string:50): Komet Sales security token.
poItems (required)(array): List of PO Items that you want to add to the AWB
poItemId (required)(integer:20): Komet Sales internal ID of the PO item that you want to ship. You can obtain this value from the purchase.order.list API method.
- awb
awb (required) (string): AWB number.
shipDate (required) (date): The date when vendor ships the product, date format YYYY-MM-DD.
boxCodes (optional)(array:5): Array of box codes that you want to ship. If this array is not provided, the system will automatically assign the codes to the boxes.
lotNumber (optional) (integer:5): Lot number that you want to set to the PO item being shipped in this transaction. This lot number cannot be between the numbers used by Komet Sales which normally
theyare between 1000 and 99999. If you want to use this same range, please contact the Komet Sales support team.
Sample Request
Code Block | |
---|---|
js | |
theme | Confluence |
title | Sample | { { "authenticationToken": "7hnn2h48sh28jsk8", "poItems": [ { "poItemId": 7828, "awb": "08472-4772-0048", "shipDate": "2016-07-22", "boxCodes": [ "73992893", "73992894", "73992895" ], "lotNumber": "234232" }, { "poItemId": 7829, "awb": "08472-4772-0048", "shipDate": "2016-07-22", "boxCodes": [ "73992801", "73992802", "73992803" ], "lotNumber": "234233" } ] } |
Response
Output
:status (integer:1): transaction status. 1 for success or 0 for failure.
purchaseOrderItemDetailsAWBAddAPIResultList: array of results.
poItemId (integer:20): Komet Sales internal ID of the PO item added to the ship.
status (integer:1): transaction status. 1 for success or 0 for failure.
message (string:500): description of the status of the transaction.
boxCodes (array): Array of box codes created in the system.
lotNumber (integer:10): lot number generated for the PO item shipped.
Sample Response
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ { "purchaseOrderItemDetailsAWBAddAPIResultList": [ { "poItemId": 7828, "status": 1, "message": "OK", "identifier": null, "boxCodes": [ "73992801", "73992802", "73992803" ], "lotNumber": "234233" }, { "poItemId": 7829, "status": 1, "message": "OK", "identifier": null, "boxCodes": [ "73992801", "73992802", "73992803" ], "lotNumber": "234233" } ], "status": 1 } |
Note |
---|
Make sure that all of the products sent through this method have already been mapped in the company. Products marked as UNKNOWN are not added. |
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
| ||||||||||||||
Warning | ||||||||||||||
| ||||||||||||||
Make sure that all of the products sent through this method have already been mapped in the company. Products marked as UNKNOWN will be skipped. |