Coupon management

The POS can call the Lobyco Promotions services to retrieve, or directly apply, relevant standard and personalized offers. Active member coupons can be retrieved by the POS via Coupon APIs, or Lobyco can get the customer basket via Discount APIs and return the applied offers and calculated discounts.

Offer flow via Promotion API

1. Offer import is possible from external systems, in case there is another system that can generate offers or allocate coupons.
   • Bulk import via POST /promotion/v2/bulk/campaigns - send a flat array of offers
   • Single import via POST /promotion/v2/campaigns - create a single offer

2. Creation directly in the Lobyco Admin Tool where an end user (e.g. marketeer) adds the necessary content regarding discount rules, thresholds, App presentation, and possible segmentation.

Assign coupons to members via Coupon API

• Assign a coupon from an already existing offer to a member via POST /promotion/v2/coupons/assign

• Assign multiple coupons for a single offer to multiple members in two ways
  • Attach a segmentation file through the Admin Tool
  • Populate audienceId in Offer model

POS integration - POS decides what coupons to apply via Coupon API

In this integration method, the POS receives all the available coupons for the user and their discount definition and it decides what coupons should be applied.

1. Get the list of available coupons GET coupon/api/v1/customers/{customerId}/coupons with includeOfferData = true, to include discount definitions

2. POS determines which coupons should be used

3. POST /coupon/api/v1/customers/{customerId}/coupons/reserve - prevents using the same coupons on a different POS or different channels (e.g. e-commerce) at the same time

4. POST /coupon/api/v1/customers/{customerId}/coupons/redeem - confirm that the purchase was finished and coupons were used (or based on transaction logs that are sent to Lobyco system, if that is the preferred integration)

5. POST /coupon/api/v1/customers/{customerId}/coupons/cancel-reservation - notify that the purchase was canceled and coupons should be available again on other POSes

POS integration - Lobyco services decide what coupons to apply via Discount API

In this integration approach, Lobyco receives the user basket, evaluates the products, and applies the coupons based on the rules and basket content. Lobyco can return to the POS the coupons to be applied and their definition, or it can return also the price calculation and final price.

1. Get the list of available coupons GET /coupon/api/v1/customers/{customerId}/coupons with includeOfferData = false

2. POST /pos-discount/v1/discounted-baskets passes coupons from step 1 in the coupons field

3. POST /coupon/api/v1/customers/{customerId}/coupons/redeem - confirms that the purchase was finished and coupons were used (or based on transaction logs, if that is preferred)

4. POST /coupon/api/v1/customers/{customerId}/coupons/cancel-reservation - to notify that purchase was canceled and coupons should be available again on other POSes

Audiences

Offers, coupons and other activities (like games, continuity, etc.) can be targeted to specific users by defining list of users in Audience Service and use them across these activities. The member identification (audience creation) can be done in the Lobyco Segmentation, a dedicated Admin Tool to segment users based on various criteria, or can be imported in Lobyco via Audience API.

Audience creation from CSV files via Audience API

1. POST /audience-dataimport/v1/import with passing CSV files with member IDs in dataURIs field to schedule an import job

2. GET /audience-dataimport/v1/import/{executionId}/status to check import status

Audience import from the customer's system via Audience API

1. POST /audience/v1/audiences - generate the header for a new audience (name, description, etc.)

2. PATCH /v1/audiences/{audienceId}/customers - add or remove members to audience