Inventory API
Products

Bulk Update

This API endpoint (POST) bulk updates a limited set of attributes (such as stock, pricing or expiry date) on multiple products with a single request. If the request succeeds, it will return the ids of the products that were updated. Permissions: products.edit Webhook events: product-updated, product-stock-updated and product-price-updated (for each product updated). For more advanced bulk editing see Power Editor.

Body Parameters

products array of strings * An array of strings each representing a product id that you wish to update. The maximum products that can be updated in a single request is 300.



stock_updates object Configure this attribute if you like to bulk update the stock of your products. Stock updates apply to all product types including items with unlimited stock.

JSON

  • stock integer * The number of items to add or remove from the product's stock.
  • action string * Determines how the price changes will be applied to the products. The available options are increase and decrease.

If an item has variations configured, then the stock updates will be applied to variants.



pricing_updates array of objects Configure this attribute if you like to bulk update one or more pricing model of your products. Pricing updates are available on a percentage basis or fixed amount.

JSON

  • currency string Currency codes* The currency of the pricing model that will be updated. The price changes will be applied if the items have a valid pricing model in this currency.
  • price_change_percent integer * The percentage change to apply to the product's price. Optional if price_change_fixed is provided.
  • price_change_fixed integer * A fixed amount to add or substrack from the product's price. Optional if price_change_percent is provided.
  • action string * Determines how the price changes will be applied to the products. The available options are increase and decrease.



If an item has variations configured then the price changes will be applied to all variants.

Pricing updates are not available for billing plans.



new_from date-format The date that products were launched for sale as a brand new item.



new_to date-format After this date the products will not be considered as brand new items.



expiry_date date-format After this date the products will not be available for sale.



release_date date-format The date that the products will be released for sale.



max_units integer The maximum amount of stock that can be purchased in a single order.



min_units integer The minimum amount of stock that can be purchased in a single order.



on_sale boolean Determines if the products have any active special promotion or sale.



buyable boolean Determines if the products are available for sale and can be purchased via external sites and checkout flows.



discount_allowed boolean Determines if the products can have any discounts applied to it.



shown boolean Determines if the products are currently visible in external assets.



exclude_from_feed boolean Determines if the products will be included in third party feeds and product search engines.



unlimited_stock boolean Determines if the products can have unlimited stock. It will ignore items with type physical_products, physical_services or any product with manual licensing.



retries integer The number of retries that are allowed when the customer fails to pay for their billing plan. Available for billing plans.



cancel_action string Determines what action is taken when all available retries for a recurring payment have failed. The possible values are pause and cancel. Available for billing plans.



cancel_behaviour string Determines how cancelations are handled. The possible values are immediate and end_of_period. Available for billing plans.