Mark a shipment shipped or delivered
curl --request POST \
--url https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "shipped"
}
'import requests
url = "https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}"
payload = { "status": "shipped" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'shipped'})
};
fetch('https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}', 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://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'shipped'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}"
payload := strings.NewReader("{\n \"status\": \"shipped\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"shipped\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"shipped\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"status": "shipped",
"webhooks": {
"delivered": 1,
"retrying": 0
}
}{
"error": "status must be 'shipped' or 'delivered'"
}{
"error": "Missing or malformed API key"
}{
"error": "This partner program is not live",
"code": "PROGRAM_INACTIVE"
}{
"error": "Unknown shipment",
"code": "UNKNOWN_SHIPMENT"
}{
"error": "No shipping order for this shipment yet: burn it and tick first",
"code": "NOT_BURNED"
}{
"error": "Too many requests. Slow down.",
"code": "RATE_LIMITED",
"retry_after_seconds": 23
}{
"error": "Something went wrong; retry with the same Idempotency-Key."
}{
"error": "Could not load the partner program; try again."
}Sandbox
Mark a shipment shipped or delivered
Sandbox only: 404 in production.
Plays our shipping team, so you can build and test your tracking screens. shipped marks a burned shipment shipped, with a test USPS tracking number, a tracking link, shipped_at and an expected_delivery three days out; delivered then sets delivered_at. Read the result with Get a shipment. It also delivers any webhooks the change produced.
POST
/
api
/
partner
/
v2
/
sandbox
/
shipments
/
{id}
Mark a shipment shipped or delivered
curl --request POST \
--url https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "shipped"
}
'import requests
url = "https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}"
payload = { "status": "shipped" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'shipped'})
};
fetch('https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}', 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://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'shipped'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}"
payload := strings.NewReader("{\n \"status\": \"shipped\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"shipped\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchbackcards.com/api/partner/v2/sandbox/shipments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"shipped\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"status": "shipped",
"webhooks": {
"delivered": 1,
"retrying": 0
}
}{
"error": "status must be 'shipped' or 'delivered'"
}{
"error": "Missing or malformed API key"
}{
"error": "This partner program is not live",
"code": "PROGRAM_INACTIVE"
}{
"error": "Unknown shipment",
"code": "UNKNOWN_SHIPMENT"
}{
"error": "No shipping order for this shipment yet: burn it and tick first",
"code": "NOT_BURNED"
}{
"error": "Too many requests. Slow down.",
"code": "RATE_LIMITED",
"retry_after_seconds": 23
}{
"error": "Something went wrong; retry with the same Idempotency-Key."
}{
"error": "Could not load the partner program; try again."
}Authorizations
Your API key (cb_live_…), sent as a bearer token, with the scope nft:orders. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a 403 with Access denied, whether or not it has a valid key. See Authentication and keys.

