Helpcenter +918010117117 https://help.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" [email protected] https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India

Related Topics

Understanding Themes Global Objects Global Widgets Startup Scripts

Global Entities

ms.email_logs ms.mailing_lists ms.invoices Overview ms.reviews ms.fulfillment ms.fulfillments ms.languages ms.coupon_codes ms.redirects ms.store_ledger ms.collections ms.enquiries ms.navigations ms.discounts_new ms.brands ms.notifications ms.ssl_certificates ms.domains ms.store_locations ms.categories ms.blogs ms.sellers ms.pages ms.orders ms.carts ms.users ms.products

Coupon Codes

(ms.coupon_codes)

{...} swagger

Offering coupon code can be a key strategy for marketing of your online store.

Fields

Value Description
coupon_code
Type: string
 Name of the Coupon Code.
Example:

GET 25
type
Type: string
 Type of coupon code. It can be either flat or percentage type.
Example:

flat
amount
Type: number
 Amount of the discount.
Example:

25
description
Type: string
 Description of the coupon code.
Example:

Get Rs 25 on order total greater than 500
enabled
Type: string
 Select the checkbox to enable coupon code.
Example:

1
conditions
Type: array
 Array of conditions which decides the applicability of coupon code.
Example: 
"conditions":[ { "field":"order.total", "operator":"greater_than", "value":"500" } ]
conditions.field
Type: string
Required 		Name of the field on which condition is to be applied.
conditions.operator
Type: string
Required 		Operator can be equal,not_equal,less_than or greater_than.
conditions.value
Type: string
Required 		Value of the field on which condition is to be applied.
number_of_uses
Type: number
 Maximum usage allowed.
Example:

3
uses_per_user
Type: number
 Maximum usage allowed per user.
Example:

2
seller
Type: string
 Seller for which the coupon code is applicable.
Example:

586f990997da96ba5c9ae2ac
advance_settings
Type: string
 Enable the advance settings, if you want to apply conditions.
Example:

1
start_date
Type: string
 Starting date and time for application of coupon code.
Example:

2018-04-25T06:48:00.000Z
end_date
Type: string
 Date and time at which the coupon code expires.
Example:

2018-04-30T06:48:00.000Z
user_count
Type: string
Read Only
 		This field holds the count of users who have used this code.
Example:

1

Commands

Name Routes
add post  /api/1/entity/ms.coupon_codes TRY IT !
edit put  /api/1/entity/ms.coupon_codes/{_id} TRY IT !
list get  /api/1/entity/ms.coupon_codes TRY IT !
get get  /api/1/entity/ms.coupon_codes/{_id} TRY IT !
delete delete  /api/1/entity/ms.coupon_codes/{_id} TRY IT !