创建货件运输标签

预发布环境

https://staging.shipnitro.com/

POST

api/v2/shipments

创建货件接口用于启动货件创建流程。调用此接口后，系统开始通过承运商生成运输标签。由于标签生成可能需要一些时间，货件创建后不一定能立即获取标签。

重要提示：成功创建货件后，您必须每隔 10 秒轮询一次**获取货件详情**接口，检查运输标签是否已生成。持续轮询，直到标签可用或已达到 10 分钟。

如果标签已就绪，获取货件详情的响应将包含标签数据。

如果标签尚未就绪，响应将表明标签仍在处理中。

如果 10 分钟后仍未生成标签，则很可能是货件在承运商处理过程中发生了错误。此时，客户端应停止轮询并进行适当处理（例如向用户显示错误消息、重试货件创建流程或联系我们的支持团队）。

通过此异步流程，您可以在承运商生成运输标签后可靠地获取标签。

請求

標頭參數

主體參數application/json

範例

回應

🟢200成功

application/json

主體application/json

🟠400请求错误

請求範例

Shell

JavaScript

Java

Swift

curl --location 'https://staging.shipnitro.com/api/v2/shipments' \
--header 'Authorization: Basic {{apiKey}}' \
--header 'Content-Type: application/json' \
--data '{
    "recipient": {
        "postalCode": "34986",
        "city": "PORT SAINT LUCIE",
        "stateCode": "FL",
        "addressLine1": "7600 LTC Parkway",
        "addresLine2": null,
        "countryCode": "US",
        "personName": "PBI3-Fedex",
        "companyName": "Test",
        "email": null,
        "phoneNumber": "8888888888",
        "forceAddress": true
    },
    "parcels": [
        {
            "weight": 2,
            "width": 12,
            "height": 2,
            "length": 11,
            "weightUnit": "LB",
            "dimensionUnit": "IN",
            "count": 1,
            "referenceCodes": {
                "reference1": "test1111",
                "reference3": "test1122"
            }
        },
        {
            "weight": 5,
            "width": 15,
            "height": 2,
            "length": 11,
            "weightUnit": "LB",
            "dimensionUnit": "IN",
            "count": 1,
            "referenceCodes": {
                "reference1": "test2222",
                "reference3": "test3333"
            }
        }
    ]
}'

回應範例

200 - 成功

{
    "boxId": "api_fskhjoowe234asa",
    "message": [
        "Shipment Label sucessfully submitted"
    ]
}

修改時間 2026-09-04 21:54:55

获取货件详情

获取当前信用余额