Skip to main content
POST
commerce.product.upsert

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
catalogId
string
required

From commerce.catalogs.list.

Required string length: 1 - 256
retailerId
string
required

Your SKU: updates the product with this SKU, or creates it.

Required string length: 1 - 100
accountId
string

The connected business account, from local.locations.list. Optional when only one is connected.

Required string length: 1 - 256
name
string

Product name. Needed for a new product.

Required string length: 1 - 200
description
string

Product description.

Required string length: 1 - 9999
url
string

Product page, a public http or https URL. Needed for a new product.

imageUrl
string

Main image, a public http or https URL. Needed for a new product.

price
object

Regular price. Needed for a new product.

salePrice
object

Sale price, in the same currency as price.

availability
enum<string>

Stock status.

Available options:
in_stock,
out_of_stock,
preorder,
available_for_order,
discontinued
condition
enum<string>

Condition of the product.

Available options:
new,
refurbished,
used
brand
string

Brand name.

Required string length: 1 - 100
inventory
number

Units in stock, a whole number from 0.

Required range: x >= 0

Response

The result

status
enum<string>
required

Whether the product was created or updated.

Available options:
created,
updated
retailerId
string
required

Your SKU, as sent.