Versions Compared

Key

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

Use this method to create or update a Future AWB.

Tip

Valid Tokens: Company


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "awb" , "awb-for-the-future" , "awb-future-list" , "awb-invoice" , "shipping" )

Request


URL: https://api.kometsales.com/api/awb.future.save

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


originCode (required)(string:5)

Origin code.


shipDate (required)(date)

AWB Shipping Date.

Date format: YYYY-MM-DD


awb (required)(integer:15)

AWB number.

If the AWB number already exists, the system will add the instructions to the existing AWB and ignore the shipDate and originCode parameters.


instructions (optional)(string)

Instructions for the AWB.


houses (required)(array)

An array containing houses to add in the AWB.


house (required)(string:20)

House number.

If the house number already exists, the system will update the locationCode, vendorCode, and instructions for the AWB as set up in the house.


vendorCode (required)(string:20)

Vendor code.

You can get this value from the vendor.list method.


locationCode (optional)(string:20)

Location code.

Only applies to Multi-Location Companies.

You can get this value from the location.list method.


instructions (optional)(string:50)

Instructions for the house.


Code Block
{
  "authenticationToken": "token_info_goes_here",
  "originCode": "UIO",
  "shipDate": "2017-11-15",
  "awb": "234-2367-0983",
  "instructions": "awb changed, previous AWB 4567",
  "houses": [
    {
      "house": "CM-93242111",
      "vendorCode": "ABC",
      "locationCode": "06",
      "instructions": "use for customer HJS"
    },
    {
      "house": "CM-3242378",
      "vendorCode": "HUJ",
      "locationCode": "09",
      "instructions": "use for customer JAB"
    }
  ]
}

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


Code Block
{
  "status": "1",
  "message": "success",
}

We've encountered an issue exporting this macro. Please try exporting this page again later.