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.

The Batch Relay n8n node is a planned integration that will let you connect print-on-demand order automation directly into your n8n workflows — no custom HTTP request nodes or manual authentication wiring required. Once released, you will be able to trigger print orders, validate shipment details, and pull usage summaries as first-class steps inside any workflow you build.
The n8n node is not yet released. The details below reflect the planned design so you can prepare your workflows in advance.

Credentials

When you add the Batch Relay node to your n8n instance, you will be prompted to supply two credential values:
  • Batch Relay API Key — your secret key used to authenticate every request
  • Base URL — the root endpoint for the API (for example, https://api.batchrelay.com)
Store these in n8n’s built-in credential store so they are encrypted at rest and reusable across multiple workflows.

Operations

The initial release of the node will expose the following operations:
OperationDescription
Create Print OrderSubmit a new live print order against your account
Create Sandbox Print OrderSubmit a test order in the sandbox environment without incurring charges
Validate Print OrderCheck that all order fields are valid before committing
Submit Print OrderConfirm and dispatch a previously created order
Get Print OrderRetrieve the current status and details of an existing order
Get Usage SummaryFetch aggregate usage and billing data for your account

Field Mapping

When you configure an order operation, the node exposes the following fields for you to populate — either with static values or dynamic expressions from earlier nodes in your workflow:
  • Product alias — the identifier for the product you want to print
  • Quantity — number of units to produce
  • Image URL — publicly accessible URL of the print-ready artwork
  • Ship-to name — recipient’s full name
  • Ship-to address — destination street address, city, state, ZIP, and country
  • External order ID — your own reference ID for cross-system tracking
  • Idempotency key — a unique token that prevents duplicate order submission; the node auto-generates a UUID for you when you leave this field blank
  • Billing required toggle — flag that controls whether billing validation is enforced on the order
  • Metadata JSON — arbitrary key-value pairs you want stored alongside the order for later retrieval
Let the node generate the idempotency key automatically unless you have a specific key you need to reuse (for example, when retrying a failed submission). Supplying the same key a second time is safe — Batch Relay will return the original order rather than creating a duplicate.