Versions Compared

Key

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

Use this method to add several Purchase Order Items to an AWB.

Tip

Valid Tokens: Company and Vendor.

Note

Make sure that every product sent through this method has been mapped in your company. Products marked as UNKNOWN will not be added.


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

Request


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

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


poItems (required)(array)

An array containing a list of PO Items that you are adding to the AWB.


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.

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


lotNumber (optional)(integer:5string)

Lot number of the PO item you are shipping.

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.


vendorId (optional)(integer:20)

Komet Sales internal Vendor ID.

This parameter is required if you are using a Company Token.


Code Block
{
   "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


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


purchaseOrderItemDetailsAWBAddAPIResultList (array)

An array containing PO Items and transaction results.


poItemId (integer:20)

Komet Sales internal PO Item ID.


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 by the system.


lotNumber (integer:10string)

PO Item Lot number.


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
}
We've encountered an issue exporting this macro. Please try exporting this page again later.