Documentation

Update Air Waybill Number (AWB)

Last Updated: 2 March 2022

Suggest Edits

Update Air Waybill Number (AWB)

Shipper API gives interface access to our clients for update AWB Number API from their own system to Shipper Order Management System

  • Authorizations : X-API-Key_Header
  • Request Body Schema : application/json

PUT Update Air Waybill Number (AWB)

MethodEndpoint
PUT/v3/fulfillment/outbound/awb

🚧

Important Note

This API can only be used IF when client use Create Sales Order B2C:

  1. express_no is empty
  2. is_logistic_oder is false

Body Request Parameter

FieldData TypeDescriptionNote
order_nostring(50)Order number or sales order number

Example: SALES-OUTBOUND-1X		Mandatory

Fill this with so_number from Create Sales Order B2C payload
warehouse_codestring(20)Warehouse code assigned where SKU stored

Example: WH-TGR04		Mandatory
shipper_order_noString(30)Example: FO202209070622524694Optional
is_logistic_orderBooleanWhether to use shipper logistics to create AWB for these suborders?

If is_logistic_order = true, will use the shipper logistics to generate AWB.

If is_logistic_order = false, will NOT use the shipper logistics to generate AWB.

Note: Please leave this empty if you do not know how to use this field.		Optional
express_codeString(40)Courier

Example: JNE CTC		Optional
express_nostring(60)Air Waybill Number from

Example: 10004450572511		If is_logistic_order =
- 'false' then this field is mandatory
- 'true' then please leave it blank
shipping_label_urlstring(512)Example:
https:// xxxxx-public.oss-ap-xxxxxxx.aliyuncs.com/SHOPEEID
20231020165756036_5621836912.pdf		Optional

If you have the shipping label URL, please input it.

If you do not have the shipping label URL and only have the AWB, then the shipper warehouse could only print our WMS default format. But sometimes, 3PL will not accept the default format label.

Please ensure the URL will not expire and can be opened properly.

Sample Body Request

HeaderHow to Fill
x-api-keyShipper API Key
{
  "data": {
    "update_awb": {
      "express_no": "10004450572511",
      "order_no": "SALES-OUTBOUND-1X",
      "warehouse_code": "WH-TGR04"
    }
  }
}

{
  "data": {
    "update_awb": {
      "express_no": "10004450572511",
      "order_no": "SALES-OUTBOUND-1X",
      "warehouse_code": "WH-TGR04"
    }
  }
}

Sample Response

HeaderHow to Fill
x-request-idRequest ID generated from Shipper for tracking purposes
{
  "metadata": {
    "path": "/v1/fulfillment/outbound/oms/awb",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1652317421
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/oms/awb",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "Failed to update AWB. Order is not found."
      }
    ],
    "timestamp": 1652317421
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/oms/awb",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 800,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1652318337
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/oms/awb",
    "http_status_code": 500,
    "http_status": "Internal Server Error",
    "errors": [
      {
        "code": 803,
        "message": "Internal Server error."
      }
    ],
    "timestamp": 1637555484
  }
}
StatusReason
200Update AWB number success
400 - Fail. Invalid PayloadUpdate AWB failed because order not found in Shipper Order Management System.

Please make sure your inputs are correct.
400 - Invalid/Inactive API KeyPlease check whether your API Key is valid and still active.
500Something wrong with Shipper application.
Please contact Shipper representative.

Updated about 1 year ago