Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to add an existing PO item to an AWB.

Tip

Valid Tokens: Company and Vendor.

Note

Make sure that all of the products sent through this method have already been mapped in the company. Products marked as UNKNOWN not be added.


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "awb" , "awb-api" , "purchase-orders" )

Request


URL: https://api.kometsales.com/api/purchase.order.item.awb.add

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


poItemId (required)(integer:20)

Komet Sales internal PO Item ID.

You can get this value from the purchase.order.list API method.


awb (required)(string)

AWB number.


shipDate (required)(date)

Vendor shipping date.

Date format: YYYY-MM-DD


boxCodes (optional)(array:5)

An array containing box codes that you are shipping.

If this array is not provided, the system will automatically assign the codes to the boxes.


lotNumber (optional)(integer:5string)

PO Item Lot Number that the system will assign to the item you are adding.

This lot number cannot be between the numbers used by Komet Sales which normally are between 1000 and 99999.  

If you want to use this same range, please contact the Komet Sales support team.


Code Block
{
   "authenticationToken": "7hnn2h48sh28jsk8",
   "poItemId": 7828,
   "awb": "08472-4772-0048",
   "shipDate": "2016-07-22",
   "boxCodes": [
      "73992893",
      "73992894",
      "73992895"
   ],
   "lotNumber": "234232"
}

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


boxCodes (array)

An array containing box codes created in the system.


newPOItemId (integer:20)

Purchase Order Item ID.
It only applies if the number of sent boxes is lower than the purchased ones.


Code Block
{
   "status": 1,
   "message": "OK",
   "boxCodes": [
      "73992893",
      "73992894",
      "73992895"
   ]
}
We've encountered an issue exporting this macro. Please try exporting this page again later.