Introduction
3 min
Overview
These APIs allow tenant management of promotions and their usage by consumers.
In this Section
Promotion Consumer APIs
These APIs manage the consumer's usage of a promotional code.
- Check Coupon Availability: This endpoint allows for the availability of a discount coupon to be verified before cart processing.
Promotion Management APIs
These APIs allow the administrator to manage the promotions and the associated settings.
- Activate Promotion: This endpoint allows the administrator to activate an existing promotion.
- Apply Promotions: This endpoint allows the administrator to view promotions applied to a particular consumer.
- Archive Promotion: This endpoint allows the administrator to archive a specific promotion.
- Create Promotion: This endpoint allows the administrator to create a promotion.
- Create Form-Cart Meta data: This endpoint returns the meta data of cart's applied promotion for the front-end form creation tool set.
- Create Form-Item Meta data: This endpoint returns the meta data of item for the front-end form-creation tool set.
- Create Coupon: This endpoint allows the administrator to create a coupon to determine how a promotion may be applied on the cart.
- Deactivate Promotion: This endpoint allows the administrator to deactivate a promotion.
- Delete Failed Coupons by Batch: This endpoint allows the administrator to delete all the coupons that failed to import for a given batch.
- Get Active Promotions: This endpoint returns a list of all the active promotions by tenant.
- Get All Template Labels: The endpoint returns all the promotion template labels defined in a system by a tenant.
- Get Price Adjustments: This endpoint returns the price adjustment required once a promotion has been applied.
- Get Promotions by Cart: This endpoint allows the administrator to return promotions that have been applied; linked to the relevant cart(s).
- Get Promotions by Consumer: This endpoint allows the administrator to view promotions applied to a particular consumer.
- Get Promotion by ID: This endpoint returns the details associated with a promotion against a specific ID.
- Get Promotions by ID: This endpoint returns promotions based on an array of ids.
- Get Promotion Template by IDs: This endpoint returns the template(s) for a promotion based on the provided ID(s).
- Get Count of Coupons not Imported: This endpoint allows the administrator to review the number of entries that failed to import for each batch (providing an empty batch id array returns all batches).
- Get Coupon by ID: This endpoint gets the coupons based on an the ID provided.
- Get Failed Coupons by Batch: This endpoint returns all the coupons that failed to import for a given batch.
- Get Count of Items in Processing: This endpoint returns the number of entries in processing for each batch.
- Revert Applied Promotions: This endpoint allows the administrator to revert an applied promotions associated with a particular cart.
- Search Coupons: This endpoint returns a paginated list of coupons that can be filtered by promotion ID and coupon ID.
- Update Coupon: This endpoint allows the administrator to update an existing coupon.
- Update Promotion: This endpoint allows administrators to update the details of an existing promotion.
- Upload Coupons: This endpoint allows the administrator to upload coupons and triggers the import process.
Shipping Method Search Integration API
- Reindex Promotions: This endpoint allows the administrators to reindex promotion search data.