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

The product's ID.

Minimum string length: 1
quantity
integer
default:1

The quantity to price. unitPrice is the price per unit at this quantity.

Required range: 1 <= x <= 9007199254740991
includeMakerDetails
boolean
default:false

Also return maker.details

Response

200 - application/json

OK

productId
string
required

The product's ID.

Minimum string length: 1
title
string
required

The product's title.

categoryId
string
required

The category's ID, from categories/list.

Minimum string length: 1
maker
object
required
selections
object
required

The option values the product was made with, as option key to option value.

selectionLabel
string
required

A readable summary of the product's options.

imageUrl
string<uri>
required

URL of a small version of the main product image. It expires; call the endpoint again for a fresh one. The host can change.

createdAt
string<date-time>
required

When the product was made.

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 image the product was made from. For a print product, this is its pattern. For a jewelry product, this is the product's own image, which is not a pattern: you cannot read it with patterns/get, refine it, use it as a reference or make another product from it. Read a jewelry product's images with products/get.

Minimum string length: 1
unitPrice
object | null
required

The price of one unit at the quantity you asked for, before the volume discount. Null when pricing is temporarily unavailable; try again later.