Backtrack API

See more at Backtrack.xyz

Overview

Welcome to the Backtrack API! This API allows you to track packages from multiple carriers including FedEx, UPS, USPS, and DHL. Our service provides seamless integration to help you get the status of your shipments quickly and reliably. Whether you’re a developer building a shipping application or an e-commerce platform, our API is designed to be easy to use and integrate.

Features

• Track Packages: Retrieve the status of your shipments using tracking numbers with automatic carrier identification.
• Supported Carriers: Get a list of all supported carriers. Currently supported are FedEx, UPS, USPS, and DHL Express.

Endpoints

Track a Package

Get the shipment status for a given tracking number and optional carrier code.

Endpoint: /track/{tracking_number}

Method: GET

Parameters:

• tracking_number (path, required): The package tracking number.
• carrier_code (query, optional): The carrier code (FedEx, UPS, USPS, DHL).

Response:

{
  "return_value": {
    "success": false,
    "message": "",
    "tracking_number": "",
    "summary": "",
    "is_delivered": false,
    "is_exception": false,
    "carrier": "",
    "tracking_url": "",
    "origination": "",
    "destination": "",
    "estimated_delivery": "",
    "scans": [],
    "scans_detail": []
  }
}

Example Request:

Request:

curl -X GET "https://{rapid_api_path}/track/123123123" -H "X-RapidAPI-Key: your-api-key"

Response:

{
  "return_value": {
    "success": true,
    "message": "FedEx tracking information was located.",
    "tracking_number": "123123123",
    "summary": "Departed FedEx location",
    "is_delivered": false,
    "is_exception": false,
    "carrier": "FedEx",
    "tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=123123123&cntry_code=us",
    "origination": "Portland, OR US",
    "destination": "Jacksonvill, FL US",
    "estimated_delivery": "May 30, 2024",
    "scans": [
      "Arrived at FedEx location, May 24, 2024 5:29 pm, PORTLAND,OR",
      "Picked up, May 24, 2024 12:00 am, PORTLAND,OR",
      "Shipment information sent to FedEx, May 24, 2024 12:00 am"
    ],
    "scans_detail": [
      {
        "status": "Arrived at FedEx location",
        "timestamp": "May 24, 2024 5:29 pm",
        "date_part": "May 24, 2024",
        "short_date_part": "May 24",
        "time_part": "5:29 pm",
        "location": "Portland, OR"
      },
      {
        "status": "Picked up",
        "timestamp": "May 24, 2024 12:00 am",
        "date_part": "May 24, 2024",
        "short_date_part": "May 24",
        "time_part": "12:00 am",
        "location": "Portland, OR"
      },
      {
        "status": "Shipment information sent to FedEx",
        "timestamp": "May 24, 2024 12:00 am",
        "date_part": "May 24, 2024",
        "short_date_part": "May 24",
        "time_part": "12:00 am",
        "location": ""
      }
    ]
  }
}

List of Carriers

Get Supported Carriers or Identify Carrier by Tracking Number.

Retrieve a list of all supported carriers or identify the carrier from a tracking number.

The /carrier endpoint provides two functionalities:

1. Get Supported Carriers: If no tracking number is provided, the endpoint returns a list of all supported carriers.
2. Identify Carrier by Tracking Number: If a tracking number is provided, the endpoint identifies and returns the carrier associated with that tracking number.

Endpoint: /carrier

Parameters:

• tracking_number (query, optional): An optional tracking number to identify the carrier.

{
  "return_value": [
    {
      "code": "",
      "name": ""
    }
  ]
}

Example Request:

Request:

curl -X GET "https://{rapid_api_path}/carrier"  -H "X-RapidAPI-Key: your-api-key"

Response:

{
  "return_value": [
    {
      "code": "FEDEX",
      "name": "FedEx"
    },
    {
      "code": "UPS",
      "name": "United Parcel Service"
    },
    {
      "code": "USPS",
      "name": "US Postal Service"
    },
    {
      "code": "DHL",
      "name": "DHL Express"
    }
  ]
}