POST

Bulk Adjust Product Properties

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 a specified numerical property for up to 100 products at a time. The property can be increased or decreased either by percentage or amount.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Products
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v1/bulk/products/adjust-properties
Body Params
idsArray <string>RequiredminItems 1maxItems 100

Product IDs.

adjustAdjust

Numerical property to adjust.

Response Object
resultsArray <BulkProductResult>

Bulk action results.

bulkActionMetadataBulkActionMetadata

Bulk action metadata.

Request
cURL
curl -X POST \
  https://www.wixapis.com/stores/v1/bulk/products/adjust-properties \
  -H 'Authorization: <AUTH>'
  -H 'Content-Type: application/json' \
  --data-binary '{
    "ids": [
      "bfcafbe6-b671-4ebe-8e3d-49f242cef188",
      "e5419878-8284-4f02-98bb-087e1d8dc781"
    ],
    "adjust": {
      "price": {
        "percentage": {
          "roundToInt": false,
          "rate": 200
        }
      }
    }
  }'
Response
JSON
{
  "results": [
    {
      "itemMetadata": {
        "id": "bfcafbe6-b671-4ebe-8e3d-49f242cef188",
        "originalIndex": 0,
        "success": true
      }
    },
    {
      "itemMetadata": {
        "id": "e5419878-8284-4f02-98bb-087e1d8dc781",
        "originalIndex": 1,
        "success": true
      }
    }
  ],
  "bulkActionMetadata": {
    "totalSuccesses": 2,
    "totalFailures": 0,
    "undetailedFailures": 0
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?