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

View Coupon

GET

https://api.zid.sa/v1/managers/store/coupons/{coupon-id}/view

Fetches detailed information about a specific coupon using its unique coupon_id. This endpoint provides all attributes of a coupon, including usage statistics, conditions, and status.

🔑Scopes

coupons.read - Coupons Read

Request

Path 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/5875333/view' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Accept: application/json'

Responses

🟢200OK

application/json

Body

Example

{
    "status": "object",
    "coupon": {
        "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,
        "orders": [],
        "total_sales": 0,
        "total_customers": 0,
        "note": 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,
        "apply_to_data": []
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-23 11:31:39

List Coupons

Create Coupon