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

Update Coupon

POST

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

This endpoint allows merchants to update details of an existing coupon. Merchants can modify attributes such as discount value, expiration date, and usage limits.

🔑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

Path Params

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/5812220/update' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36' \
--form 'name="osama";type=text' \
--form 'code="osama";type=text' \
--form 'discount_type="f";type=text' \
--form 'discount="155";type=number' \
--form 'total="0";type=number' \
--form 'date_start="2021-02-10";type=date' \
--form 'date_end="2021-02-28";type=date' \
--form 'uses_total="1000";type=number' \
--form 'uses_customer="1000";type=number' \
--form 'free_shipping="1";type=boolean' \
--form 'coupon_status="1";type=boolean' \
--form 'shipping="1";type=boolean' \
--form 'products[]="92cbba07-fe84-49f5-96ba-ab5308d781b9";type=text' \
--form 'is_pos_active="1";type=boolean' \
--form 'max_total=""' \
--form 'max_weight=""'

Responses

🟢200OK

application/json

Body

Example

{
    "status": "success",
    "coupon": {
        "coupon_id": 3292,
        "id": 3292,
        "store_id": 1,
        "store_name": "Osama's Testing Store",
        "store_logo": "https://example.com/logo.jpg",
        "code": "osama",
        "uses_total": 0,
        "created_at": "2025-01-28T07:35:50.000000Z",
        "name": "osama",
        "total_usage": null,
        "discount_type": "f",
        "applying_method": "CODE",
        "conditions": null,
        "discount": 155,
        "logged": false,
        "free_shipping": false,
        "free_cod": false,
        "apply_to": "all",
        "total": 0,
        "max_total": 0,
        "max_weight": 1,
        "date_start": "2025-02-12",
        "date_end": "2025-03-12",
        "uses_customer": 0,
        "coupon_status": false,
        "enabled": 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,
        "apply_to_data": []
    },
    "message": {
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

🟠422Validation Error

Modified at 2026-02-11 10:07:35

Retrieve Coupon

Delete Coupon