usps-tracking-api-python.md

USPS Tracking API - Python

Use Python to track USPS shipments with USPS Tracking API.

Features

• Real-time USPS tracking.
• Batch USPS tracking.
• Other features to manage your USPS tracking.

Installation

Installation is easy:

$ pip install trackingmore-sdk-python

Quick Start

Get the API key:

To use this API, you need to generate your API key.

• Click here to access TrackingMore admin.

• Go to the "Developer" section.

• Click "Generate API Key".

• Give a name to your API key, and click "Save" .

Then, start to track your USPS shipments.

Usage

Create a tracking (Real-time tracking):

  import trackingmore
  trackingmore.api_key = 'your api key'
  
  try:
    params = {'tracking_number': '9400111899562537683144','courier_code':'usps'}
    result = trackingmore.tracking.create_tracking(params)
    print(result)
  except trackingmore.exception.TrackingMoreException as ce:
    print(ce)
  except Exception as e:
    print("other error:", e) 

Create trackings (Max. 40 tracking numbers create in one call):

import trackingmore
trackingmore.api_key = 'your api key'

try:
  params = [
    {'tracking_number': '92632903279511573030094832', 'courier_code': 'usps'},
    {'tracking_number': '92642903289511563030094932', 'courier_code': 'usps'}
  ]
  result = trackingmore.tracking.batch_create_trackings(params)
  print(result)
except trackingmore.exception.TrackingMoreException as ce:
  print(ce)
except Exception as e:
  print("other error:", e) 

Get status of the shipment:

import trackingmore
trackingmore.api_key = 'your api key'

try:
  # Perform queries based on various conditions
  # params = {'tracking_numbers': '92632903279511573030094832', 'courier_code': 'usps'}
  # params = {'tracking_numbers': '92642903289511563030094932,803123605795913930', 'courier_code': 'usps'}
  params = {'created_date_min': '2023-08-23T06:00:00+00:00', 'created_date_max': '2023-09-05T07:20:42+00:00'}
  result = trackingmore.tracking.get_tracking_results(params)
  print(result)
except trackingmore.exception.TrackingMoreException as ce:
  print(ce)
except Exception as e:
  print("other error:", e) 

Update a tracking by ID:

import trackingmore
trackingmore.api_key = 'your api key'

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