51tracking

51tracking-sdk-python

The Python SDK of 51Tracking API

Contact: service@51tracking.org

Official document

Document

Supported Python Versions

• 3.6
• 3.7
• 3.8
• 3.9
• 3.10
• pypy3

Index

1. Installation
2. Testing
3. Error Handling
4. SDK
   1. Couriers
   2. Trackings
   3. Air Waybill

Installation

$ pip install 51tracking

Via source code

下载代码压缩包，无需解压缩，进入源代码根目录，然后运行：

$ pip install 51tracking-sdk-python.zip

Quick Start

import tracking51

tracking51.api_key = 'you api key'

try:
  couriers = tracking51.courier.get_all_couriers()
  print(couriers)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

Testing

pytest

Error handling

Throw by the new SDK client

import tracking51

tracking51.api_key = ''

try:
   couriers = tracking51.courier.get_all_couriers()
   print(couriers)
except tracking51.exception.Tracking51Exception as ce:
   print(ce)

# API Key is missing

Throw by the parameter validation in function

import tracking51

tracking51.api_key = 'you api key'

try:
   params = {'tracking_number': '','courier_code':'usps'}
   result = tracking51.tracking.create_tracking(params)
   print(result)
except tracking51.exception.Tracking51Exception as ce:
   print(ce)

# Tracking number cannot be empty

Examples

Couriers

返回所有支持的快递公司列表

https://api.51Tracking.com/v4/couriers/all

try:
  result = tracking51.courier.get_all_couriers()
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

Trackings

单个物流单号实时添加且查询

https://api.51Tracking.com/v4/trackings/create

try:
  params = {'tracking_number': '92612903029511573030094547','courier_code':'usps'}
  result = tracking51.tracking.create_tracking(params)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

获取多个物流单号的查询结果

https://api.51Tracking.com/v4/trackings/get

try:
  # Perform queries based on various conditions
  # params = {'tracking_numbers': '92612903029511573030094547', 'courier_code': 'usps'}
  # params = {'tracking_numbers': '92612903029511573030094547,92612903029511573030094548', 'courier_code': 'usps'}
  params = {'created_date_min': '2023-08-23T14:00:00+00:00', 'created_date_max': '2023-08-23T15:04:00+00:00'}
  result = tracking51.tracking.get_tracking_results(params)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

添加多个物流单号（一次调用最多创建 40 个物流单号）

https://api.51Tracking.com/v4/trackings/batch

try:
  params = [{'tracking_number': '92612903029511573030094593', 'courier_code': 'usps'},
              {'tracking_number': '92612903029511573030094594', 'courier_code': 'usps'}]
  result = tracking51.tracking.batch_create_trackings(params)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

根据ID更新物流信息

https://api.51Tracking.com/v4/trackings/update/{id}

params = {'customer_name': 'New name', 'note': 'New tests order note'}
id_string = "9a2f732e29b5ed2071d4cf6b5f4a3d19"
try:
  result = tracking51.tracking.update_tracking_by_id(id_string, params)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

通过ID删除单号

https://api.51Tracking.com/v4/trackings/delete/{id}

id_string = "9a2f7d1e8b912b729388c5835c188c28"
try:
  result = tracking51.tracking.batch_create_trackings(params)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

通过ID重新查询过期的单号

https://api.51Tracking.com/v4/trackings/retrack/{id}

id_string = "9a2f7d1e8b912b729388c5835c188c28"
try:
  result = tracking51.tracking.retrack_tracking_by_id(id_string)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

Air Waybill

查询航空运单的结果

https://api.51Tracking.com/v4/awb

params = {'awb_number': '235-69030430'}
try:
  result = tracking51.air_waybill.create_an_air_waybill(params)
  print(result)
except tracking51.exception.Tracking51Exception as ce:
  print(ce)
except Exception as e:
  print("other error:", e)  

响应状态码

51Tracking 使用传统的HTTP状态码来表明 API 请求的状态。通常，2xx形式的状态码表示请求成功，4XX形式的状态码表请求发生错误（比如：必要参数缺失），5xx格式的状态码表示 51tracking 的服务器可能发生了问题。