API Integration Guide

This guide provides instructions on how to integrate with the USPS tracking API using your sub-API key.

Base URL

https://my.labelscheap.com/

Endpoint

GET /api/generate_tracking.php

2. Required Parameters

• cURL
• PHP
• Python
• JavaScript
• Node.js
• VB

curl -X GET 
"https://my.labelscheap.com/api/generate_tracking.php?user_name=johndoe&api_key=abc123&class=ground_advantage&count=5"
                                

$api_url = "https://my.labelscheap.com/api/generate_tracking.php";
$params = [
    'user_name' => 'johndoe',
    'api_key' => 'abc123',
    'class' => 'ground_advantage',
    'count' => 5
];
$url = $api_url . '?' . http_build_query($params);
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);

                                

import requests
url = "https://my.labelscheap.com/api/generate_tracking.php"
params = {
    'user_name': 'johndoe',
    'api_key': 'abc123',
    'class': 'ground_advantage',
    'count': 5
}
response = requests.get(url, params=params)
print(response.json())
                                

fetch("https://my.labelscheap.com/api/generate_tracking.php?user_name=johndoe&api_key=abc123&class=ground_advantage&count=5")
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
                                

const axios = require('axios');
const params = {
    user_name: 'johndoe',
    api_key: 'abc123',
    class: 'ground_advantage',
    count: 5
};
axios.get('https://my.labelscheap.com/api/generate_tracking.php', { params })
    .then(response => console.log(response.data))
    .catch(error => console.error('Error:', error));
                                

Dim client As New WebClient()
Dim url As String = "https://my.labelscheap.com/api/tracking.php?user_name=johndoe&class=rollo&service=ground_advantage&api_key=abc123"
Dim response As String = client.DownloadString(url)
Console.WriteLine(response)
                                

Example Response

{
    "tracking_numbers" : 
        [
            "XXXXXXXXXXXXXXXXXXX",
            "XXXXXXXXXXXXXXXXXXX",
            "XXXXXXXXXXXXXXXXXXX",
            "XXXXXXXXXXXXXXXXXXX"
        ]
 }

3. Common Errors

• User not found: This occurs if the user_name does not match any entry in the users table.
• Invalid or inactive API key: This happens if the API key provided is incorrect or inactive.
• Low balance: This error occurs when the user's current_balance is less than 1.
• Transaction failed: This happens when an error occurs during the database update or API call process.
• Invalid format: The provided parameters are not correctly formatted (e.g., missing or incorrectly named parameters).

Important Notes

• User Profile: The user's user_id will be updated from the user profile page.
• API Keys Management: API keys are managed under the Developer Tools section. Users can generate, revoke, or view their keys.
• Click Logs: All API requests are logged under the Logs section in the Developer Tools.

Services

Vendors

Supported class by a vendor

If you have any questions, feel free to contact our support team!