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 coupon discount

🔑Scopes

third_order_write - Coupons 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 '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 2 - July 2026"' \
--form 'discount_type="f"' \
--form 'code="SUMMER20262"' \
--form 'discount="20"'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "status": "object",
    "coupon": {
        "coupon_id": 6336925,
        "id": 6336925,
        "store_id": 3,
        "store_name": "متجر أسامة.",
        "store_logo": null,
        "code": "SUMMER20262",
        "uses_total": 0,
        "created_at": "2026-06-15T14:23:36.000000Z",
        "name": "Summer Sale 2 - July 2026",
        "total_usage": null,
        "discount_type": "f",
        "applying_method": "CODE",
        "discount_strategy": "standard",
        "progressive_config": null,
        "conditions": null,
        "conditions_criteria": "all",
        "discount": 20,
        "logged": false,
        "free_shipping": false,
        "free_cod": false,
        "apply_to": "all",
        "total": 0,
        "max_total": 0,
        "max_weight": 0,
        "date_start": "2026-06-15",
        "date_end": "2026-07-15",
        "uses_customer": 0,
        "coupon_status": false,
        "status_code": "coupon_inactive",
        "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": true,
        "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-06-15 14:25:16

View Coupon

Generate Bulk Coupons