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

Create Coupon

POST

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

Create a new coupon with various options such as discount type, validity period, usage limits, and application conditions.

🔑Scopes

coupons.read_write - Coupons Read & Write

Notes

max_weight only applies to free shipping coupons (type: free_shipping).

It works similarly to max_total but limits the total cart weight.

If the total weight exceeds this limit, the coupon will not apply.

This field has no effect on discount or fixed-amount coupon types.

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/managers/store/coupons/add' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--form 'name="Summer Sale - July 2026"' \
--form 'code="SUMMER2026"' \
--form 'discount_type="p"' \
--form 'discount="20"' \
--form 'free_shipping="1"' \
--form 'free_cod="0"' \
--form 'total="100"' \
--form 'date_start="2023-07-01"' \
--form 'date_end="2023-07-31"' \
--form 'uses_total="100"' \
--form 'uses_customer="3"' \
--form 'is_mazeed_active=""' \
--form 'is_pos_active=""' \
--form 'is_mobile_app_active=""' \
--form 'status="1"'

Responses

🟢200OK

application/json

Body

Example

{
    "status": "object",
    "coupon": {
        "coupon_id": 5875333,
        "id": 5875333,
        "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-2",
        "uses_total": 100,
        "created_at": "2026-02-23T09:44:37.000000Z",
        "name": "Summer Sale - July 2026 - 2",
        "total_usage": null,
        "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,
        "orders": [],
        "total_sales": 0,
        "total_customers": 0,
        "note": 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,
        "apply_to_data": []
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🟠400Bad Request

🟠422Validation Error

🔴500Internal Server error

Modified at 2026-02-23 09:25:01

View Coupon

Update Coupon