Get Report Type
curl --request GET \
--url https://api.goshippo.com/v2/reporting/reports/{report_type} \
--header 'Authorization: <api-key>'import requests
url = "https://api.goshippo.com/v2/reporting/reports/{report_type}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.goshippo.com/v2/reporting/reports/{report_type}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goshippo.com/v2/reporting/reports/{report_type}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.goshippo.com/v2/reporting/reports/{report_type}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.goshippo.com/v2/reporting/reports/{report_type}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goshippo.com/v2/reporting/reports/{report_type}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"report_type": "<string>",
"name": "<string>",
"category": "<string>",
"description": "<string>",
"available_columns": [
{
"name": "<string>",
"display_name": "<string>",
"is_default": true
}
],
"data_availability": {
"status": "pending"
}
}{
"detail": "Authentication credentials were not provided."
}{
"type": "https://reporthub.shippo.com/errors/report-type-not-found",
"title": "Report Type Not Found",
"status": 404,
"detail": "The requested report type was not found."
}{
"type": "https://reporthub.shippo.com/errors/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The request is invalid."
}Reports
Get Report Type
GET
/
v2
/
reporting
/
reports
/
{report_type}
Get Report Type
curl --request GET \
--url https://api.goshippo.com/v2/reporting/reports/{report_type} \
--header 'Authorization: <api-key>'import requests
url = "https://api.goshippo.com/v2/reporting/reports/{report_type}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.goshippo.com/v2/reporting/reports/{report_type}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goshippo.com/v2/reporting/reports/{report_type}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.goshippo.com/v2/reporting/reports/{report_type}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.goshippo.com/v2/reporting/reports/{report_type}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goshippo.com/v2/reporting/reports/{report_type}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"report_type": "<string>",
"name": "<string>",
"category": "<string>",
"description": "<string>",
"available_columns": [
{
"name": "<string>",
"display_name": "<string>",
"is_default": true
}
],
"data_availability": {
"status": "pending"
}
}{
"detail": "Authentication credentials were not provided."
}{
"type": "https://reporthub.shippo.com/errors/report-type-not-found",
"title": "Report Type Not Found",
"status": 404,
"detail": "The requested report type was not found."
}{
"type": "https://reporthub.shippo.com/errors/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The request is invalid."
}Authorizations
Shippo API token header, for example ShippoToken shippo_live_xxxx.
Path Parameters
Response
Successful Response
Report type metadata returned by the Reporting API.
The version is embedded in the report_type key (for example
invoice.v1) and discovery only returns active types, so neither fact is
repeated as a separate field.
Show child attributes
Show child attributes
Data availability state while bounds are still being computed.
- PendingDataAvailabilityResponse
- ReadyDataAvailabilityResponse
Show child attributes
Show child attributes
Last modified on September 16, 2026
Was this page helpful?
⌘I