Get Label API

Developing

POST

/api/v3/shipment/getLabel

Get the label for the order.

Request

Body Params application/json

Example

{
    "accessToken": "string",
    "mode": "production",
    "orderId": ""
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.batchship.com/api/v3/shipment/getLabel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accessToken": "string",
    "mode": "production",
    "orderId": ""
}'

Responses

🟢200成功

application/json

Body

Example

{
    "success": true,
    "payload": {
        "orderId": "ORDER_ID",
        "status": "printing",
        "packageDocumentDetails": [
            {
                "packageClientReferenceId": "SWA_US_SmartP_Test",
                "packageDocuments": [
                    {
                        "type": "URL",
                        "contents": "LABEL_URL",
                        "format": "PDF"
                    }
                ],
                "trackingId": "9031322607088",
                "packageSn": "OSAPDDPJDAFJ"
            }
        ]
    }
}

Modified at 2026-02-28 08:20:47

Get PodInfo API

Get TrackingInfo API