跳到主要内容

获取尾派小包

通过尾派小包 ID 获取特定尾派小包的所有详细信息。

端点： GET /api/shipments/{id}

所需权限 (Scope): shipments:read

请求规范​

路径参数类型必填描述
idstring是尾派小包的唯一 ID。（这不是您的参考 ID）

响应规范​

返回包装在 Result 中的 Shipment 对象。

如果未找到，可能会返回 HTTP 状态码 404。

示例 JSON​

响应​

{
  "Data": {
    "Id": "2603XSHPT00001GA",
    "AccountNo": "TEST",
    "ReferenceId": "ORDER-123",
    "ShippingProductId": "PRODUCT001",
    "ToAddress": {
      "Company": "",
      "Street1": "123 Main St",
      "Street2": "",
      "Street3": "",
      "City": "New York",
      "Province": "NY",
      "CountryCode": "US",
      "Postcode": "10001",
      "ContactName": "John Doe",
      "Tel": "555-0199",
      "Email": "",
      "TaxId": ""
    },
    "FromAddress": {
      "Company": "",
      "Street1": "456 Logistic Way",
      "Street2": "",
      "Street3": "",
      "City": "Los Angeles",
      "Province": "CA",
      "CountryCode": "US",
      "Postcode": "90001",
      "ContactName": "Shipper Name",
      "Tel": "",
      "Email": "",
      "TaxId": ""
    },
    "ReturnAddress": null,
    "Weight": {
      "Value": 1.3,
      "Unit": "LB"
    },
    "Size": {
      "Length": 25.4,
      "Width": 12.7,
      "Height": 7.62,
      "Unit": "IN"
    },
    "DeclaredValue": null,
    "ShipDate": "2026-04-01",
    "Notes": "",
    "Quote": {
      "QuotationType": "Basic",
      "Fees": [
        {
          "FeeType": "BASE",
          "Amount": 23.16
        },
        {
          "FeeType": "REGISTRATION",
          "Amount": 5.0
        },
        {
          "FeeType": "NON_STANDARD_LENGTH",
          "Amount": 4.5
        }
      ],
      "Total": 32.66,
      "Weight": 1.3,
      "DimensionalWeight": 14.808,
      "FeeWeight": 14.808,
      "FeeWeightType": "DimensionalWeight",
      "PriceZone": "8",
      "WeightUnit": "LB",
      "LengthUnit": "IN",
      "CurrencyCode": "USD"
    },
    "Carrier": {
      "Status": "Created",
      "Barcode": "420900019200190327908701117139",
      "Message": ""
    },
    "TrackingNumber": "9234690327908700395257",
    "CreateAt": "2026-03-24T03:36:31Z"
  },
  "Succeeded": true,
  "Error": null,
  "CapturedValues": {}
}