Salla Docs
List Coupons
GET/couponsThis endpoint allows you to return a list of coupons.
Request
Listing the coupons by keywords.
Request samples
Responses
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
Coupon Code
Coupon Type.
Coupon Status.
Coupon amount.
The minimum coupon amount.
The maximum coupon amount.
Whether or not to show the Coupon's Maximum Amount
Coupon Expiry Date. Value MUST be at least one day later than today. Supports two formats, either YYYY-MM-DD or YYYY-MM-DD HH:MM:SS
Coupon Start Date. Supports two formats, either YYYY-MM-DD or YYYY-MM-DD HH:MM:SS
Whether or not to the Coupon includes Free Shipping
Coupon's Usage Limit
Coupon's Usage Limit Per User
List of included Product IDs. List of products ca be found [here]https://docs.salla.dev/api-5394168).
List of excluded Product IDs. List of products ca be found [here]https://docs.salla.dev/api-5394168).
Whether or not to exclude On-Sale Products
List of included product Category IDs. List of categories can be found [here] (https://docs.salla.dev/api-5394207)
List of included Category IDs. List of categories can be found [here] (https://docs.salla.dev/api-5394207)
List of included Customer Group IDs. List of customer groups can be found [here] (https://docs.salla.dev/api-5394129)
List of excluded Customer Group IDs. List of customer groups can be found [here] (https://docs.salla.dev/api-5394129)
List of excluded Brand IDs. List of brands can be found [here] (https://docs.salla.dev/api-5394213)
List of excluded Shipment Company IDs. Shipping companies list can be found here
List of excluded Customer IDs. List of customers can be found [here] (https://docs.salla.dev/api-5394121)
List of included Payment Methods. List of Available Payment Methods can be found here.
Coupon to be applied at. Value can either all or web or app
Whether or not the Coupon is part of a group of Coupons
Coupon Group Name. requiredif is_group = true; otherwise returns null value
Coupon Group Count.requiredif is_group = true; otherwise returns null value
Coupon Group Suffix. requiredif is_group = true; otherwise returns null value
Group Coupons. requiredif is_group = true; otherwise returns null value
Beneficiary’s Email Domain Name
Coupon statistics.
Date and time of creating the coupon.
Date and time of updating the coupon.
Whether or not the Marketing is active for a certain Coupon
Marketer name assoicated to the Coupon. requiredif marketing_active = true; otherwise returns null value
Marketer email assoicated to the Coupon. Value may appear if marketing_acive: true; otherwise returns null value.
Marketing Type. requiredif marketing_active = true; otherwise returns null value
The amount due to the marketer. requiredif marketing_active = true; otherwise returns null value
Whether or not to hide the total sales from the marketer's stastics page. Value may appear if marketing_acive: true; otherwise returns null value.
Whether or not to show the maximum amount of marketing amount to the marketers. Value may appear if marketing_acive: true; otherwise returns null value.
Marketing maximum amount. Value may appear if marketing_acive: true; otherwise returns null value.
Additional Notes to the Marketer. Value may appear if marketing_acive: true; otherwise returns null value.
Marketing Visit Counts. Value may appear if marketing_acive: true; otherwise returns null value.
Marketing URL. Value may appear if marketing_acive: true; otherwise returns null value.
Marketing Statistics URL. Value may appear if marketing_acive: true; otherwise returns null value.
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"status": 200,
"success": true,
"data": [
{
"id": 6930446,
"code": "DEAL",
"type": "fixed",
"status": "active",
"amount": {
"amount": 30,
"currency": "SAR"
},
"minimum_amount": null,
"maximum_amount": {
"amount": 0,
"currency": "SAR"
},
"show_maximum_amount": false,
"expiry_date": "2023-03-17 00:00:00",
"start_date": null,
"free_shipping": true,
"usage_limit": null,
"usage_limit_per_user": null,
"include_product_ids": [],
"exclude_product_ids": [],
"is_sale_products_exclude": true,
"include_category_ids": [],
"exclude_category_ids": [],
"include_customer_group_ids": [],
"exclude_customer_group_ids": [],
"exclude_brands_ids": [],
"exclude_shipping_ids": [],
"include_payment_methods": [],
"applied_in": "all",
"is_group": true,
"group_name": "Deals",
"group_coupons_count": 3,
"group_coupon_suffix": "DEAL",
"group_coupons": [
{
"code": "DEAL5Wsl"
},
{
"code": "DEALgaNN"
},
{
"code": "DEALFRa7"
}
],
"beneficiary_domain": null,
"statistics": {
"num_of_usage": 0,
"num_of_customers": 0,
"coupon_sales": {
"amount": 0,
"currency": "SAR"
}
},
"created_at": {
"date": "2022-04-06 12:55:06.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"updated_at": {
"date": "2022-04-06 12:55:06.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"marketing_active": false,
"marketing_name": null,
"marketing_type": null,
"marketing_amount": null,
"marketing_hide_total_sales": false,
"marketing_show_maximum_amount": false,
"marketing_maximum_amount": null,
"marketing_info": null,
"marketing_visits_count": null,
"marketing_url": null,
"marketing_statistics_url": null
},
{
"id": 1622617640,
"code": "QAZCVS",
"type": "fixed",
"status": "active",
"amount": {
"amount": 30,
"currency": "SAR"
},
"minimum_amount": null,
"maximum_amount": {
"amount": 0,
"currency": "SAR"
},
"show_maximum_amount": false,
"expiry_date": "2023-03-17 00:00:00",
"start_date": null,
"free_shipping": true,
"usage_limit": null,
"usage_limit_per_user": null,
"include_product_ids": [],
"exclude_product_ids": [],
"is_sale_products_exclude": true,
"include_category_ids": [],
"exclude_category_ids": [],
"include_customer_group_ids": [],
"exclude_customer_group_ids": [],
"exclude_brands_ids": [],
"exclude_shipping_ids": [],
"include_payment_methods": [],
"applied_in": "all",
"is_group": false,
"group_name": null,
"group_coupons_count": null,
"group_coupon_suffix": null,
"group_coupons": null,
"beneficiary_domain": null,
"statistics": {
"num_of_usage": 0,
"num_of_customers": 0,
"coupon_sales": {
"amount": 0,
"currency": "SAR"
}
},
"created_at": {
"date": "2022-04-06 12:45:13.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"updated_at": {
"date": "2022-04-06 12:45:13.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"marketing_active": true,
"marketing_name": "Nabil",
"marketing_type": "percentage",
"marketing_amount": {
"amount": 10,
"currency": "SAR"
},
"marketing_hide_total_sales": false,
"marketing_show_maximum_amount": false,
"marketing_info": "",
"marketing_visits_count": 0,
"marketing_url": "https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=ref&utm_campaign=QAZCVS",
"marketing_statistics_url": "https://mtjr.coupons/w172T"
},
{
"id": 242399780,
"code": "azvfpsv",
"type": "fixed",
"status": "active",
"amount": {
"amount": 30,
"currency": "SAR"
},
"minimum_amount": {
"amount": 100,
"currency": "SAR"
},
"maximum_amount": {
"amount": 50,
"currency": "SAR"
},
"show_maximum_amount": false,
"expiry_date": "2023-03-17 00:00:00",
"start_date": "2022-04-24 06:00:00",
"free_shipping": true,
"usage_limit": 10,
"usage_limit_per_user": 1,
"include_product_ids": [
1261174103
],
"exclude_product_ids": [
277818017
],
"is_sale_products_exclude": true,
"include_category_ids": [
256950451,
2064430530
],
"exclude_category_ids": [
307036893
],
"include_customer_group_ids": [
667738032
],
"exclude_customer_group_ids": [],
"exclude_brands_ids": [
1097509908
],
"exclude_shipping_ids": [
1935030040
],
"include_payment_methods": [
"all"
],
"applied_in": "all",
"is_group": false,
"group_name": null,
"group_coupons_count": null,
"group_coupon_suffix": null,
"group_coupons": null,
"beneficiary_domain": "salla.sa",
"statistics": {
"num_of_usage": 0,
"num_of_customers": 0,
"coupon_sales": {
"amount": 0,
"currency": "SAR"
}
},
"created_at": {
"date": "2022-04-06 12:38:06.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"updated_at": {
"date": "2022-04-06 12:59:14.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"marketing_active": true,
"marketing_name": "User Name",
"marketing_type": "percentage",
"marketing_amount": {
"amount": 5,
"currency": "SAR"
},
"marketing_hide_total_sales": false,
"marketing_show_maximum_amount": true,
"marketing_maximum_amount": 4000,
"marketing_info": "Marketing coupon for User Name",
"marketing_visits_count": 0,
"marketing_url": "https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=ref&utm_campaign=azvfpsv",
"marketing_statistics_url": "https://mtjr.coupons/eqOuz"
}
],
"pagination": {
"count": 3,
"total": 3,
"perPage": 15,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}