Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Discounts

(ms.discounts_new)

It contains the discounts provided to the users.

Fields
EndPoints

Fields

Value Description
name   
Type: string
Required
Name of the discount.
FLAT 100
rule_type   
Type: string
Required
Rule type defines whether the discount is product based or order based.
product
amount   
Type: number
Required
Amount of the discount.
100
apply_on   
Type: string
apply_on   
Type: string
enabled   
Type: string
Select the checkbox to enable discounts.
1
advance_settings   
Type: string
Enable the advance settings, if you want to apply conditions to the discount.
1
apply_with   
Type: string
validity   
Type: string
The duration for which the discount will be applicable.
infinite
number_of_uses   
Type: number
Maximum usage of the discount allowed.
2
start_date   
Type: string
Starting date and time for application of the discount.
2018-04-25T06:48:00.000Z
end_date   
Type: string
Date and time at which the discount expires.
2018-04-30T06:48:00.000Z
seller   
Type: string
Seller for which the discount is applicable.
5ac383106eecb937c95196f3
use_count   
Type: string
Number of times the discount is to be used.
50

Commands (Endpoints)

POST /api/1.1/entity/ms.discounts_new   
Creates a new discount
DEL /api/1.1/entity/ms.discounts_new/{resource_id}   
Deletes a discount
PUT /api/1.1/entity/ms.discounts_new/{resource_id}   
Updates an existing discount
GET /api/1.1/entity/ms.discounts_new/{resource_id}   
Retrieves a single discount
GET /api/1.1/entity/ms.discounts_new   
Retrieves a list of discounts