Skip to main content
POST
Error

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

Body

application/json

source rule details

market_slug
string
required
name
string
required
store_group_slug
string
required
active
boolean
amount_from
string

The source price field that feeds the target's amount_cents_with_tax: 'amount' (the default), 'sale_price' or 'reference_price'. A source that hasn't set the field relays nothing.

filters
object
force_on_sale
boolean

Overrides the target's on-sale flag with this value; when omitted the flag is left to relay_on_sale and the target's own state.

percentage_of_source
integer
percentage_of_source_decimals
integer
relay_on_sale
boolean

When true the source relay's its on-sale flag and sale window to the target; when false the target keeps its own.

rounding
object
sale_price_from
string

The source price field that feeds the target's sale_price_with_tax: 'amount', 'sale_price' or 'reference_price'. Omit it to let the target keep its sale_price.

tax_country_code
string

Response

source rule created

data
object
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success
boolean