Create a New Coupon

POSTv1/managers/store/coupons/add

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

Request

Header Params

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:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

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

Allowed values:

enar

Example:

Body Params multipart/form-data

name

string

required

The name of the coupon for the merchant's own reference. This name will appear on the merchant dashboard and is not visible to the customer.

Example:

Summer Sale - July 2023

code

string

required

The unique code for the coupon.

Example:

SUMMER2023

discount_type

enum<string>

required

The type of discount to be applied. Use 'f' for a fixed amount and 'p' for a percentage.

Allowed values:

Example:

discount

string

required

The value of the discount.

Example:

free_shipping

string

required

1 to enable free shipping, 0 to disable it.

Example:

free_cod

string

required

1 to enable free Cash On Delivery (COD), 0 to disable it.

Example:

total

string

required

The minimum total amount of items in the cart, before shipping, VAT, and other fees, required to apply the coupon. The currency considered is the store's default currency.

Example:

100

date_start

string

required

The start date for the coupon validity.

Example:

2023-07-01

date_end

string

required

The end date for the coupon validity.

Example:

2023-07-31

uses_total

integer

required

The maximum number of times the coupon can be used.

Example:

100

uses_customer

integer

required

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

Example:

apply_to

enum<string>

required

Specifies where the coupon can be applied.

Allowed values:

allnon_discounted_productsdiscounted_productsproductscategoriesexcluded_products

Example:

all

apply_to_array

array[string]

optional

An array of product UIDs or category IDs on which the coupon will be applied. This field is relevant only if apply_to is set to products, categories, or excluded_products.

When apply_to is set to products or categories, the coupon will apply only to the items or categories specified in this array.
When apply_to is set to excluded_products, the coupon will apply to all items except those specified in this array.

Example:

["UID1","UID2"]

is_mazeed_active

enum<integer>

optional

Indicates whether the coupon is active in Mazeed.

Allowed values:

Default:

Example:

is_pos_active

enum<integer>

optional

Indicates whether the coupon is active in the Point of Sale (POS) system.

Allowed values:

Default:

Example:

is_mobile_app_active

enum<integer>

optional

Indicates whether the coupon is valid in the mobile application.

Allowed values:

Default:

Example:

status

string

required

1 to activate the coupon, 0 to deactivate it.

Example:

Request samples

Responses

Coupon successfully created.(200)

Coupon successfully created.

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a month ago