Bulk Update Products

POST 
/products/bulk-update

API to bulk update products (price, availability, collections, delete)

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
typestringrequired
Type of bulk update operation
Available optionsbulk-update-pricebulk-update-availabilitybulk-update-product-collectionbulk-delete-productsbulk-update-currency
productIdsstring[]required

Array of product IDs

filtersobject

Filters to apply when selectAll is true

priceobject

Price update configuration

compareAtPriceobject

Compare at price update configuration

availabilityboolean

New availability status

collectionIdsstring[]

Array of collection IDs

currencystring

Currency code

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "type": "bulk-update-price",
  "productIds": [
    "5f8d0d55b54764421b7156c1"
  ],
  "filters": {
    "collectionIds": [
      "5f8d0d55b54764421b7156c1",
      "5f8d0d55b54764421b7156c2"
    ],
    "productType": "one-time",
    "availableInStore": true,
    "search": "blue t-shirt"
  },
  "price": {
    "type": "INCREASE_BY_AMOUNT",
    "value": 100,
    "roundToWhole": true
  },
  "compareAtPrice": {
    "type": "INCREASE_BY_AMOUNT",
    "value": 100,
    "roundToWhole": true
  },
  "availability": true,
  "collectionIds": [
    "string"
  ],
  "currency": "USD"
}

application/json

Products updated successfully

application/json

Schema

Schema

statusbooleanrequired

Status of api action

messagestring

Success message

Example (auto)

{
  "status": true,
  "message": "Successfully created"
}