usps-tracking-api-ruby.md

USPS Tracking API - Node.js

Use Node.js 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:

gem install trackingmore

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):

  require  'trackingmore'

  TrackingMore.api_key = 'your api key'
  
  begin
    params  = {"tracking_number" => "9400111899562537683144","courier_code"=>"usps"}
    response = TrackingMore::Tracking.create_tracking(params)
    puts response
  rescue TrackingMore::TrackingMoreException => e
    puts "Caught Custom Exception: #{e.message}"
  rescue StandardError => e
    puts "Caught Standard Error: #{e.message}"
  end

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

require  'trackingmore'

TrackingMore.api_key = 'your api key'

begin
  params  = [{"tracking_number" => "92632903279511573030094832","courier_code"=>"usps"},{"tracking_number" => "92642903289511563030094932","courier_code"=>"usps"}]
  response = TrackingMore::Tracking.batch_create_trackings(params)
  puts response
rescue TrackingMore::TrackingMoreException => e
  puts "Caught Custom Exception: #{e.message}"
rescue StandardError => e
  puts "Caught Standard Error: #{e.message}"
end

Get status of the shipment:

require  'trackingmore'

TrackingMore.api_key = 'your api key'

begin
  # Perform queries based on various conditions
  # params  = {"tracking_numbers" => "92632903279511573030094832","courier_code"=>"usps"}
  # params  = {"tracking_numbers" => "92632903279511573030094832,92642903289511563030094932","courier_code"=>"usps"}
  params  = {"created_date_min" => "2023-08-23T14:00:00+08:00","created_date_max"=>"2023-08-23T15:04:00+08:00"}
  response = TrackingMore::Tracking.get_tracking_results(params)
  puts response
rescue TrackingMore::TrackingMoreException => e
  puts "Caught Custom Exception: #{e.message}"
rescue StandardError => e
  puts "Caught Standard Error: #{e.message}"
end

Update a tracking by ID:

require  'trackingmore'

TrackingMore.api_key = 'your api key'

begin
  params  = {"customer_name" => "New name","note"=>"New tests order note"}
  id_string = '9a1d3844a50f3851e76e3ee347881588'
  response = TrackingMore::Tracking.update_tracking_by_id(id_string, params)
  puts response
rescue TrackingMore::TrackingMoreException => e
  puts "Caught Custom Exception: #{e.message}"
rescue StandardError => e
  puts "Caught Standard Error: #{e.message}"
end