Dukan icon

Dukan

Interact with the Dukan API

Store Coupon → Get Many

AI-generated

Summary

Retrieve multiple store coupons from the Dukan store API with support for pagination, filtering, sorting, and custom API credentials or base URL.

Inputs

  • Force Custom Auth Header — Optional boolean to use a provided custom API key instead of the node's configured credentials.
  • Force Custom Base URL — Optional boolean to use a custom Base URL instead of the one in configured credentials.
  • Custom Base URL — Optional string for overriding the Base URL when Force Custom Base URL is enabled. Should not include the "/v1/external" suffix.
  • Custom API Key — Optional API key string to send when Force Custom Auth Header is enabled.
  • Page Number — Number indicating the page of results to retrieve (minimum 1, default 1).
  • Limit — Maximum number of coupons to return (minimum 1, default 50).
  • Sort — String specifying the fields to sort the returned coupons by (default is descending by creation date, "-createdAt"). Multiple fields can be space-separated.
  • Populate Fields — Space-separated list of related fields to populate and return within the coupon objects.
  • Select Fields — Space-separated list of coupon object fields to include in the returned results.
  • Offset — Number of results to skip before returning (default 0).
  • Filter — A JSON string representing a MongoDB-style filter object to restrict which coupons are returned (default is empty filter {}).
  • Request Options — Additional options for the HTTP request such as batching, proxy, timeout, and SSL settings.

Output shape

a list of store coupon objects matching the filter and query parameters

The response returns an array of coupon objects subject to the requested pagination, filtering, sorting, and field selection. If pagination parameters are omitted, it defaults to page 1 with up to 50 results. Filtering follows MongoDB query syntax. Optional custom API key and base URL override credentials settings.

Links

Discussion