Update Coupon - Zid Docs

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

Request

Path Params

coupon-id

string

required

Unique identifier of the coupon

Example:

123

Header Params

string

required

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Example:

application/json

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6IlA3WTFZbWk1YVBTQnNrYkRtOFBGZGc9PSIsInZhbHVlIjoiL3QvVmtuMHFQdGNMdkNwZ0FCZkh3Y1l4aEs5NDhGVnFXbWVZYlFJb2kucdcNrekppN09CVTlnYlducjRLbjhXNzhFTFhhZDZTSXdRbUphSEYyUkZJWTJFZ0h3Ymlzb1RVNmxlaEkjgftrmpIZ1RmZXVFYUszZG5DZDZjbTRqNzByNVBMTktzYkQ3WGQ5MDhqbWo2NWFkT3MvRExmYVY4YXBCakkwSjR1L2pTbUR4dWZvd2h5K2tTQlAvRlN2TnZuOVFROW42WTRqZmtkWUZWem4rRXFLVU00aGJtQT0iLCJtYWMiOiJjM2U2ZGRmMjY1ZjFmMmI5YjZlMzFkMGFhNmMzYjM5ZjhiOWE0YjVhMzU2ZTRhYTkxOTVlYmFiMTVkY2I1NWQ2IiwidGFnIjoiIn0=

Accept-Language

string

required

Preferred language for the response. Defaults to en if not specified.

Example:

User-Agent

string

required

The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

Body Params multipart/form-data

name

string

required

The name of the coupon usually for internal reference.

Example:

osama

code

string

required

The unique coupon code that customers will enter to avail the discount.

Example:

osama

discount_type

string

required

The type of discount applied. Possible values are p for percentage-based discount and f for fixed amount discount.

Example:

discount

string

required

The discount value applied by the coupon. If discount_type is p this represents a percentage if f it represents a fixed amount.

Example:

155

total

string

optional

The minimum order total required for the coupon to be applicable. If 0 no minimum order total is required.

Example:

date_start

string

optional

The start date of the coupon validity in YYYY-MM-DD format.

Example:

2021-02-10

date_end

string

optional

The end date of the coupon validity in YYYY-MM-DD format.

Example:

2021-02-28

uses_total

string

optional

The total number of times the coupon can be used across all customers.

Example:

1000

uses_customer

string

optional

The number of times a single customer can use the coupon.

Example:

1000

free_shipping

string

optional

Indicates if the coupon provides free shipping. 1 for enabled 0 for disabled.

Example:

coupon_status

string

optional

The status of the coupon. 1 for active 0 for inactive.

Example:

shipping

string

optional

Determines whether the coupon applies to shipping costs. 1 for enabled 0 for disabled.

Example:

products[]

string

optional

A list of product IDs that the coupon is applicable to.

Example:

92cbba07-fe84-49f5-96ba-ab5308d781b9

is_pos_active

string

optional

Determines whether the coupon is active for Point of Sale (POS) transactions. 1 for active 0 for inactive.

Example:

Request 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/123/update' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'X-Manager-Token: eyJpdiI6IlA3WTFZbWk1YVBTQnNrYkRtOFBGZGc9PSIsInZhbHVlIjoiL3QvVmtuMHFQdGNMdkNwZ0FCZkh3Y1l4aEs5NDhGVnFXbWVZYlFJb2kucdcNrekppN09CVTlnYlducjRLbjhXNzhFTFhhZDZTSXdRbUphSEYyUkZJWTJFZ0h3Ymlzb1RVNmxlaEkjgftrmpIZ1RmZXVFYUszZG5DZDZjbTRqNzByNVBMTktzYkQ3WGQ5MDhqbWo2NWFkT3MvRExmYVY4YXBCakkwSjR1L2pTbUR4dWZvd2h5K2tTQlAvRlN2TnZuOVFROW42WTRqZmtkWUZWem4rRXFLVU00aGJtQT0iLCJtYWMiOiJjM2U2ZGRmMjY1ZjFmMmI5YjZlMzFkMGFhNmMzYjM5ZjhiOWE0YjVhMzU2ZTRhYTkxOTVlYmFiMTVkY2I1NWQ2IiwidGFnIjoiIn0=' \
--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'

Responses

🟢200OK

application/json

Body

Schema for the 'update coupon' response.

status

string

optional

Status of the API response.

Example:

success

coupon

object

optional

Details of the updated coupon.

coupon_id

integer

optional

Unique coupon identifier.

Example:

3292

integer

optional

Coupon ID (same as coupon_id).

Example:

3292

store_id

integer

optional

ID of the store offering the coupon.

Example:

store_name

string

optional

Name of the store.

Example:

Osama's Testing Store

store_logo

string <uri>

optional

URL of the store logo.

Example:

https://example.com/logo.jpg

code

string

optional

Coupon code.

Example:

osama

uses_total

integer

optional

Total times the coupon has been used.

Example:

created_at

string <date-time>

optional

Timestamp when the coupon was created.

Example:

2025-01-28T07:35:50.000000Z

name

string

optional

Coupon name.

Example:

osama

total_usage

integer | null

optional

Total times the coupon has been used, can be null.

Example:

null

discount_type

string

optional

Type of discount (p = percentage, f = fixed amount).

Example:

applying_method

string

optional

Method of coupon application.

Example:

CODE

conditions

array[string] | null

optional

Conditions for coupon application.

Example:

null

discount

number

optional

Discount value.

Example:

155

logged

boolean

optional

Indicates if the coupon is logged.

Example:

false

free_shipping

boolean

optional

Whether the coupon offers free shipping.

Example:

false

free_cod

boolean

optional

Whether the coupon offers free cash-on-delivery.

Example:

false

apply_to

string

optional

Applicable scope of the coupon.

Example:

all

total

integer

optional

Total discount amount.

Example:

max_total

integer

optional

Maximum total discount allowed.

Example:

date_start

string <date>

optional

Coupon start date.

Example:

2025-02-12

date_end

string <date>

optional

Coupon end date.

Example:

2025-03-12

uses_customer

integer

optional

Number of times a customer can use the coupon.

Example:

coupon_status

boolean

optional

Indicates if the coupon is currently active.

Example:

false

enabled

boolean

optional

Indicates if the coupon is enabled.

Example:

false

status_code

string

optional

Status code of the coupon.

Example:

coupon_inactive

maximum_discount_value

number | null

optional

Maximum discount value allowed, can be null.

Example:

null

orders

array[string]

optional

List of orders associated with the coupon.

Example:

[]

total_sales

integer

optional

Total sales generated by the coupon.

Example:

total_customers

integer

optional

Total number of customers who used the coupon.

Example:

note

string | null

optional

Additional note about the coupon, can be null.

Example:

null

is_mazeed_active

boolean

optional

Indicates if the coupon is active in Mazeed.

Example:

false

is_pos_active

boolean

optional

Indicates if the coupon is active in POS.

Example:

false

is_shown_in_pos

boolean

optional

Indicates if the coupon is visible in POS.

Example:

false

is_mobile_app_active

boolean

optional

Indicates if the coupon is active in the mobile app.

Example:

false

apply_to_data

array[string]

optional

Data related to where the coupon is applied.

Example:

[]

message

object

optional

Message details.

code

string | null

optional

Message code, can be null.

Example:

null

name

string | null

optional

Message name, can be null.

Example:

null

description

string | null

optional

Message description, can be null.

Example:

null

Example

{
  "status": "object",
  "coupon": {
    "coupon_id": 3292,
    "id": 3292,
    "store_id": 1,
    "store_name": "Osama's Testing Store",
    "store_logo": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/3dfc16e6-ad19-4126-9c2a-5e4a7fb73051/4cf56c8d-22ad-46d9-a5f4-4d46a47da1aa-200x.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,
    "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": {
    "type": "object",
    "code": null,
    "name": null,
    "description": null
  }
}