Coupon Codes
(ms.coupon_codes)
Offering coupon code can be a key strategy for marketing of your online store.
Fields
| Name | 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:
| ||||||
| 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 ! |
Coupon Codes
(ms.coupon_codes)
Offering coupon code can be a key strategy for marketing of your online store.
Fields
| Name | 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:
| ||||||
| 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 | ||||||
| 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. |
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 ! |