Marketing

🔒

Requires price_rules or gift_cards access scope.

The Marketing provide developers with powerful tools to create, manage, and monitor marketing campaigns and promotional activities within stores. These APIs include functionality for discounts, gift cards, and coupons, enabling stores to enhance customer engagement and boost sales.

Domain Model Diagram

Discounts

The Discount APIs allow developers to create and manage various promotional discounts within the store, including price rules, discount codes, flash sales, and more. These APIs are designed to help merchants effectively execute promotional campaigns.

Price Rule: Define the rules for discounts, including value, type, and applicable conditions.

• Discount Code: Generate unique discount codes tied to price rules for customer redemption.
• Flash Sales: Generate time-limited sales tied to price rules with specific conditions for customer engagement.
• Rebate Discount: A specific discount or cashback is applied once certain conditions are met, which is tied to price rules.
• Coupon: The Coupon APIs provide functionality to manage reusable or single-use coupons, often tied to marketing campaigns.

Sales Pop: Real-time floating notifications showcasing recent customer activity.

Popups: Prominent advertisements or announcements displayed as overlays, used for promotions or capturing user information.

Gift Cards

The Gift Card APIs enable merchants to create and manage digital gift cards, providing customers with flexible payment options.

• Create Gift Card: Issue new gift cards for customers.
• Update Gift Card: Modify the balance or details of an existing gift card.
• Disable Gift Card: Deactivate gift cards that are no longer valid.

Notes:

• All date and time parameters must follow ISO-8601 format and be in UTC.
• APIs are scoped to specific stores using their unique identifiers.