🔒 The Discount Rebate List API retrieves a list of discount rebates available for a shop. This enables users to manage and view rebate details for promotions and campaigns.
This API is especially useful for:
Viewing available discount rebates in the store.
Managing rebate campaigns for customers.
Fetching rebate details with optional URL links for each campaign.
📘 Parameter Type Required Description Example cursorstring No Cursor for pagination, use the cursor from the response to retrieve the next page cursor_123456page_sizeint32 No A limit on the number of objects to be returned. Ranges from 1 to 250. Default is 10 20need_detail_urlboolean No If true, returns detail URLs in the response true
📘 Parameter Type Example Description codestring 200Error code (200 indicates success) messagestring SuccessError message dataobject {...}Contains the price rules data data.rebatesarray of objects [ {...}, {...} ]List of rebate promotion objects data.cursorstring cursor_123456Cursor for pagination data.has_moreboolean trueIndicates if there are more results available
Parameter Type Example Description idstring rb_123456Unique identifier of the rebate promotion titlestring Summer Rebate ProgramName of the rebate promotion discount_typestring percentageType of discount (percentage, fixed_amount) valuefloat 10.0Discount value amount value_typestring percentageType of discount value (percentage, fixed_amount) starts_atstring 2023-06-01T00:00:00ZStart date and time (ISO 8601 format) ends_atstring 2023-06-30T23:59:59ZEnd date and time (ISO 8601 format) statusstring activeCurrent status of the promotion usage_limitint32 100Maximum number of times the promotion can be used times_usedint32 45Number of times the promotion has been used once_per_customerint32 1Whether limited to once per customer (1=yes, 0=no) allocation_methodstring eachHow discounts are allocated (each, across) allocation_limitint32 1Limit of discount allocation allocation_limit_amountfloat 5.0Maximum amount for allocation limit customer_selectionstring allCustomer selection method (all, prism, explicit) target_selectionstring allTarget selection method (all, prism, explicit) target_typestring line_itemType of target (line_item, shipping_line) target_price_typestring originalPrice type target (original, current) product_numint32 42Number of products included progressstring 50%Current participation progress sortstring prioritySorting priority prerequisiteint32 0Prerequisite condition flag prerequisite_customer_idsarray of strings ["cust_123", "cust_456"]List of prerequisite customer IDs prerequisite_customer_segment_idsarray of strings ["seg_123", "seg_456"]List of prerequisite customer segment IDs prerequisite_customer_rangestring newCustomer range for prerequisite prerequisite_quantity_rangearray of objects [ {...} ]Prerequisite quantity range conditions prerequisite_subtotal_rangearray of objects [ {...} ]Prerequisite subtotal range conditions prerequisite_threshold_quantity_rangestring 5Threshold quantity range prerequisite_threshold_subtotal_rangestring 100.0Threshold subtotal range entitled_product_idsarray of strings ["prod_123", "prod_456"]List of entitled product IDs entitled_variant_idsarray of strings ["var_123", "var_456"]List of entitled variant IDs entitled_collection_idsarray of strings ["coll_123", "coll_456"]List of entitled collection IDs entitled_filter_idsarray of strings ["flt_123", "flt_456"]List of entitled filter IDs entitled_filter_listarray of strings ["filter1", "filter2"]List of entitled filter list items entitled_area_listarray of strings ["area1", "area2"]List of entitled area list items variant_product_idsarray of strings ["prod_123", "prod_456"]List of variant product IDs global_show_textstring Summer SpecialGlobal display text popups_idstring popup_123Associated popup ID popups_settingstring {"color":"red"}Popup settings in JSON format discount_channel_listarray of objects [ {...} ]List of discount channels entitled_extra_listarray of objects [ {...} ]List of entitled extra items
Parameter Type Example Description greater_than_or_equal_tostring 5Minimum quantity valuestring 5Quantity value value_percentagestring 10.0Quantity percentage value value_event_typestring purchaseEvent type for quantity value_conditionstring greater_thanCondition for quantity comparison target_typestring line_itemTarget type for quantity target_dataarray of strings ["prod_123"]Target data for quantity
Parameter Type Example Description greater_than_or_equal_tostring 100.0Minimum subtotal amount valuestring 100.0Subtotal value value_percentagestring 10.0Subtotal percentage value value_event_typestring purchaseEvent type for value value_conditionstring greater_thanCondition for value comparison target_typestring line_itemTarget type for value target_dataarray of strings
Field Type Example Description codestring InvalidParameterError http message messagestring `` Error message
