Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

Body

application/json

Direct product URL

Example:

"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205"

mode
enum<string>

Response mode. Use sync to wait up to 30 seconds for the backing worker flow to complete.

Available options:
async,
sync
Example:

"async"

selectedOptions
string[]

An ordered array of option values to select for the product. Will be selected in the order listed.

Example:
country
string

Country code for the product's location

Example:

"US"

skipCache
boolean
default:false

When true, bypass any cached product details and force a fresh fetch. Fresh results still repopulate the cache.

Example:

false

Response

Product details queued successfully, use refId to check status and retrieve results

refId
string
required
Pattern: ^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$
status
enum<string>
required
Available options:
pending,
processing,
complete,
failed
result
object
error
object