Skip to main content
POST
Retrieve a product

Authorizations

Authorization
string
header
required

An API key from Settings → API keys in Arcade Studio.

Body

application/json
productId
string
required

Opaque product ID

Minimum string length: 1
quantity
integer
default:1

The quantity pricing is quoted for

Required range: 1 <= x <= 9007199254740991

Response

200 - application/json

OK

productId
string
required

Opaque product ID

Minimum string length: 1
title
string
required
categoryId
string
required

Category ID, from categories.list

Minimum string length: 1
maker
object
required
selections
object
required

The selection the product was made with, option value per option key

selectionLabel
string
required

Human-readable summary of the selection

imageUrl
string<uri>
required

Thumbnail of the primary product image. Short-lived; read again to renew. Host not guaranteed.

createdAt
string<date-time>
required
images
object[]
required

Product images, primary first

description
string | null
required

Product details; null when they cannot be loaded

careInstructions
string
required

Empty when there are none or they cannot be loaded right now

volumeDiscounts
object | null
required

Spend tiers of the maker's volume discount; empty when it has none, and null when they are unavailable right now

patternId
string
required

The pattern the product was made from

Minimum string length: 1
unitPrice
object | null
required

The price of one unit when ordering quantity, before the volume discount; null while pricing is unavailable, so read again later