Discount

The Discount service manages discounts, including creating, updating, and retrieving configurations. It also handles discount items and validates discount files for accuracy before processing.

Discount

Discount is used to offer special pricing or promotional offers to customers.Discounts can create new discounts for customers, view details of specific discounts, and update discount configurations as needed. Discounts are promotional strategies that allow businesses to offer reduced prices or special offers on products or services."Discount" can create new discounts tailored to specific customer segments or product categories. Discount provides detailed information about existing discounts, such as discount amount, duration, and eligibility criteria. Discount allows configurations dynamically, allowing for flexibility in promotional strategies. Whether it's offering percentage-based discounts, buy-one-get-one (BOGO) offers, or limited-time promotions, the "Discount" helps to implement and manage various discount strategies effectively.

Operations
GET
/service/platform/discount/v1.0/company/{company_id}/job/
# List discounts
POST
/service/platform/discount/v1.0/company/{company_id}/job/
# Create discount
GET
/service/platform/discount/v1.0/company/{company_id}/job/{id}/
# Get discount
PUT
/service/platform/discount/v1.0/company/{company_id}/job/{id}/
# Update discount
GET

List discounts

Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount
Requires company/price_rules/read access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
view
string
Specifies the format in which the discounts are displayed. Options are 'listing' for a list view or 'calendar' for a calendar view. Defaults to 'listing'.
Enum
q
string
The search query. This can be a partial or complete name of a discount.
page_no
integer
The page number to navigate through the given set of results. Default is 1.
page_size
integer
Number of items to retrieve in each page. Default is 12.
archived
boolean
Indicates whether to include expired discounts in the results. Defaults to false.
Enum
month
integer
The month for which discounts is requested. Defaults to the current month if not specified.
year
integer
The year for which discounts is requested. Defaults to the current year if not specified.
type
string
Specifies the type of disocunt to list, either 'basic' or 'custom'.
app_ids
array of string
A `application_id` is a unique identifier for a particular sales channel.
Response
200
400
Success
ListOrCalender
items
array of object (DiscountJob)
List of discount jobs.
Array of DiscountJob
_id
string
The unique identifier for the discount job.
name
string
The name of the discount job.
company_id
integer
The unique identifier for the company.
is_active
boolean
Indicates if the discount job is currently active.
app_ids
array of string
List of application IDs associated with the discount job.
job_type
string
The type of job associated with the discount job.
Enum
discount_type
string
The type of discount being offered.
Enum
discount_level
string
The level at which the discount is applied.
value
integer
The value of the discount.
file_path
string
The file path for discount file.
brand_ids
array of integer
List of brand IDs associated with the discount job.
store_ids
array of integer
List of store IDs associated with the discount job.
zone_ids
array of string
List of zone IDs associated with the discount job.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
The date and time when the discount job was created.
modified_on
string
| date-time
The date and time when the discount job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the discount job.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
90
view:
"listing"
q:
"Contract Test Basic"
page_no:
1
page_size:
10
month:
1
year:
2090
type:
"basic"
app_ids:
"646f43ee3b7f8c2847e31fb0"
GET
/service/platform/discount/v1.0/company/{company_id}/job/
Loading...
Response
Loading...
POST

Create discount

Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount
Requires company/price_rules/write access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
Request body
name
string
Required
The name of the discount.
company_id
integer
Required
The unique identifier for the company.
is_active
boolean
Required
Indicates if the discount is currently active.
app_ids
array of string
Required
List of application IDs associated with the discount.
extension_ids
array of string
List of extension IDs associated with the discount.
job_type
string
Required
The type of job associated with the discount.
Enum
discount_type
string
Required
The type of discount being offered.
Enum
discount_level
string
Required
The level at which the discount is applied.
Enum
value
integer
The value of the discount.
file_path
string
The file path for discount file.
brand_ids
array of integer
List of brand IDs associated with the discount.
store_ids
array of integer
List of store IDs associated with the discount.
zone_ids
array of string
List of zone IDs associated with the discount.
validity
object (ValidityObject)
Required
ValidityObject
start
string
| date-time
Required
The start date and time of the discount period.
end
string
| date-time
Required
The end date and time of the discount period.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Required
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
Response
200
400
Success
DiscountJob
_id
string
The unique identifier for the discount job.
name
string
The name of the discount job.
company_id
integer
The unique identifier for the company.
is_active
boolean
Indicates if the discount job is currently active.
app_ids
array of string
List of application IDs associated with the discount job.
job_type
string
The type of job associated with the discount job.
Enum
discount_type
string
The type of discount being offered.
Enum
discount_level
string
The level at which the discount is applied.
value
integer
The value of the discount.
file_path
string
The file path for discount file.
brand_ids
array of integer
List of brand IDs associated with the discount job.
store_ids
array of integer
List of store IDs associated with the discount job.
zone_ids
array of string
List of zone IDs associated with the discount job.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
The date and time when the discount job was created.
modified_on
string
| date-time
The date and time when the discount job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the discount job.
Examples
Parameters
company_id:
90
body:
body
POST
/service/platform/discount/v1.0/company/{company_id}/job/
Loading...
Response
Loading...
GET

Get discount

Retrieve a single discount by its id.
Requires company/price_rules/read access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount.
Response
200
400
Success
DiscountJob
_id
string
The unique identifier for the discount job.
name
string
The name of the discount job.
company_id
integer
The unique identifier for the company.
is_active
boolean
Indicates if the discount job is currently active.
app_ids
array of string
List of application IDs associated with the discount job.
job_type
string
The type of job associated with the discount job.
Enum
discount_type
string
The type of discount being offered.
Enum
discount_level
string
The level at which the discount is applied.
value
integer
The value of the discount.
file_path
string
The file path for discount file.
brand_ids
array of integer
List of brand IDs associated with the discount job.
store_ids
array of integer
List of store IDs associated with the discount job.
zone_ids
array of string
List of zone IDs associated with the discount job.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
The date and time when the discount job was created.
modified_on
string
| date-time
The date and time when the discount job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the discount job.
Examples
Parameters
company_id:
90
id:
"64a7c915c160922f34ba4f12"
GET
/service/platform/discount/v1.0/company/{company_id}/job/{id}/
Loading...
Response
Loading...
PUT

Update discount

Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on).
Requires company/price_rules/write access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount.
Request body
name
string
Required
The name of the discount.
company_id
integer
Required
The unique identifier for the company.
is_active
boolean
Required
Indicates if the discount is currently active.
app_ids
array of string
Required
List of application IDs associated with the discount.
extension_ids
array of string
List of extension IDs associated with the discount.
job_type
string
Required
The type of job associated with the discount.
Enum
discount_type
string
Required
The type of discount being offered.
Enum
discount_level
string
Required
The level at which the discount is applied.
Enum
value
integer
The value of the discount.
file_path
string
The file path for discount file.
brand_ids
array of integer
List of brand IDs associated with the discount.
store_ids
array of integer
List of store IDs associated with the discount.
zone_ids
array of string
List of zone IDs associated with the discount.
validity
object (ValidityObject)
Required
ValidityObject
start
string
| date-time
Required
The start date and time of the discount period.
end
string
| date-time
Required
The end date and time of the discount period.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Required
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
Response
200
400
Success
DiscountJob
_id
string
The unique identifier for the discount job.
name
string
The name of the discount job.
company_id
integer
The unique identifier for the company.
is_active
boolean
Indicates if the discount job is currently active.
app_ids
array of string
List of application IDs associated with the discount job.
job_type
string
The type of job associated with the discount job.
Enum
discount_type
string
The type of discount being offered.
Enum
discount_level
string
The level at which the discount is applied.
value
integer
The value of the discount.
file_path
string
The file path for discount file.
brand_ids
array of integer
List of brand IDs associated with the discount job.
store_ids
array of integer
List of store IDs associated with the discount job.
zone_ids
array of string
List of zone IDs associated with the discount job.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
The date and time when the discount job was created.
modified_on
string
| date-time
The date and time when the discount job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the discount job.
Examples
Parameters
company_id:
90
id:
"64a7c915c160922f34ba4f12"
body:
body
PUT
/service/platform/discount/v1.0/company/{company_id}/job/{id}/
Loading...
Response
Loading...

Discount File

The Discount File consolidates functionalities for managing discount-related files, including downloading and validating them. A Discount File resource facilitates the retrieval of discount-related files for analysis or use, and ensures their accuracy and proper implementation within the system. Discount File resource can download discounts information in specified file formats containing discount data for further analysis or utilization, initiate download jobs, monitor their progress, and cancel them if needed. Additionally, the Resource enables seller to validate discount files, ensuring the accuracy of discount rules and configurations applied to products or inventory. Discount File can track progress of discount validation jobs and cancel them if necessary, ensuring seamless management of discount-related processes and adherence to discount policies.

Operations
POST
/service/platform/discount/v1.0/company/{company_id}/file/validation/
# Validate discount file
POST
/service/platform/discount/v1.0/company/{company_id}/file/{type}/download/
# Get discount file
GET
/service/platform/discount/v1.0/company/{company_id}/file/validation/{id}/
# List validation job discount
DEL
/service/platform/discount/v1.0/company/{company_id}/file/validation/{id}/
# deletel validation job discount
GET
/service/platform/discount/v1.0/company/{company_id}/file/download/{id}/
# List discount download job
DEL
/service/platform/discount/v1.0/company/{company_id}/file/download/{id}/
# delete discount download job
POST

Validate discount file

Validates the discount file for any discrepancies. like item should be valid etc..
Requires company/price_rules/write access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
discount
string
Unique identifier for the discount.
Request body
name
string
Required
Name of the file job.
is_active
boolean
Required
Indicates if the job is active.
company_id
integer
Required
Unique Identifier for the company.
app_ids
array of string
Required
List of application identifiers.
job_type
string
Required
Type of job.
Enum
discount_type
string
Type of discount.
Enum
discount_level
string
Required
Level at which the discount is applied.
file_path
string
Path to the disocunt file.
brand_ids
array of integer
List of brand identifiers.
store_ids
array of integer
List of store identifiers.
validity
object (ValidityObject)
Required
ValidityObject
start
string
| date-time
Required
The start date and time of the discount period.
end
string
| date-time
Required
The end date and time of the discount period.
meta
object
Additional metadata for the disocunt.
Response
200
400
Success
FileJobResponseSchema
stage
string
Current stage of the file job.
total
integer
Total number of items processed.
failed
integer
Number of items that failed processing.
company_id
integer
Identifier for the company.
body
object (FileJobBody)
FileJobBody
name
string
The name of the job.
company_id
integer
Unique identifier for the company.
is_active
boolean
Indicates if the job is active.
app_ids
array of string
List of application identifiers.
job_type
string
Type of job being processed.
Enum
discount_type
string
Type of discount applied.
Enum
discount_level
string
Level at which the discount is applied.
value
integer
Value of the discount.
file_path
string
Path to the discount file associated with the job.
brand_ids
array of integer
List of brand identifiers.
store_ids
array of integer
List of store identifiers.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the job.
type
string
Type of file job.
Enum
file_type
string
Type of file being processed.
Enum
_id
string
A unique identifier to distinguish and identify a job.
file_path
string
Path to the disocunt file.
progress
integer
Progress of the file job.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
Examples
Parameters
company_id:
90
discount:
"6512735aa98e0ed14ef1f1fd"
body:
body
POST
/service/platform/discount/v1.0/company/{company_id}/file/validation/
Loading...
Response
Loading...
POST

Get discount file

Retrieve a discount file by its type, it could be product or inventory.
Requires company/price_rules/read access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
type
string
Required
The type of discount file to download, either 'product' or 'inventory'.
Enum
Request body
brand_ids
array of integer
List of brand identifiers.
store_ids
array of integer
List of store identifiers.
Response
200
400
Success
FileJobResponseSchema
stage
string
Current stage of the file job.
total
integer
Total number of items processed.
failed
integer
Number of items that failed processing.
company_id
integer
Identifier for the company.
body
object (FileJobBody)
FileJobBody
name
string
The name of the job.
company_id
integer
Unique identifier for the company.
is_active
boolean
Indicates if the job is active.
app_ids
array of string
List of application identifiers.
job_type
string
Type of job being processed.
Enum
discount_type
string
Type of discount applied.
Enum
discount_level
string
Level at which the discount is applied.
value
integer
Value of the discount.
file_path
string
Path to the discount file associated with the job.
brand_ids
array of integer
List of brand identifiers.
store_ids
array of integer
List of store identifiers.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the job.
type
string
Type of file job.
Enum
file_type
string
Type of file being processed.
Enum
_id
string
A unique identifier to distinguish and identify a job.
file_path
string
Path to the disocunt file.
progress
integer
Progress of the file job.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
Examples
Parameters
company_id:
90
body:
body
POST
/service/platform/discount/v1.0/company/{company_id}/file/{type}/download/
Loading...
Response
Loading...
GET

List validation job discount

Retrieve a validation job of a discount by its id.
Requires company/price_rules/read access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount.
Response
200
400
Success
FileJobResponseSchema
stage
string
Current stage of the file job.
total
integer
Total number of items processed.
failed
integer
Number of items that failed processing.
company_id
integer
Identifier for the company.
body
object (FileJobBody)
FileJobBody
name
string
The name of the job.
company_id
integer
Unique identifier for the company.
is_active
boolean
Indicates if the job is active.
app_ids
array of string
List of application identifiers.
job_type
string
Type of job being processed.
Enum
discount_type
string
Type of discount applied.
Enum
discount_level
string
Level at which the discount is applied.
value
integer
Value of the discount.
file_path
string
Path to the discount file associated with the job.
brand_ids
array of integer
List of brand identifiers.
store_ids
array of integer
List of store identifiers.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the job.
type
string
Type of file job.
Enum
file_type
string
Type of file being processed.
Enum
_id
string
A unique identifier to distinguish and identify a job.
file_path
string
Path to the disocunt file.
progress
integer
Progress of the file job.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
Examples
Parameters
company_id:
90
id:
"6519669e7fc0cd03ce111ab9"
GET
/service/platform/discount/v1.0/company/{company_id}/file/validation/{id}/
Loading...
Response
Loading...
DEL

deletel validation job discount

Cancel validation job of a discount by its id.
Requires company/price_rules/write access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount.
Response
200
400
Success
CancelJobResponseSchema
success
boolean
Indicates if the job cancellation was successful.
Examples
Parameters
company_id:
90
id:
"6519669e7fc0cd03ce111ab9"
DEL
/service/platform/discount/v1.0/company/{company_id}/file/validation/{id}/
Loading...
Response
Loading...
GET

List discount download job

Retrieve a discount download job by its id.
Requires company/price_rules/read access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount.
Response
200
400
Success
FileJobResponseSchema
stage
string
Current stage of the file job.
total
integer
Total number of items processed.
failed
integer
Number of items that failed processing.
company_id
integer
Identifier for the company.
body
object (FileJobBody)
FileJobBody
name
string
The name of the job.
company_id
integer
Unique identifier for the company.
is_active
boolean
Indicates if the job is active.
app_ids
array of string
List of application identifiers.
job_type
string
Type of job being processed.
Enum
discount_type
string
Type of discount applied.
Enum
discount_level
string
Level at which the discount is applied.
value
integer
Value of the discount.
file_path
string
Path to the discount file associated with the job.
brand_ids
array of integer
List of brand identifiers.
store_ids
array of integer
List of store identifiers.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
validity
object (ValidityObject)
ValidityObject
start
string
| date-time
The start date and time of the discount period.
end
string
| date-time
The end date and time of the discount period.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
modified_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
meta
object
Additional metadata for the job.
type
string
Type of file job.
Enum
file_type
string
Type of file being processed.
Enum
_id
string
A unique identifier to distinguish and identify a job.
file_path
string
Path to the disocunt file.
progress
integer
Progress of the file job.
extension_ids
array of string
List of extension identifiers.
zone_ids
array of string
List of zone identifiers.
created_on
string
| date-time
Timestamp when the job was created.
modified_on
string
| date-time
Timestamp when the job was last modified.
created_by
object (UserDetails)
UserDetails
username
string
Username of the user.
user_id
string
Unique identifier for the user.
Examples
Parameters
company_id:
90
id:
"651b00ef29aedf98f98a8cbd"
GET
/service/platform/discount/v1.0/company/{company_id}/file/download/{id}/
Loading...
Response
Loading...
DEL

delete discount download job

Cancel a discount download job by its id.
Requires company/price_rules/write access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount
Response
200
400
Success
CancelJobResponseSchema
success
boolean
Indicates if the job cancellation was successful.
Examples
Parameters
company_id:
1
id:
"651b00ef29aedf98f98a8cbd"
DEL
/service/platform/discount/v1.0/company/{company_id}/file/download/{id}/
Loading...
Response
Loading...

Discount Items

The Discount items focuses on managing discounts specifically for individual products or services within a business. A Discount item, within this context, refers to a specific product or service that is eligible for a discount or promotional offer. Discount items can effortlessly manage discounts for specific products or services using the update or insert functionality provided. Discount can be used for new discount items or update existing ones with ease. "Discount items" resource to tailor discounts to specific products or services, enhancing promotional strategies and customer engagement.

Operations
POST
/service/platform/discount/v1.0/company/{company_id}/job/{id}/items/
# Upsert discount items
POST

Upsert discount items

Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process.
Requires company/price_rules/write access scope.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller
id
string
Required
Unique identifier for the discount.
Request body
company_id
integer
Required
Uinque Identifier for the company.
items
array of object (DiscountItems)
Required
List of discount items.
Array of DiscountItems
item_code
string
Unique code for the item.
brand_name
string
Name of the brand.
seller_identifier
string
Unique Identifier for the size.
discount_type
string
Required
Type of discount applied.
Enum
value
number
Required
Value of the discount.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Required
Determines whether the discount countdown is visible or not.
hours
number
The time in hours before the discount ends when the countdown timer should start.
minutes
number
The time in minutes before the discount ends when the countdown timer should start.
Response
200
400
Success
Properties
success
boolean
Examples
Parameters
company_id:
90
id:
"603f54c3f6f7fd000925925b"
body:
body
POST
/service/platform/discount/v1.0/company/{company_id}/job/{id}/items/
Loading...
Response
Loading...