List All Discounts



page * Fetch the results from a specific page. It defaults to 1.

per_page * The number of results to fetch per page. The maximum is 50 and if it defaults to 10.

from date-format Start date used for filtering.

to date-format End date used for filtering.

sort_by An optional identifier used for sorting results. The available options are name, type and applies_to.

filter Optional text used for filtering results.

product_id If provided, it will return the discounts that apply to the product.

customer_id If provided, it will return the discounts that apply to the customer.

type If provided, it will return the discounts with a matching type. The possible values are customer_discount and product_discount.

applies_to Flag used for filtering discounts. The possible values are all_products, selected_products and selected_categories.

condition Filters discounts by their main condition. The possible values are all_orders, item_subtotal, item_quantity, coupon, vouchers, order_subtotal and order_quantity.

status Filters discounts by status. The possible values are active and inactive.