Skip to main content
PUT
Add or update a product listing

Authorizations

Authorization
string
header
required

API key issued by VitaRelay. Send as Authorization: Bearer vr_live_… (production) or Authorization: Bearer vr_test_… (sandbox).

Body

application/json
platform_product_id
string<uuid>
required
markup_type
enum<string>
required
Available options:
percent,
flat
markup_value
number
default:0
Required range: x >= 0
custom_title
string | null
custom_description
string | null
rx_mode
enum<string>
default:none
Available options:
none,
refill_only,
refill_or_approval,
approval
is_listed
boolean
default:true
purchase_mode
enum<string>

Controls whether checkout permits one-time purchases, subscriptions, or both.

Available options:
one_time,
subscription,
both
default_cadence
enum<string> | null
Available options:
weekly,
monthly,
quarterly,
null
first_order_immediate
boolean

Response

The created or updated listing.

product
object

One curated product in the patient shop.