POST

Bulk Adjust Product Variants By Filter


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adjusts the price and cost of multiple variants, given the provided filter and search expression.

Only the following variant fields can be increased/decreased by amount or percentage:

  • compareAtPrice
  • actualPrice
  • cost
  • compareAtPriceDiscount
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/bulk/products/adjust-variants-by-filter

Body Params
filterstructRequired

Filter object.


costCost

Cost adjustment.


roundingstring

Rounding strategy of new calculated prices.

  • NO_ROUNDING: Calculated prices will be saved without rounding to keep max possible precision.
  • CURRENCY_PRECISION: Calculated prices will be rounded according to the currency's precision requirements. For example. $3.5555 will be saved as $3.56; ¥3.5555 will be saved as ¥4.
  • NEAREST_WHOLE_NUMBER: Calculated prices will be rounded to the nearest whole number.

searchSearch

Free text to match in searchable fields.


actualPriceActualPrice

Actual price adjustment.


compareAtPriceCompareAtPrice

Compare at price adjustment.


compareAtPriceDiscountCompareAtPriceDiscount

Set variant actualPrice from compareAtPrice by applying provided discount to it. if compare-at-price doesn't exist, actualPrice will be set to compareAtPrice and the discount will be calculated from it. For example variant compareAtPrice 100$, variant actualPrice is 95$, requested compareAtPriceDiscount.percentage is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).

Response Object
jobIdstringformat GUID

Job ID.

Pass this ID to Get Async Job to retrieve job details and metadata..

Bulk adjust product variants by filter

Decreases the actual price, compare at price, and cost of all product variants that were created after July 22nd, 2024.

Request
cURL
Response
JSON
Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?