1. V2
TW-API-EN
  • Document Description
  • Request
  • Response
  • V2
    • Get the list of delivery channels
      POST
    • Order trial calculation
      POST
    • Order forecast
      POST
    • Prepaid charge
      POST
    • Order status inquiry
      POST
    • Invoice Enquiry
      POST
    • Order details
      POST
    • Download the label
      POST
    • Order deleted
      POST
    • Query the invoice details
      POST
    • Available banlance
      POST
  • T86
    • Query bag information
      POST
    • Delete the package
      POST
    • Create a package
      POST
    • Review bag
      POST
  1. V2

Order forecast

POST
/api/v2/orderForecast
Last modified:2026-01-01 02:21:07
1.
It is prohibited for the same single number to exist in different channels

Status description#

-1:Failure

10:Success

Polling needs to be stopped at this point.

Other states require polling the query results#

Request

Header Params

Body Params application/json

Example
{
    "tickets": [
        {
            "no": "test20240625001",
            "product": "UA",
            "freightClass": "",
            "isSignatureService": 0,
            "signatureType": "INDIRECT",
            "note": "",
            "consignee": "MSP1",
            "boxes": [
                {
                    "number": 2,
                    "weight": 20,
                    "length": 20,
                    "width": 20,
                    "height": 20,
                    "declaredValue": 0,
                    "referenceNumbers": []
                }
            ]
        },
        {
            "no": "test20240625002",
            "product": "UW",
            "freightClass": "",
            "isSignatureService": 0,
            "note": "",
            "consignee": {
                "countryCode": "US",
                "stateProvince": "MN",
                "city": "Shakopee",
                "postcode": "2601 4th Avenue East",
                "address": "55379",
                "address2": "55379",
                "name": "MSP1",
                "companyName": "Amazon.com Services, Inc.",
                "phone": "8-888-8888888"
            },
            "boxes": [
                {
                    "number": 1,
                    "weight": 10,
                    "length": 10,
                    "width": 10,
                    "height": 10,
                    "declaredValue": 0,
                    "referenceNumbers": []
                }
            ],
            "sender": "MSP1"
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v2/orderForecast' \
--header 'key;' \
--header 't;' \
--header 'username;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tickets": [
        {
            "no": "test20240625001",
            "product": "UA",
            "freightClass": "",
            "isSignatureService": 0,
            "signatureType": "INDIRECT",
            "note": "",
            "consignee": "MSP1",
            "boxes": [
                {
                    "number": 2,
                    "weight": 20,
                    "length": 20,
                    "width": 20,
                    "height": 20,
                    "declaredValue": 0,
                    "referenceNumbers": []
                }
            ]
        },
        {
            "no": "test20240625002",
            "product": "UW",
            "freightClass": "",
            "isSignatureService": 0,
            "note": "",
            "consignee": {
                "countryCode": "US",
                "stateProvince": "MN",
                "city": "Shakopee",
                "postcode": "2601 4th Avenue East",
                "address": "55379",
                "address2": "55379",
                "name": "MSP1",
                "companyName": "Amazon.com Services, Inc.",
                "phone": "8-888-8888888"
            },
            "boxes": [
                {
                    "number": 1,
                    "weight": 10,
                    "length": 10,
                    "width": 10,
                    "height": 10,
                    "declaredValue": 0,
                    "referenceNumbers": []
                }
            ],
            "sender": "MSP1"
        }
    ]
}'

Responses

🟢200成功
application/json
Body

Example
{
    "code": 200,
    "message": "OK",
    "data": [
        {
            "request_id": "1f40e5f7-f3a5-4e3c-bfc5-f821f2bf849c",
            "no": "test20240625001",
            "status": 1,
            "errors": []
        }
    ]
}
🟠404失败
Modified at 2026-01-01 02:21:07
Previous
Order trial calculation
Next
Prepaid charge
Built with