Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

List Coupons

GET

https://api.zid.sa/v1/managers/store/coupons

Retrieves a list of all available coupons from the system. The response includes active, inactive, and expired coupons along with relevant metadata such as store details, discount type, and validity period.

🔑Scopes

coupons.read - Coupons Read

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/managers/store/coupons?page=1&per_page=100' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Accept: application/json'

Responses

🟢200

application/json

Body

Example

{
    "status": "object",
    "coupons": [
        {
            "coupon_id": 5851950,
            "id": 5851950,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "49QA62",
            "uses_total": 0,
            "created_at": "2026-02-17T13:58:45.000000Z",
            "name": "qqqq",
            "total_usage": 0,
            "discount_type": "p",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 111,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-02-17",
            "date_end": "2026-03-17",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_active",
            "maximum_discount_value": null,
            "is_mazeed_active": false,
            "is_pos_active": false,
            "is_shown_in_pos": false,
            "is_mobile_app_active": false,
            "is_manageable": true,
            "is_active": true,
            "enabled": true
        },
        {
            "coupon_id": 5825112,
            "id": 5825112,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "SUMMER2027",
            "uses_total": 100,
            "created_at": "2026-02-11T10:20:55.000000Z",
            "name": "Summer Sale - July 2026",
            "total_usage": 0,
            "discount_type": "p",
            "applying_method": "CODE",
            "conditions": null,
            "conditions_criteria": "all",
            "discount": 20,
            "logged": false,
            "free_shipping": true,
            "free_cod": false,
            "apply_to": "all",
            "total": 100,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2023-07-01",
            "date_end": "2023-07-31",
            "uses_customer": 3,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": false,
            "is_pos_active": false,
            "is_shown_in_pos": false,
            "is_mobile_app_active": false,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5825099,
            "id": 5825099,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "SUMMER2026",
            "uses_total": 100,
            "created_at": "2026-02-11T10:17:20.000000Z",
            "name": "Summer Sale - July 2026",
            "total_usage": 0,
            "discount_type": "p",
            "applying_method": "CODE",
            "conditions": null,
            "conditions_criteria": "all",
            "discount": 20,
            "logged": false,
            "free_shipping": true,
            "free_cod": false,
            "apply_to": "all",
            "total": 100,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2023-07-01",
            "date_end": "2023-07-31",
            "uses_customer": 3,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": false,
            "is_pos_active": false,
            "is_shown_in_pos": false,
            "is_mobile_app_active": false,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5825057,
            "id": 5825057,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "SUMMER2023",
            "uses_total": 100,
            "created_at": "2026-02-11T10:03:15.000000Z",
            "name": "Summer Sale - July 2023",
            "total_usage": 0,
            "discount_type": "p",
            "applying_method": "CODE",
            "conditions": null,
            "conditions_criteria": "all",
            "discount": 20,
            "logged": false,
            "free_shipping": true,
            "free_cod": false,
            "apply_to": "all",
            "total": 100,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2023-07-01",
            "date_end": "2023-07-31",
            "uses_customer": 3,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": false,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5776886,
            "id": 5776886,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "7OCRIH",
            "uses_total": 0,
            "created_at": "2026-02-01T06:49:44.000000Z",
            "name": "same date not today",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 1111,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-03-01",
            "date_end": "2026-03-01",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_unstarted",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5776884,
            "id": 5776884,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "AO6AJ8",
            "uses_total": 0,
            "created_at": "2026-02-01T06:49:24.000000Z",
            "name": "different date",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 11,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-02-01",
            "date_end": "2026-03-01",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_active",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": true,
            "is_active": true,
            "enabled": true
        },
        {
            "coupon_id": 5776883,
            "id": 5776883,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "P2ZAHN",
            "uses_total": 0,
            "created_at": "2026-02-01T06:49:05.000000Z",
            "name": "same 01",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 100,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-02-01",
            "date_end": "2026-02-01",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5776865,
            "id": 5776865,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "C3X1YX",
            "uses_total": 0,
            "created_at": "2026-02-01T06:37:23.000000Z",
            "name": "Same date",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 100,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-02-01",
            "date_end": "2026-03-01",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_active",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": true,
            "is_active": true,
            "enabled": true
        },
        {
            "coupon_id": 5776862,
            "id": 5776862,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "Q2W6R4",
            "uses_total": 0,
            "created_at": "2026-02-01T06:36:22.000000Z",
            "name": "same",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 100,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-02-01",
            "date_end": "2026-02-01",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5776429,
            "id": 5776429,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "samedate",
            "uses_total": 0,
            "created_at": "2026-02-01T01:24:38.000000Z",
            "name": "samedate",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 100,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-02-02",
            "date_end": "2026-02-02",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5762202,
            "id": 5762202,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "4WGXAA",
            "uses_total": 0,
            "created_at": "2026-01-28T11:01:03.000000Z",
            "name": "Discount",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 0,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "discounted_products",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-01-29",
            "date_end": "2026-01-29",
            "uses_customer": 0,
            "coupon_status": false,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5762201,
            "id": 5762201,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "VZJ4LL",
            "uses_total": 0,
            "created_at": "2026-01-28T11:00:17.000000Z",
            "name": "Discount",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 0,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-01-29",
            "date_end": "2026-01-29",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5762140,
            "id": 5762140,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "XA1ATX",
            "uses_total": 0,
            "created_at": "2026-01-28T10:43:35.000000Z",
            "name": "test-same-dates 03",
            "total_usage": 0,
            "discount_type": "f",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 0,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-01-28",
            "date_end": "2026-01-28",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        },
        {
            "coupon_id": 5761870,
            "id": 5761870,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "naqua100",
            "uses_total": 0,
            "created_at": "2026-01-28T09:26:29.000000Z",
            "name": "NAQUA100",
            "total_usage": 1,
            "discount_type": "p",
            "applying_method": "CODE",
            "conditions": [],
            "conditions_criteria": "all",
            "discount": 100,
            "logged": false,
            "free_shipping": true,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-01-28",
            "date_end": "2026-02-28",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_active",
            "maximum_discount_value": null,
            "is_mazeed_active": true,
            "is_pos_active": true,
            "is_shown_in_pos": true,
            "is_mobile_app_active": true,
            "is_manageable": true,
            "is_active": true,
            "enabled": true
        },
        {
            "coupon_id": 5730602,
            "id": 5730602,
            "store_id": 3,
            "store_name": "متجر أسامة.",
            "store_logo": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg",
            "code": "OSAMA5OFF",
            "uses_total": 0,
            "created_at": "2026-01-21T11:46:12.000000Z",
            "name": "5% off",
            "total_usage": 0,
            "discount_type": "p",
            "applying_method": "CODE",
            "conditions": null,
            "conditions_criteria": "all",
            "discount": 5,
            "logged": false,
            "free_shipping": false,
            "free_cod": false,
            "apply_to": "all",
            "total": 0,
            "max_total": 0,
            "max_weight": 0,
            "date_start": "2026-01-21",
            "date_end": "2026-02-21",
            "uses_customer": 0,
            "coupon_status": true,
            "status_code": "coupon_expired",
            "maximum_discount_value": null,
            "is_mazeed_active": false,
            "is_pos_active": false,
            "is_shown_in_pos": false,
            "is_mobile_app_active": false,
            "is_manageable": false,
            "is_active": false,
            "enabled": false
        }
    ],
    "count": 341,
    "grand_total": 341,
    "active_coupons_count": 14,
    "inactive_coupons_count": 0,
    "expired_coupons_count": 326,
    "pagination": {
        "page": 1,
        "page_size": 15,
        "next_page": 2,
        "last_page": 23,
        "result_count": 341
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-23 11:16:44

Coupons

View Coupon