Parameters for creating a new add-on deal
The response containing the created add-on deal ID
Note: A maximum of 1000 add-on deals can be created. The start time must be 1 hour later than current time. The end time must be 1 hour later than start time.
Add main items to an existing add-on deal activity
Parameters for adding main items to an add-on deal
The response containing the list of added main items
Main items are the products that customers must purchase to be eligible for the add-on deal.
Add sub items (discounted or gift items) to an existing add-on deal activity
Parameters for adding sub items to an add-on deal
The response containing any failed sub items
Sub items are the products offered at a discount or as gifts when customers purchase main items. The response includes a list of items that failed to be added with error details.
Delete an existing add-on deal activity
Parameters for deleting an add-on deal
The response containing the deleted add-on deal ID
Note: Can only delete upcoming add-on deals that haven't started yet. Will return an error if attempting to delete an add-on deal that has already started.
Delete main items from an existing add-on deal activity
Parameters for deleting main items from an add-on deal
The response containing any failed item deletions
The response includes:
Delete sub items from an existing add-on deal activity
Parameters for deleting sub items from an add-on deal
The response containing any failed sub item deletions
The response includes a list of sub items that failed to be deleted with error details. Note: At least one sub item should remain in the add-on deal.
End an ongoing add-on deal activity immediately
Parameters for ending an add-on deal
The response containing the ended add-on deal ID
Note: Can only end add-on deals that are currently ongoing/active. Will return an error if attempting to end an upcoming or expired add-on deal.
Get detailed information about an add-on deal activity
Parameters for getting add-on deal details
The response containing comprehensive add-on deal information
The response includes:
Get a list of add-on deal activities with pagination
Parameters for retrieving add-on deal list
Parameters for getting add-on deal list
Optionalpage_no?: numberPage number (1-1000, default: 1)
Optionalpage_size?: numberNumber of items per page (1-100, default: 100)
Filter by promotion status (default: all)
The response containing a paginated list of add-on deals
The response includes:
Get main items in an add-on deal activity
Parameters for getting main items
The response containing the list of main items
Main items are the products that customers must purchase to be eligible for the add-on deal.
Get sub items (discounted or gift items) in an add-on deal activity
Parameters for getting sub items
The response containing the list of sub items
Sub items are the products offered at a discount or as gifts when customers purchase main items.
Update an existing add-on deal activity
Parameters for updating an add-on deal
The response containing the updated add-on deal information
Note: For ongoing add-on deals, update capabilities may be limited. Only certain fields can be modified depending on the add-on deal status. The start time of upcoming add-on deals cannot be shortened. Promotion end time can only be changed to an earlier timing.
Update main items in an existing add-on deal activity
Parameters for updating main items
The response containing the updated main items
Main items are the products that customers must purchase to be eligible for the add-on deal.
Update sub items in an existing add-on deal activity
Parameters for updating sub items
The response containing any failed sub item updates
Sub items are the products offered at a discount or as gifts when customers purchase main items. The response includes a list of sub items that failed to be updated with error details.
Create a new add-on deal activity