Skip to main content
PATCH
Update Product Price

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

productId
string<uuid>
required

OmniCommerce simple-product or variant UUID.

Body

application/json
price
number
required

New catalog list price. Provide price or salePrice.

Required range: x >= 0
salePrice
number | null

Optional sale price. Use null to clear it; it must be below the list price.

Required range: x >= 0
currency
string

Three-letter ISO currency code.

Pattern: ^[A-Za-z]{3}$
syncToMarketplaces
boolean
default:false

Queue durable sync jobs after the Omni catalog update.

targets
object[]

Exact enabled and published marketplace accounts. Requires syncToMarketplaces=true.

Required array length: 1 - 25 elements

Response

Catalog price updated; no marketplace job was queued.

apiVersion
enum<string>
required
Available options:
developer_v1
ok
enum<boolean>
required
Available options:
true
operationId
string<uuid>
required
status
enum<string>
required
Available options:
completed,
accepted
productId
string<uuid>
required
warnings
string[]
required
recommendations
string[]
required
data
object
required
jobId
string<uuid>