Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Body

application/json
buyer
object
required
quantity
integer<int32>
required
Required range: x >= 0
Example:

1

productUrl
string
required
Example:

"https://www.amazon.com/dp/B0DFC9MT8Q"

referenceId
string
Maximum string length: 255
Example:

"order-1234"

discoverPromoCodes
boolean
constraints
object
promoCodes
string[]
Maximum array length: 16

Promo code string with validation constraints.

  • Must contain only letters, digits, underscores, or hyphens
  • Maximum length of 32 characters
Maximum string length: 32
Pattern: ^[a-zA-Z0-9_\-]+$
variantSelections
object[]

Response

Created

buyer
object
required
quantity
integer<int32>
required
Required range: x >= 0
productUrl
string
required
createdAt
string<date-time>
required
id
string
required
state
enum<string>
required
Available options:
retrieving_offer
referenceId
string
Maximum string length: 255
Example:

"order-1234"

discoverPromoCodes
boolean
constraints
object
promoCodes
string[]

Promo code string with validation constraints.

  • Must contain only letters, digits, underscores, or hyphens
  • Maximum length of 32 characters
Maximum string length: 32
Pattern: ^[a-zA-Z0-9_\-]+$
variantSelections
object[]