Skip to main content

Bulk Product Operation (Sync)

POST 

/api/magento1/instances/:integrationInstance/products/bulk

Runs a bulk operation on catalog products synchronously — best for small "Selected Only" requests. For large "All Filtered" sets that may exceed the HTTP timeout, use Bulk Product Operation (Tracked) instead.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body fields:

  • action (string, required): one of archive, unarchive, delete, map, unmap, create, remap. map/remap link by the product's own SKU; archive skips products that already carry channel orders.
  • selection (object, required):
    • selection.type (required): selected | visible | filtered.
    • selection.ids (array<int>, required when type=selected): magento1_products.id PKs.
    • selection.filters (object, optional): the same filter[...] tree as the listing, used when type=filtered/visible to resolve the id set server-side.
  • options (object, optional): action-specific options.

Returns per-action counts. 422 if the selection resolves to zero products.

Authentication: Requires Bearer token.

Request

Responses

OK