Skip to main content
POST
Create Price Book Rule

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
marginValue
number
required

Markup percent applied to canonical list price.

Required range: 0 <= x <= 500
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

Optional connected store ID. Null/omit applies to all stores for the platform.

Maximum string length: 200
country
string | null

Optional country scope (name or code). Null/omit applies to all countries.

Maximum string length: 80
rounding
enum<string>

Defaults to currency_minor when omitted.

Available options:
none,
currency_minor,
nearest_0_05,
nearest_1
currency
string | null

Optional ISO 4217 currency for currency_minor rounding.

Required string length: 3
enabled
boolean
default:true

Whether the rule is active. Defaults to true.

Response

Price book rule created.

rule
object
required