Consumer printing
Exchange a single-use handoff and rotate the session token
All responses are no-store and no-referrer. Shipping supports all 50 U.S. states and DC; Alaska and Hawaii require Expedited. Territories are unsupported.
POST
/
v1
/
consumer
/
handoffs
/
exchange
Exchange a single-use handoff and rotate the session token
curl --request POST \
--url https://api.batchrelay.com/v1/consumer/handoffs/exchange \
--header 'Content-Type: application/json' \
--data '
{
"handoff_code": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/consumer/handoffs/exchange"
payload = { "handoff_code": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({handoff_code: '<string>'})
};
fetch('https://api.batchrelay.com/v1/consumer/handoffs/exchange', 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.batchrelay.com/v1/consumer/handoffs/exchange",
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([
'handoff_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.batchrelay.com/v1/consumer/handoffs/exchange"
payload := strings.NewReader("{\n \"handoff_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.batchrelay.com/v1/consumer/handoffs/exchange")
.header("Content-Type", "application/json")
.body("{\n \"handoff_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/consumer/handoffs/exchange")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"handoff_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"asset_id": "<string>",
"content_type": "<string>",
"pixel_height": 12500000,
"pixel_width": 12500000
}
],
"expires_at": "2023-11-07T05:31:56Z",
"handed_off": true,
"items": [
{
"asset_id": "<string>",
"listing_id": "<string>",
"quantity": 50,
"product_id": "<string>"
}
],
"mode": "<string>",
"session_id": "<string>",
"session_token": "<string>",
"status": "<string>"
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}Headers
Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.
Required string length:
1 - 100Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.
Required string length:
1 - 100Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.
Required string length:
1 - 100Body
application/json
Pattern:
^brh_[A-Za-z0-9_-]{43}$⌘I
Exchange a single-use handoff and rotate the session token
curl --request POST \
--url https://api.batchrelay.com/v1/consumer/handoffs/exchange \
--header 'Content-Type: application/json' \
--data '
{
"handoff_code": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/consumer/handoffs/exchange"
payload = { "handoff_code": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({handoff_code: '<string>'})
};
fetch('https://api.batchrelay.com/v1/consumer/handoffs/exchange', 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.batchrelay.com/v1/consumer/handoffs/exchange",
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([
'handoff_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.batchrelay.com/v1/consumer/handoffs/exchange"
payload := strings.NewReader("{\n \"handoff_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.batchrelay.com/v1/consumer/handoffs/exchange")
.header("Content-Type", "application/json")
.body("{\n \"handoff_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/consumer/handoffs/exchange")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"handoff_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"asset_id": "<string>",
"content_type": "<string>",
"pixel_height": 12500000,
"pixel_width": 12500000
}
],
"expires_at": "2023-11-07T05:31:56Z",
"handed_off": true,
"items": [
{
"asset_id": "<string>",
"listing_id": "<string>",
"quantity": 50,
"product_id": "<string>"
}
],
"mode": "<string>",
"session_id": "<string>",
"session_token": "<string>",
"status": "<string>"
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}{
"code": "price_changed",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"next_action": "refresh_catalog",
"request_id": "<string>",
"retryable": true,
"details": {}
}