Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Management API token, sent as Authorization: Bearer <token>.

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
relay_status_store_group_slug
string
required

The target inherits its status from this store group's price; falls back to the target's own status, or the source status when the target has no price yet. Must be one of store_groups.

store_groups
object[]
required

The store groups whose prices are summed into the relayed price.

Minimum array length: 1
active
boolean
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_store_group and the target's own state.

percentage_of_source
integer
percentage_of_source_decimals
integer
relay_on_sale_store_group_slug
string

When set, the target inherits its on-sale flag and sale window from this store group's price; omit to leave the target's own. Must be one of store_groups.

rounding
object
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