Scan Form

POST

scanform/

Call this API to push data for the USPS ScanForm service or the clearance & dispatch service. After the push is completed, the order node will be: Order Confirmation - Success.
This API is asynchronous. After execution, please go to the result API to query the outcome.

Return to guide

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Example>flightExample>handover

{
    "reference_num": "TR20250112-6",
    "flight_info": {
        "mawb_no": "123-20260107",
        "flight_no": "CA1202",
        "etd": "2025-12-23 08:12:01",
        "eta": "2025-12-23 12:12:01",
        "departure_port": "SZX",
        "transit_port": "TAP",
        "arrival_port": "ICN",
        "transit_etd": "2025-12-23 10:12:01",
        "transit_eta": "2025-12-23 11:12:01",
        "transit_flight_no": "BA129"
    },
    "weight": 11.11,
    "net_weight": 13.21,
    "customer_order_num": [
        "HGE260107000087K",
        "HGE260107000088Z"
    ]
}

Request Code Samples

Shell

HTTP

Python

Java

PHP

JavaScript

Swift

Dart

Objective-C

Ruby

OCaml

cURL

Example>flightExample>handover

curl --location --request POST 'scanform/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference_num": "TR20250112-6",
    "flight_info": {
        "mawb_no": "123-20260107",
        "flight_no": "CA1202",
        "etd": "2025-12-23 08:12:01",
        "eta": "2025-12-23 12:12:01",
        "departure_port": "SZX",
        "transit_port": "TAP",
        "arrival_port": "ICN",
        "transit_etd": "2025-12-23 10:12:01",
        "transit_eta": "2025-12-23 11:12:01",
        "transit_flight_no": "BA129"
    },
    "weight": 11.11,
    "net_weight": 13.21,
    "customer_order_num": [
        "HGE260107000087K",
        "HGE260107000088Z"
    ]
}'

Responses

🟢200OK

application/json

Body

Example

{
    "code": 102,
    "success": true,
    "detail": "The submission is processing; please check the execution result query endpoint.",
    "data": {
        "reference_num": "TR20250112-6"
    }
}

🟠401Unauthorized

🔴500Internal Server Error

🟠400Bad Request

🟠404Not Found

Print Container label

Get Scan Form Result