Skip to main content
POST
Preview Channel List Price

Authorizations

Authorization
string
header
required

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

Body

application/json
platform
enum<string>
required
Available options:
shopee,
lazada,
tiktok,
shopify,
whatsapp,
zalora,
amazon,
ebay
listPrice
number
required

Canonical list price to mark up.

organizationId
string

Required for session auth across multiple organizations. Optional for OAuth/API keys bound to one organization.

Maximum string length: 120
storeId
string | null
Maximum string length: 200
country
string | null
Maximum string length: 80
currency
string | null
Required string length: 3
ruleId
string<uuid>

Optional force a specific rule instead of specificity matching.

Response

Preview computed.

listPrice
number
required
channelListPrice
number
required
applied
boolean
required
source
enum<string>
required
Available options:
price_book,
canonical
markupPercent
number
currency
string

Listed currency when known. A buyer formula with CURRENCY sets it.

belowCatalogPrice
boolean

Present and true when the buyer formula lists below the catalog price in the same currency. This is usually a payout formula, price * (1 - fees), used where the gross-up, price / (1 - fees), was meant.

formulaError
string

Set when the matched buyer formula cannot price this list price. Publish fails for that listing instead of using the catalog price.

rule
object | null
message
string