put

/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}

Updates a Bulk Pricing Rule.

Required Fields

  • none

Read-Only Fields

  • id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Path Parameters
2 Headers

Request Body

1 Example
Schema
object

Common Bulk Pricing Rule properties

id
integer

Unique ID of the Bulk Pricing Rule. Read-Only.

quantity_min
integer

The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. Required in /POST.

3 validations + required
quantity_max
integer

The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule. Required in /POST.

3 validations + required
type
string

The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product. Required in /POST.

3 validations + required
amount
integer

The discount can be a fixed dollar amount or a percentage. For a fixed dollar amount enter it as an integer and the response will return as an integer. For percentage enter the amount as the percentage divided by 100 using string format. For example 10% percent would be “.10”. The response will return as an integer. Required in /POST.

1 validation + required

Responses

1 Example
Schema
object
data
object

Common BulkPricingRule properties

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
product_id
bulk_pricing_rule_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token