--- title: Introduction slug: api-documentation/efWl-introduction createdAt: 2026-11-05T10:20:00.876Z --- ## 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](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1%7BcouponId%7D~1%7BtimeZoneOffset%7D~1check/get): 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](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1%7BpromotionId%7D~1activate/post): This endpoint allows the administrator to activate an existing promotion. - [Apply Promotions](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1apply/post): This endpoint allows the administrator to view promotions applied to a particular consumer. - [Archive Promotion](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1%7BpromotionId%7D~1archive/post): This endpoint allows the administrator to archive a specific promotion. - [Create Promotion](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion/post): This endpoint allows the administrator to create a promotion. - [Create Form-Cart Meta data](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1cart~1metadata/get): 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](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon/post): This endpoint allows the administrator to create a coupon to determine how a promotion may be applied on the cart. - [Deactivate Promotion](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1%7BpromotionId%7D~1deactivate/post): This endpoint allows the administrator to deactivate a promotion. - [Delete Failed Coupons by Batch](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotions~1coupon~1files~1not-imported~1%7BbatchId%7D/delete): This endpoint allows the administrator to delete all the coupons that failed to import for a given batch. - [Get Active Promotions](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list~1active/get): This endpoint returns a list of all the active promotions by tenant. - [Get All Template Labels](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list~1active/get): The endpoint returns all the promotion template labels defined in a system by a tenant. - [Get Price Adjustments](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list~1active/get): This endpoint returns the price adjustment required once a promotion has been applied. - [Get Promotions by Cart](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1applied~1carts/get): This endpoint allows the administrator to return promotions that have been applied; linked to the relevant cart(s). - [Get Promotions by Consumer](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1applied~1customer~1%7BcustomerId%7D/get): This endpoint allows the administrator to view promotions applied to a particular consumer. - [Get Promotion by ID](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list~1active/get): This endpoint returns the details associated with a promotion against a specific ID. - [Get Promotions by ID](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list/get): This endpoint returns promotions based on an array of ids. - [Get Promotion Template by IDs](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list~1active/get): This endpoint returns the template(s) for a promotion based on the provided ID(s). - [Get Count of Coupons not Imported](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1files~1not-imported~1info/get): 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](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1%7Bid%7D/get): This endpoint gets the coupons based on an the ID provided. - [Get Failed Coupons by Batch](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1files~1not-imported~1%7BbatchId%7D~1%7Btake%7D~1%7Bdrop%7D/get): This endpoint returns all the coupons that failed to import for a given batch. - [Get Count of Items in Processing](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1files~1processing~1info/get): This endpoint returns the number of entries in processing for each batch. - [Revert Applied Promotions](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1list~1active/get): This endpoint allows the administrator to revert an applied promotions associated with a particular cart. - [Search Coupons](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1search/post): This endpoint returns a paginated list of coupons that can be filtered by promotion ID and coupon ID. - [Update Coupon](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1v1~1promotion~1coupon/put): This endpoint allows the administrator to update an existing coupon. - [Update Promotion](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion/put): This endpoint allows administrators to update the details of an existing promotion. - [Upload Coupons](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1coupon~1files~1\:promotionId~1upload/post): This endpoint allows the administrator to upload coupons and triggers the import process. ### Shipping Method Search Integration API - [Reindex Promotions](https://apidocs.upstartcommerce.com/docs/api-docs/promotion.yaml/paths/~1promotion~1search~1reindex/post): This endpoint allows the administrators to reindex promotion search data.