Dukan icon

Dukan

Interact with the Dukan API

Store Pro Stock → Update Quantity

AI-generated

Summary

Update the quantity of a specific store stock variable by applying a positive or negative delta to its current quantity.

Inputs

  • Stock Variable ID (required) — The MongoDB ObjectId of the stock variable to update the quantity for.
  • Quantity Delta (required) — The numeric amount to add to (positive) or subtract from (negative) the current stock quantity.
  • Force Custom Auth Header — Whether to use a custom API key defined in this node instead of the credentials.
  • Custom API Key — The API key used when Force Custom Auth Header is enabled.
  • Force Custom Base URL — Whether to use a custom base URL defined in this node instead of the credentials.
  • Custom Base URL — The custom base URL to use for API requests when Force Custom Base URL is enabled.
  • Request Options — Additional optional request settings like batching, proxy, timeout, and SSL handling.

Output shape

A single record representing the updated stock variable after quantity adjustment.

The operation expects valid input IDs and quantity deltas; optional authentication and API endpoint overrides are available. The response contains the updated stock data reflecting the changed quantity.

Examples

Example 1: Update stock quantity by increasing 5 units

Set Stock Variable ID to the target stock item's ObjectId and Quantity Delta to 5 to add five units.

Example 2: Decrease stock quantity by 3 units with a custom API key

Enable Force Custom Auth Header, provide a Custom API Key, input the stock variable ID, and set Quantity Delta to -3.

Links

Discussion