Skip to main content
GET
Get one active product

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

product_id
string
required
Minimum string length: 1

Response

Canonical product

fulfillment_type
enum<string>
required
Available options:
print,
digital
Allowed value: "print"
tax_category
enum<string>
required
Available options:
physical_print,
digital_download
Allowed value: "physical_print"
asset_requirements
object[]
required
category
enum<string>
required
Available options:
prints,
keepsakes,
trader-products,
composites,
digital-downloads
description
string
required
family
object
required

Discovery grouping shared by related immutable products. Do not use a family ID in an order.

id
string
required

Stable canonical product identifier.

lifecycle
object
required
name
string
required
options
object[]
required
physical_output
object
required

Required for physical print products and omitted for digital products.

revision
integer
required

Immutable fulfillment-contract revision.

Required range: x >= 1
template_requirement
enum<string>
required

Product-specific template policy. required accepts only artwork from a succeeded Batch Relay template render; optional accepts either a compatible rendered output or direct prepared artwork; unsupported has no template workflow.

Available options:
required,
optional,
unsupported
unit_costs
object[]
required
units_per_quantity
integer
required

Units produced or delivered by one line quantity.

Required range: x >= 1
variant_attributes
object
required

Display and filtering attributes for one immutable variant. These values do not replace the product ID and revision in an order.

consumer_quantity
object
fulfillment_target
object

The standard physical product used for provider-neutral routing after a composed product has flattened to finished artwork.

prepared_artwork
object
print_safety_profile
object
text_requirements
object[]

Provider-neutral ordered text slots supported by this product. The current catalog publishes six generic Memory Mate slots while final visual/provider field labels are under verification; clients must use the returned slot IDs rather than infer provider node IDs.