Skip to main content
PATCH
Update 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.

Path Parameters

ruleId
string
required

Query Parameters

organizationId
string

Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.

Maximum string length: 120

Body

application/json
organizationId
string
Maximum string length: 120
storeId
string | null
Maximum string length: 200
country
string | null
Maximum string length: 80
marginValue
number
Required range: 0 <= x <= 500
rounding
enum<string>
Available options:
none,
currency_minor,
nearest_0_05,
nearest_1
currency
string | null
Required string length: 3
enabled
boolean

Response

Price book rule updated.

rule
object
required