51Tracking V4 API文档

Kallen23
95 阅读3分钟

1. 概述

51Tracking V4 API是为电子商务企业提供的一种高效管理和更新货物信息的解决方案。通过V4版本，用户可以无缝管理物流轨迹，并通过API或Webhook存储数据来定制购买服务。V4版本支持更多的字段信息，优化了报文结构，并提供了UTC时间格式。请注意，V4版本不向后兼容V2和V3版本，但用户仍可以选择使用这些旧版本。

2. 获取API密钥

在使用51Tracking API之前，用户需要注册51Tracking账户以获取API密钥。API密钥用于验证请求，通过在请求头中添加Tracking-Api-Key来实现。用户可以在账户后台生成新的API Key。

3. API端点

所有的API端点都通过HTTPS访问，并且位于api.51Tracking.com。

4. 常见使用场景

场景1：创建物流单号进行查询

创建物流单号追踪事件时，需要提供快递单号（必填）、物流商简码（必填）和其他快递信息（选填）。如果知道具体的快递公司，应填写courier_code字段。某些物流商可能需要额外的字段来进行查询追踪。

场景2：更新物流单号信息

使用该API接口可以更新订单信息和物流单号添加额外信息。

场景3：获取有关物流轨迹的更新

  • 通过Webhook: 51Tracking可以通过Webhook向用户推送每次物流轨迹更新的通知。用户可以前往后台-开发者中心设置Webhook URL。
  • 通过API获取: 使用GET API接口api.51Tracking.com/v4/tracking…获取最新的物流轨迹节点。注意，GET API每秒限制2个请求。

5. 请求和响应示例

创建物流单号请求示例：

{
  "tracking_number": "9261290312833844954982",
  "courier_code": "ups-mi",
  "additional_info": {
    "field1": "value1",
    "field2": "value2"
  }
}

创建物流单号响应示例：

{
  "status": "success",
  "message": "Tracking created successfully",
  "data": {
    "tracking_id": "12345",
    "tracking_number": "9261290312833844954982",
    "courier_code": "ups-mi"
  }
}

更新物流单号请求示例：

{
  "id": "12345",
  "additional_info": {
    "field1": "new_value1",
    "field2": "new_value2"
  }
}

更新物流单号响应示例：

{
  "status": "success",
  "message": "Tracking updated successfully",
  "data": {
    "tracking_id": "12345",
    "tracking_number": "9261290312833844954982",
    "courier_code": "ups-mi"
  }
}

获取物流轨迹GET请求示例：

https://api.51Tracking.com/v4/trackings/get?tracking_numbers=9261290312833844954982

获取物流轨迹响应示例：

{
  "status": "success",
  "message": "Tracking data retrieved",
  "data": [
    {
      "tracking_number": "9261290312833844954982",
      "events": [
        {
          "timestamp": "2024-03-27T12:00:00Z",
          "status": "In Transit",
          "location": "Shanghai, China"
        },
        // ... 更多物流节点
      ]
    }
  ]
}

6. 注意事项

  • 所有的API请求都应该通过HTTPS进行。
  • 请保管好您的API密钥，不要泄露给他人。
  • 遵循API的请求限制，以免触发错误。
  • 在使用Webhook时，确保您的服务器能够接收并正确处理推送的通知。

以上是51Tracking V4 API的基本技术文档概要，具体使用时请参考官方API文档以获取更详细的信息和指导。

avatar
文章
阅读
粉丝