Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.batchrelay.com/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to Batch Relay API — a REST API built for developers, operations teams, and workflow builders who need to programmatically create and manage print orders. Whether you’re integrating from a custom application, an n8n workflow, or a homegrown automation script, Batch Relay gives you a predictable HTTP interface, bearer-token security, and a full sandbox environment so you can ship with confidence.

Quick Start

Create your first sandbox print order in minutes. Walk through authentication, your first API call, and verifying the response.

Authentication

Learn how bearer API keys and fine-grained scopes work, and how to rotate or scope-limit your credentials safely.

Products & Orders

Explore the print-order data model, available product types, and how to structure a POST /v1/print-orders request.

Errors

Understand error shapes, HTTP status codes, and how to handle retries and validation failures gracefully.

​
Get Up and Running

1

Create an Account

Sign up for a Batch Relay account to receive your dashboard access and initial API credentials.
2

Generate an API Key

In the dashboard, create a bearer API key with the scopes your integration needs. Store it securely — it won’t be shown again.
3

Submit a Sandbox Order

Point your requests at the sandbox environment and call POST /v1/print-orders with an Idempotency-Key header. Inspect the response and test webhook events without incurring real charges.
4

Go Live in Production

Once your integration is validated, swap in your production API key and endpoint. Billing is enforced automatically via the Stripe integration on your first live order.

​
Explore the Full API

Sandbox Testing

Simulate the full order lifecycle — including edge cases and failure modes — before touching production.

Idempotency

Use the Idempotency-Key header to safely retry requests without creating duplicate orders.

Webhooks

Subscribe to print order lifecycle events and trigger downstream actions the moment an order status changes.

Billing

Understand how the Stripe billing gate works and what happens when a payment method is missing or declined.

n8n Integration

Install the Batch Relay community node for n8n and build no-code print-order workflows in minutes.

OpenAPI Contract

Download the OpenAPI spec to auto-generate typed clients and SDKs for any language or framework.