Carriers

Embed
Preview of the card
<a href="https://forumulate.com/p/trackified/docs/ref-carriers"><img src="https://forumulate.com/api/public/orgs/trackified/spaces/docs/pages/c08eb599-64a9-41dd-a942-cd43f70f31bc/social-card.svg?v=3e7ae33eec8b" alt="Carriers" width="600" height="315"></a>
GEThttps://api.trackified.15-204-158-166.sslip.io/v1/carriers
List the carriers we track
Parameters
limitintegerquery
= 50
offsetintegerquery
= 0
Code samples
cURL
curl -X GET "https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset="
TypeScript
const res = await fetch('https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset=",
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.trackified.15-204-158-166.sslip.io/v1/carriers?limit=&offset="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Carriers
Example
{
  "data": [
    {
      "id": "string",
      "display_name": "string"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}
Schema
dataCarrier[]required
Show child parameters
idstring
display_namestring
paginationobjectrequired
Show child parameters
limitinteger
offsetinteger
totalinteger
401 Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}
Schema
errorobject
Show child parameters
codestring
messagestring
request_idstring
GEThttps://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}
Get a carrier
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}"
TypeScript
const res = await fetch('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}",
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.trackified.15-204-158-166.sslip.io/v1/carriers/{id}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 The carrier
Example
{
  "id": "string",
  "display_name": "string"
}
Schema
idstring
display_namestring
401 Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}
Schema
errorobject
Show child parameters
codestring
messagestring
request_idstring
404 Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}
Schema
errorobject
Show child parameters
codestring
messagestring
request_idstring
GEThttps://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect
Detect the carrier for a tracking number
Parameters
numberstringqueryrequired
Code samples
cURL
curl -X GET "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number="
TypeScript
const res = await fetch('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number=",
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.trackified.15-204-158-166.sslip.io/v1/carriers/detect?number="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Candidates, most likely first
Example
{
  "tracking_number": "string",
  "candidates": [
    {
      "carrier": "string",
      "confidence": 0,
      "reason": "string"
    }
  ]
}
Schema
tracking_numberstring
candidatesCarrierCandidate[]
Show child parameters
carrierstring
confidencenumber
reasonstring
400 Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}
Schema
errorobject
Show child parameters
codestring
messagestring
request_idstring
401 Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}
Schema
errorobject
Show child parameters
codestring
messagestring
request_idstring
GEThttps://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog
Search carriers by name
Parameters
qstringquery
supportstringquery
scraper | api | unsupported
limitintegerquery
= 50
Code samples
cURL
curl -X GET "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit="
TypeScript
const res = await fetch('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit=",
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.trackified.15-204-158-166.sslip.io/v1/carriers/catalog?q=&support=&limit="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Matching carriers, ones we track first
Example
{
  "total": 0,
  "data": [
    {}
  ]
}
Schema
totalinteger
dataobject[]
GEThttps://api.trackified.15-204-158-166.sslip.io/v1/carriers/status
How each carrier has been validated
Code samples
cURL
curl -X GET "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status"
TypeScript
const res = await fetch('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status",
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.trackified.15-204-158-166.sslip.io/v1/carriers/status"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Counts and per-carrier results
{}
401 Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}
Schema
errorobject
Show child parameters
codestring
messagestring
request_idstring
Updated