Skip to main content

Preview Bulk Listing Inventory Settings Update

POST 
/api/v2/listings/bulk-edit-inventory-preview

Dry run for Bulk Update Listing Inventory Settings. Computes exactly which listings would change and what each field's old and new values would be, without applying anything. Use it to validate a bulk update before committing it.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields:

  • ids (required, array of integers) — listing IDs to evaluate
  • inventory_settings (required, object) — the settings that would be applied

inventory_settings fields (all optional within the object):

  • inherit (boolean) — when true, clears all listing-level overrides so the listing inherits settings from its channel account; all other settings fields are ignored
  • master_of_stock (string|null) — one of: sku.io, sales_channel, amazon, neither
  • warehouse_ids (array of integers|null) — warehouse IDs used for the listing's available quantity
  • warehouse_action (string) — how warehouse_ids are applied: replace (default), add, or clear
  • fulfillment_latency (integer|null, 0-30) — handling time in days
  • max_rule_type (string|null) — one of: None, Fixed Allocation, % of Available
  • max_rule_value (number|null, min 0) — value paired with max_rule_type
  • min_rule_type (string|null) — one of: None, Fixed Allocation, % of Available
  • min_rule_value (number|null, min 0) — value paired with min_rule_type
  • subtract_buffer_stock (integer|null, min 0) — buffer quantity subtracted from availability

FBA listings are excluded from the evaluation (their inventory is managed by the fulfillment network); the count of excluded listings is returned as skipped_fba. Listings whose settings already match report no changes and are not included in the changes array.

max_rule_value / min_rule_value are required when the matching max_rule_type / min_rule_type is Fixed Allocation or % of Available; sending such a rule type with no value (missing or null) is refused with 422 naming the rule. With None the value is ignored.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type