Print orders
Submit a quoted API print order
Requires a scoped API key or an anonymous Test Mode session and Idempotency-Key. Anonymous sessions always use sandbox, no-charge simulation. Live API keys retain billable production behavior. The quote is account/environment scoped and freezes exactly one resolved provider; submission cannot alter it or split a mixed-provider order.
POST
/
v1
/
print-orders
Submit a quoted API print order
curl --request POST \
--url https://api.batchrelay.com/v1/print-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"order": {
"external_order_id": "<string>",
"items": [
{
"assets": [
{
"url": "<string>",
"asset_id": "<string>",
"file_size_bytes": 2,
"hash": "<string>",
"origin": {
"design_id": "<string>",
"design_version": 2
},
"pixel_height": 2,
"pixel_width": 2,
"printed_file_name": "<string>",
"template_render_id": "<string>"
}
],
"product": {
"id": "<string>",
"revision": 2
},
"quantity": 2,
"options": [
{
"option_id": "<string>",
"value": "<string>"
}
],
"texts": [
{
"value": "<string>"
}
]
}
],
"schema_version": 1,
"ship_from": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"ship_to": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"customer": {
"email": "jsmith@example.com",
"external_id": "<string>",
"name": "<string>",
"phone": "<string>"
}
},
"quote_id": "<string>",
"integration_source": "direct_api"
}
'import requests
url = "https://api.batchrelay.com/v1/print-orders"
payload = {
"order": {
"external_order_id": "<string>",
"items": [
{
"assets": [
{
"url": "<string>",
"asset_id": "<string>",
"file_size_bytes": 2,
"hash": "<string>",
"origin": {
"design_id": "<string>",
"design_version": 2
},
"pixel_height": 2,
"pixel_width": 2,
"printed_file_name": "<string>",
"template_render_id": "<string>"
}
],
"product": {
"id": "<string>",
"revision": 2
},
"quantity": 2,
"options": [
{
"option_id": "<string>",
"value": "<string>"
}
],
"texts": [{ "value": "<string>" }]
}
],
"schema_version": 1,
"ship_from": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"ship_to": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"customer": {
"email": "jsmith@example.com",
"external_id": "<string>",
"name": "<string>",
"phone": "<string>"
}
},
"quote_id": "<string>",
"integration_source": "direct_api"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
order: {
external_order_id: '<string>',
items: [
{
assets: [
{
url: '<string>',
asset_id: '<string>',
file_size_bytes: 2,
hash: '<string>',
origin: {design_id: '<string>', design_version: 2},
pixel_height: 2,
pixel_width: 2,
printed_file_name: '<string>',
template_render_id: '<string>'
}
],
product: {id: '<string>', revision: 2},
quantity: 2,
options: [{option_id: '<string>', value: '<string>'}],
texts: [{value: '<string>'}]
}
],
schema_version: 1,
ship_from: {
address_1: '<string>',
city: '<string>',
country: '<string>',
name: '<string>',
phone: '<string>',
postal_code: '<string>',
state: '<string>',
address_2: '<string>'
},
ship_to: {
address_1: '<string>',
city: '<string>',
country: '<string>',
name: '<string>',
phone: '<string>',
postal_code: '<string>',
state: '<string>',
address_2: '<string>'
},
customer: {
email: 'jsmith@example.com',
external_id: '<string>',
name: '<string>',
phone: '<string>'
}
},
quote_id: '<string>',
integration_source: 'direct_api'
})
};
fetch('https://api.batchrelay.com/v1/print-orders', 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/print-orders",
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([
'order' => [
'external_order_id' => '<string>',
'items' => [
[
'assets' => [
[
'url' => '<string>',
'asset_id' => '<string>',
'file_size_bytes' => 2,
'hash' => '<string>',
'origin' => [
'design_id' => '<string>',
'design_version' => 2
],
'pixel_height' => 2,
'pixel_width' => 2,
'printed_file_name' => '<string>',
'template_render_id' => '<string>'
]
],
'product' => [
'id' => '<string>',
'revision' => 2
],
'quantity' => 2,
'options' => [
[
'option_id' => '<string>',
'value' => '<string>'
]
],
'texts' => [
[
'value' => '<string>'
]
]
]
],
'schema_version' => 1,
'ship_from' => [
'address_1' => '<string>',
'city' => '<string>',
'country' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'postal_code' => '<string>',
'state' => '<string>',
'address_2' => '<string>'
],
'ship_to' => [
'address_1' => '<string>',
'city' => '<string>',
'country' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'postal_code' => '<string>',
'state' => '<string>',
'address_2' => '<string>'
],
'customer' => [
'email' => 'jsmith@example.com',
'external_id' => '<string>',
'name' => '<string>',
'phone' => '<string>'
]
],
'quote_id' => '<string>',
'integration_source' => 'direct_api'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/print-orders"
payload := strings.NewReader("{\n \"order\": {\n \"external_order_id\": \"<string>\",\n \"items\": [\n {\n \"assets\": [\n {\n \"url\": \"<string>\",\n \"asset_id\": \"<string>\",\n \"file_size_bytes\": 2,\n \"hash\": \"<string>\",\n \"origin\": {\n \"design_id\": \"<string>\",\n \"design_version\": 2\n },\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"printed_file_name\": \"<string>\",\n \"template_render_id\": \"<string>\"\n }\n ],\n \"product\": {\n \"id\": \"<string>\",\n \"revision\": 2\n },\n \"quantity\": 2,\n \"options\": [\n {\n \"option_id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"texts\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"schema_version\": 1,\n \"ship_from\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"ship_to\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"quote_id\": \"<string>\",\n \"integration_source\": \"direct_api\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.batchrelay.com/v1/print-orders")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"external_order_id\": \"<string>\",\n \"items\": [\n {\n \"assets\": [\n {\n \"url\": \"<string>\",\n \"asset_id\": \"<string>\",\n \"file_size_bytes\": 2,\n \"hash\": \"<string>\",\n \"origin\": {\n \"design_id\": \"<string>\",\n \"design_version\": 2\n },\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"printed_file_name\": \"<string>\",\n \"template_render_id\": \"<string>\"\n }\n ],\n \"product\": {\n \"id\": \"<string>\",\n \"revision\": 2\n },\n \"quantity\": 2,\n \"options\": [\n {\n \"option_id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"texts\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"schema_version\": 1,\n \"ship_from\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"ship_to\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"quote_id\": \"<string>\",\n \"integration_source\": \"direct_api\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/print-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order\": {\n \"external_order_id\": \"<string>\",\n \"items\": [\n {\n \"assets\": [\n {\n \"url\": \"<string>\",\n \"asset_id\": \"<string>\",\n \"file_size_bytes\": 2,\n \"hash\": \"<string>\",\n \"origin\": {\n \"design_id\": \"<string>\",\n \"design_version\": 2\n },\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"printed_file_name\": \"<string>\",\n \"template_render_id\": \"<string>\"\n }\n ],\n \"product\": {\n \"id\": \"<string>\",\n \"revision\": 2\n },\n \"quantity\": 2,\n \"options\": [\n {\n \"option_id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"texts\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"schema_version\": 1,\n \"ship_from\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"ship_to\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"quote_id\": \"<string>\",\n \"integration_source\": \"direct_api\"\n}"
response = http.request(request)
puts response.read_body{
"api_account_id": "<string>",
"channel": "api",
"created_at": "2023-11-07T05:31:56Z",
"external_order_id": "<string>",
"id": "<string>",
"merchant_of_record": "batch_relay",
"order_code": "<string>",
"price": {
"currency": "USD",
"fee_base_cents": 1,
"merchandise_cents": 1,
"minimum_fee_cents": 500,
"platform_fee_basis_points": 1500,
"platform_fee_cents": 501,
"platform_fee_label": "Batch Relay API Access Fee",
"policy_id": "api-access-fee-v1",
"shipping_cents": 1,
"tax_cents": 1,
"total_cents": 2
},
"provider": {
"provider_availability": "preview",
"provider_capability_revision": "<string>",
"provider_environment": "sandbox",
"provider_id": "whcc",
"provider_recipe_revision": "<string>",
"provider_selection_source": "explicit"
},
"provider_offer_lines": [
{
"availability": "available",
"configuration": {},
"currency": "USD",
"line_subtotal_cents": 1,
"offer_id": "<string>",
"pricing_revision": "<string>",
"product": {
"id": "<string>",
"revision": 2
},
"provider_id": "whcc",
"quantity": 2,
"unit_cost_cents": 1
}
],
"quote_id": "<string>",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}Authorizations
Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.
Headers
Minimum string length:
1Untrusted 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
Response
Order reserved for payment/fulfillment
Allowed value:
"api"Pattern:
^bro_Allowed value:
"batch_relay"Batch Relay-owned human-facing order reference. It is always serialized, but may be empty for legacy records that predate allocation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Immutable copy of the reserved quote's public offer evidence.
Minimum array length:
1Show child attributes
Show child attributes
⌘I
Submit a quoted API print order
curl --request POST \
--url https://api.batchrelay.com/v1/print-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"order": {
"external_order_id": "<string>",
"items": [
{
"assets": [
{
"url": "<string>",
"asset_id": "<string>",
"file_size_bytes": 2,
"hash": "<string>",
"origin": {
"design_id": "<string>",
"design_version": 2
},
"pixel_height": 2,
"pixel_width": 2,
"printed_file_name": "<string>",
"template_render_id": "<string>"
}
],
"product": {
"id": "<string>",
"revision": 2
},
"quantity": 2,
"options": [
{
"option_id": "<string>",
"value": "<string>"
}
],
"texts": [
{
"value": "<string>"
}
]
}
],
"schema_version": 1,
"ship_from": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"ship_to": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"customer": {
"email": "jsmith@example.com",
"external_id": "<string>",
"name": "<string>",
"phone": "<string>"
}
},
"quote_id": "<string>",
"integration_source": "direct_api"
}
'import requests
url = "https://api.batchrelay.com/v1/print-orders"
payload = {
"order": {
"external_order_id": "<string>",
"items": [
{
"assets": [
{
"url": "<string>",
"asset_id": "<string>",
"file_size_bytes": 2,
"hash": "<string>",
"origin": {
"design_id": "<string>",
"design_version": 2
},
"pixel_height": 2,
"pixel_width": 2,
"printed_file_name": "<string>",
"template_render_id": "<string>"
}
],
"product": {
"id": "<string>",
"revision": 2
},
"quantity": 2,
"options": [
{
"option_id": "<string>",
"value": "<string>"
}
],
"texts": [{ "value": "<string>" }]
}
],
"schema_version": 1,
"ship_from": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"ship_to": {
"address_1": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state": "<string>",
"address_2": "<string>"
},
"customer": {
"email": "jsmith@example.com",
"external_id": "<string>",
"name": "<string>",
"phone": "<string>"
}
},
"quote_id": "<string>",
"integration_source": "direct_api"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
order: {
external_order_id: '<string>',
items: [
{
assets: [
{
url: '<string>',
asset_id: '<string>',
file_size_bytes: 2,
hash: '<string>',
origin: {design_id: '<string>', design_version: 2},
pixel_height: 2,
pixel_width: 2,
printed_file_name: '<string>',
template_render_id: '<string>'
}
],
product: {id: '<string>', revision: 2},
quantity: 2,
options: [{option_id: '<string>', value: '<string>'}],
texts: [{value: '<string>'}]
}
],
schema_version: 1,
ship_from: {
address_1: '<string>',
city: '<string>',
country: '<string>',
name: '<string>',
phone: '<string>',
postal_code: '<string>',
state: '<string>',
address_2: '<string>'
},
ship_to: {
address_1: '<string>',
city: '<string>',
country: '<string>',
name: '<string>',
phone: '<string>',
postal_code: '<string>',
state: '<string>',
address_2: '<string>'
},
customer: {
email: 'jsmith@example.com',
external_id: '<string>',
name: '<string>',
phone: '<string>'
}
},
quote_id: '<string>',
integration_source: 'direct_api'
})
};
fetch('https://api.batchrelay.com/v1/print-orders', 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/print-orders",
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([
'order' => [
'external_order_id' => '<string>',
'items' => [
[
'assets' => [
[
'url' => '<string>',
'asset_id' => '<string>',
'file_size_bytes' => 2,
'hash' => '<string>',
'origin' => [
'design_id' => '<string>',
'design_version' => 2
],
'pixel_height' => 2,
'pixel_width' => 2,
'printed_file_name' => '<string>',
'template_render_id' => '<string>'
]
],
'product' => [
'id' => '<string>',
'revision' => 2
],
'quantity' => 2,
'options' => [
[
'option_id' => '<string>',
'value' => '<string>'
]
],
'texts' => [
[
'value' => '<string>'
]
]
]
],
'schema_version' => 1,
'ship_from' => [
'address_1' => '<string>',
'city' => '<string>',
'country' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'postal_code' => '<string>',
'state' => '<string>',
'address_2' => '<string>'
],
'ship_to' => [
'address_1' => '<string>',
'city' => '<string>',
'country' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'postal_code' => '<string>',
'state' => '<string>',
'address_2' => '<string>'
],
'customer' => [
'email' => 'jsmith@example.com',
'external_id' => '<string>',
'name' => '<string>',
'phone' => '<string>'
]
],
'quote_id' => '<string>',
'integration_source' => 'direct_api'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/print-orders"
payload := strings.NewReader("{\n \"order\": {\n \"external_order_id\": \"<string>\",\n \"items\": [\n {\n \"assets\": [\n {\n \"url\": \"<string>\",\n \"asset_id\": \"<string>\",\n \"file_size_bytes\": 2,\n \"hash\": \"<string>\",\n \"origin\": {\n \"design_id\": \"<string>\",\n \"design_version\": 2\n },\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"printed_file_name\": \"<string>\",\n \"template_render_id\": \"<string>\"\n }\n ],\n \"product\": {\n \"id\": \"<string>\",\n \"revision\": 2\n },\n \"quantity\": 2,\n \"options\": [\n {\n \"option_id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"texts\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"schema_version\": 1,\n \"ship_from\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"ship_to\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"quote_id\": \"<string>\",\n \"integration_source\": \"direct_api\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.batchrelay.com/v1/print-orders")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"external_order_id\": \"<string>\",\n \"items\": [\n {\n \"assets\": [\n {\n \"url\": \"<string>\",\n \"asset_id\": \"<string>\",\n \"file_size_bytes\": 2,\n \"hash\": \"<string>\",\n \"origin\": {\n \"design_id\": \"<string>\",\n \"design_version\": 2\n },\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"printed_file_name\": \"<string>\",\n \"template_render_id\": \"<string>\"\n }\n ],\n \"product\": {\n \"id\": \"<string>\",\n \"revision\": 2\n },\n \"quantity\": 2,\n \"options\": [\n {\n \"option_id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"texts\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"schema_version\": 1,\n \"ship_from\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"ship_to\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"quote_id\": \"<string>\",\n \"integration_source\": \"direct_api\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/print-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order\": {\n \"external_order_id\": \"<string>\",\n \"items\": [\n {\n \"assets\": [\n {\n \"url\": \"<string>\",\n \"asset_id\": \"<string>\",\n \"file_size_bytes\": 2,\n \"hash\": \"<string>\",\n \"origin\": {\n \"design_id\": \"<string>\",\n \"design_version\": 2\n },\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"printed_file_name\": \"<string>\",\n \"template_render_id\": \"<string>\"\n }\n ],\n \"product\": {\n \"id\": \"<string>\",\n \"revision\": 2\n },\n \"quantity\": 2,\n \"options\": [\n {\n \"option_id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"texts\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"schema_version\": 1,\n \"ship_from\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"ship_to\": {\n \"address_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"address_2\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"quote_id\": \"<string>\",\n \"integration_source\": \"direct_api\"\n}"
response = http.request(request)
puts response.read_body{
"api_account_id": "<string>",
"channel": "api",
"created_at": "2023-11-07T05:31:56Z",
"external_order_id": "<string>",
"id": "<string>",
"merchant_of_record": "batch_relay",
"order_code": "<string>",
"price": {
"currency": "USD",
"fee_base_cents": 1,
"merchandise_cents": 1,
"minimum_fee_cents": 500,
"platform_fee_basis_points": 1500,
"platform_fee_cents": 501,
"platform_fee_label": "Batch Relay API Access Fee",
"policy_id": "api-access-fee-v1",
"shipping_cents": 1,
"tax_cents": 1,
"total_cents": 2
},
"provider": {
"provider_availability": "preview",
"provider_capability_revision": "<string>",
"provider_environment": "sandbox",
"provider_id": "whcc",
"provider_recipe_revision": "<string>",
"provider_selection_source": "explicit"
},
"provider_offer_lines": [
{
"availability": "available",
"configuration": {},
"currency": "USD",
"line_subtotal_cents": 1,
"offer_id": "<string>",
"pricing_revision": "<string>",
"product": {
"id": "<string>",
"revision": 2
},
"provider_id": "whcc",
"quantity": 2,
"unit_cost_cents": 1
}
],
"quote_id": "<string>",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}