# Lobyco Help center > Build loyalty on Lobyco — integration guides, API reference and business documentation. ## Docs - [How can we help?](https://help.lobyco.com/index.md): Set up Nexus, see what other teams have built, and find the detail when you need it. - [Integration](https://help.lobyco.com/integration/integration.md): How to connect your POS, app, website and data pipelines to Lobyco. - [Quick Start](https://help.lobyco.com/integration/quick-start.md): Platform concepts, authentication, admin portal access and the accounts you need before integrating. - [Getting Started with Lobyco](https://help.lobyco.com/integration/quick-start/getting-started-with-lobyco.md): Integration concepts, the modular platform, and the three stages of a customer purchase: identify, verify, settle. - [Azure costs](https://help.lobyco.com/integration/quick-start/azure-costs.md): How Azure hosting costs split between dedicated client environments and shared platform components. - [Set up Apple & Google developer accounts](https://help.lobyco.com/integration/quick-start/set-up-apple-and-google-developer-accounts.md): Enroll with Apple and Google, declare trader status, and invite the Lobyco team so we can publish your app. - [API integration](https://help.lobyco.com/integration/quick-start/api-integration.md): Whitelist the Azure Front Door IP ranges so your firewall does not block Lobyco API traffic. - [API Authentication](https://help.lobyco.com/integration/quick-start/api-authentication.md): OAuth 2.0 client credentials and API keys, and how to choose between the two tenant setups. - [Multi-tenant authentication using client credentials flow​](https://help.lobyco.com/integration/quick-start/api-authentication/multi-tenant-authentication-using-client-credentials-flow.md): Import the Lobyco multi-tenant app into your own Azure AD so you keep full control of the secrets. - [Lobyco tenant authentication using client credentials flow​](https://help.lobyco.com/integration/quick-start/api-authentication/lobyco-tenant-authentication-using-client-credentials-flow.md): Lobyco creates the Azure app registration and shares credentials with you. Best if you do not run your own Azure AD. - [Access to Lobyco Admin Portal](https://help.lobyco.com/integration/quick-start/access-to-lobyco-admin-portal.md): Connect your Azure AD, grant admin consent, and assign the admin roles that unlock each portal section. - [Admin portal chain and store level access](https://help.lobyco.com/integration/quick-start/admin-portal-chain-and-store-level-access.md): Scope admin portal permissions to a chain or to individual stores. - [Postman collection](https://help.lobyco.com/integration/quick-start/admin-portal-chain-and-store-level-access/postman-collection.md): Postman collection for exercising chain and store level access. - [Troubleshooting: Verifying Claims in the Auth Token](https://help.lobyco.com/integration/quick-start/admin-portal-chain-and-store-level-access/troubleshooting-verifying-claims-in-the-auth-token.md): Inspect the claims in an issued auth token when access is not behaving as expected. - [Mobile app authentication](https://help.lobyco.com/integration/quick-start/mobile-app-authentication.md): How the Lobyco white-label mobile app authenticates customers. - [Setting up Lobyco IDP for your website(s)](https://help.lobyco.com/integration/quick-start/setting-up-lobyco-idp-for-your-website-s.md): Use Lobyco as the identity provider for your own websites. - [POS (Point of Sale) Integrations](https://help.lobyco.com/integration/pos-point-of-sale-integrations.md): Connect a POS or e-commerce checkout to Lobyco across the whole purchase lifecycle. - [Setting up a payment location](https://help.lobyco.com/integration/pos-point-of-sale-integrations/setting-up-a-payment-location.md): Register each POS or self-checkout as a payment location. Prerequisite for check-in and payments. - [Registering at POS](https://help.lobyco.com/integration/pos-point-of-sale-integrations/registering-at-pos.md): Customer check-in at the POS, in both directions: scanning a sticker and the POS scanning the app. - [Direct Coupon Service Integration](https://help.lobyco.com/integration/pos-point-of-sale-integrations/direct-coupon-service-integration.md): The POS retrieves the customer's coupons and decides which ones to apply. - [Discount Integration](https://help.lobyco.com/integration/pos-point-of-sale-integrations/discount-integration.md): Send the basket to Lobyco and let Lobyco evaluate offers and return calculated discounts. - [Coupon Redemption at POS](https://help.lobyco.com/integration/pos-point-of-sale-integrations/coupon-redemption-at-pos.md): Confirm which coupons were actually used so they cannot be redeemed twice. - [Payments](https://help.lobyco.com/integration/pos-point-of-sale-integrations/payments.md): Capture funds through the Payment Coordinator: bonus, card, Apple and Google Pay. - [Transaction Data](https://help.lobyco.com/integration/pos-point-of-sale-integrations/transaction-data.md): Send the finalized sale to the Purchase API. This is the call that records the transaction. - [Breaking Changes](https://help.lobyco.com/integration/breaking-changes.md): Deprecation notices for Lobyco APIs, and the policy that governs how much notice you get. - [Lobyco API Breaking Change Policy](https://help.lobyco.com/integration/breaking-changes/lobyco-api-breaking-change-policy.md): What Lobyco treats as a breaking change, and the notice period you can rely on. - [August 20, 2025 - API deprecation notice – Promotion platform](https://help.lobyco.com/integration/breaking-changes/august-20-2025-api-deprecation-notice-promotion-platform.md): Promotion platform endpoints rotating to newer versions. Deprecation deadline 1 March 2026. - [Other Integrations](https://help.lobyco.com/integration/other-integrations.md): Integrations beyond the POS — master data, bonus, offers, games, segmentation and app content. - [Retail Master Data](https://help.lobyco.com/integration/other-integrations/retail-master-data.md): Get product and article master data into Lobyco. - [Importing product and article information](https://help.lobyco.com/integration/other-integrations/retail-master-data/importing-product-and-article-information.md): Importing product and article information. - [Importing store and chain data](https://help.lobyco.com/integration/other-integrations/retail-master-data/importing-store-and-chain-data.md): Chains, stores, opening hours and adjustments - import modes, validation rules and the typical flow. - [Post Coupons From an External Promotion Provider](https://help.lobyco.com/integration/other-integrations/post-coupons-from-an-external-promotion-provider.md): Push coupons into Lobyco from a third-party promotion provider. - [Bonus Integration](https://help.lobyco.com/integration/other-integrations/bonus-integration.md): Integrating Lobyco bonus. - [Audience - Lobyco Segmentation](https://help.lobyco.com/integration/other-integrations/audience-lobyco-segmentation.md): Lobyco segmentation and customer audiences. - [Reporting by Lobyco](https://help.lobyco.com/integration/other-integrations/reporting-by-lobyco.md): Reporting delivered by Lobyco. - [Games Integration](https://help.lobyco.com/integration/other-integrations/games-integration.md): Integrating Lobyco games. - [Web Content in Mobile App](https://help.lobyco.com/integration/other-integrations/web-content-in-mobile-app.md): Embedding your own web content inside the Lobyco mobile app. - [1:1 Personal Offers management](https://help.lobyco.com/integration/other-integrations/1-1-personal-offers-management.md): Managing 1:1 personal offers. - [Mobile or Web integration](https://help.lobyco.com/integration/other-integrations/mobile-or-web-integration.md): Building your own mobile or web front end against the Lobyco APIs. - [Offers](https://help.lobyco.com/integration/other-integrations/mobile-or-web-integration/offers.md): Surfacing offers in your own mobile or web front end. - [Challenges](https://help.lobyco.com/integration/other-integrations/mobile-or-web-integration/challenges.md): Surfacing challenges in your own mobile or web front end. - [Bonus](https://help.lobyco.com/integration/other-integrations/mobile-or-web-integration/bonus.md): Surfacing bonus in your own mobile or web front end. - [Partner Benefits Feeds](https://help.lobyco.com/integration/other-integrations/partner-benefits-feeds.md): Partner benefits feeds. - [Digital Receipts](https://help.lobyco.com/integration/other-integrations/digital-receipts.md): Show customers their receipts — how receipts become available and how to retrieve them. - [Savings History](https://help.lobyco.com/integration/other-integrations/savings-history.md): Show customers how much they saved — reading the aggregated savings endpoints from web or app. - [Loyalty Membership](https://help.lobyco.com/integration/other-integrations/loyalty-membership.md): Loyalty membership integration. - [Consent](https://help.lobyco.com/integration/other-integrations/loyalty-membership/consent.md): Consent types, versioning and how acceptance is tracked across customer and device scope. - [Communication](https://help.lobyco.com/integration/other-integrations/communication.md): Feed, push, prompts, banners and customer feedback — the customer-facing messaging surfaces. - [Banner](https://help.lobyco.com/integration/other-integrations/communication/banner.md): Banners shown in app and web surfaces - types, targeting, scheduling and navigation. - [Customer Feedback](https://help.lobyco.com/integration/other-integrations/communication/customer-feedback.md): Collecting post-purchase feedback against a receipt, and reading the reports. - [Feed](https://help.lobyco.com/integration/other-integrations/communication/feed.md): The in-app content feed - content types, targeting, scheduling and navigation. - [Prompt](https://help.lobyco.com/integration/other-integrations/communication/prompt.md): In-app prompts - what they contain, the two ways to integrate them, and how interactions are recorded. - [Push](https://help.lobyco.com/integration/other-integrations/communication/push.md): Sending mobile notifications and managing the device subscriptions that receive them. - [External Integrations](https://help.lobyco.com/integration/external-integrations.md): Connect external systems to Lobyco: inbound and outbound orchestration connectors, and the event payloads they carry. - [InboundAPI integration](https://help.lobyco.com/integration/external-integrations/inboundapi-integration.md): Let an external system start an orchestration flow for a specific customer in real time. - [OutboundAPI connection](https://help.lobyco.com/integration/external-integrations/outboundapi-connection.md): Have an orchestration flow call an HTTP endpoint in your system or a third-party platform when a customer event occurs. - [Events](https://help.lobyco.com/integration/external-integrations/events.md): JSON Schemas for the event payloads Lobyco publishes. - [Offer Events](https://help.lobyco.com/integration/external-integrations/events/offer-events.md): JSON Schemas for the offer lifecycle events. - [Coupon Events](https://help.lobyco.com/integration/external-integrations/events/coupon-events.md): JSON Schemas for the coupon lifecycle events. - [Challenge Events](https://help.lobyco.com/integration/external-integrations/events/challenge-events.md): JSON Schemas for the challenge definition lifecycle events. - [Card Events](https://help.lobyco.com/integration/external-integrations/events/card-events.md): JSON Schemas for a customer's challenge card - assigned, activated, progress and completion. - [Purchase Events](https://help.lobyco.com/integration/external-integrations/events/purchase-events.md): JSON Schema for the purchase loaded event. - [Data Platform](https://help.lobyco.com/integration/data-platform.md): Secure analytical access to Lobyco data through Delta Sharing and curated data packages. - [Delta Sharing](https://help.lobyco.com/integration/data-platform/delta-sharing.md): Connect to the Lobyco Delta Sharing endpoint and read the shared tables. - [Data Packages](https://help.lobyco.com/integration/data-platform/data-packages.md): What the data packages are for, the Essential and Premium refresh tiers, and the do's and don'ts of using them. - [Lobyco Nexus - nex_*](https://help.lobyco.com/integration/data-platform/data-packages/lobyco-nexus-nex_.md): Tables in the Lobyco Nexus data package (nex_*). - [Communication - com_*](https://help.lobyco.com/integration/data-platform/data-packages/communication-com_.md): Tables in the Communication data package (com_*). - [Customer - cus_*](https://help.lobyco.com/integration/data-platform/data-packages/customer-cus_.md): Tables in the Customer data package (cus_*). - [Loyalty and Promotion - loy_*](https://help.lobyco.com/integration/data-platform/data-packages/loyalty-and-promotion-loy_.md): Tables in the Loyalty and Promotion data package (loy_*). - [Mobile App - mob_*](https://help.lobyco.com/integration/data-platform/data-packages/mobile-app-mob_.md): Tables in the Mobile App data package (mob_*). - [Return of Retailers - ret_*](https://help.lobyco.com/integration/data-platform/data-packages/return-of-retailers-ret_.md): Retailer-provided master and transactional data: products, hierarchies, stores, chains and purchases. Premium service in both tiers. - [Customer Feedback - cfe_*](https://help.lobyco.com/integration/data-platform/data-packages/customer-feedback-cfe_.md): Tables in the Customer Feedback data package (cfe_*). - [API Reference](https://help.lobyco.com/api-reference/api-reference.md): Every Lobyco API, grouped by service, with request and response schemas. - [Audience](https://help.lobyco.com/api-reference/audience.md): Audiences and the customers that belong to them. - [Audiences](https://help.lobyco.com/api-reference/audience/audiences.md): List and inspect audience definitions. - [Returns customers from audience by id](https://help.lobyco.com/api-reference/audience/audiences/get-v1-audiences-audienceid-customers.md) - [Returns customers that belong to at least one of passed audiences](https://help.lobyco.com/api-reference/audience/audiences/get-v1-audiences-customers.md) - [Create audience with customers](https://help.lobyco.com/api-reference/audience/audiences/post-v1-audiences.md) - [Creates an audience snapshot based on the provided audience ID. An audience snapshot is a captured state of the audience customers.](https://help.lobyco.com/api-reference/audience/audiences/post-v1-audiences-audienceid-snapshot.md) - [Update audience and update audience customers](https://help.lobyco.com/api-reference/audience/audiences/put-v1-audiences-audienceid.md) - [Update audience customers](https://help.lobyco.com/api-reference/audience/audiences/patch-v1-audiences-audienceid-customers.md) - [Customers](https://help.lobyco.com/api-reference/audience/customers.md): The audiences a customer belongs to. - [Returns all audiences to which current customer belongs](https://help.lobyco.com/api-reference/audience/customers/get-v1-customers-customerid-audiences.md) - [CSV Import](https://help.lobyco.com/api-reference/audience/csv-import.md): Upload CSV files and import their customers into an audience. - [Post v1 upload](https://help.lobyco.com/api-reference/audience/csv-import/post-v1-upload.md) - [Post v1 import](https://help.lobyco.com/api-reference/audience/csv-import/post-v1-import.md) - [Put v1 import](https://help.lobyco.com/api-reference/audience/csv-import/put-v1-import.md) - [Get v1 import executionid status](https://help.lobyco.com/api-reference/audience/csv-import/get-v1-import-executionid-status.md) - [Bonus](https://help.lobyco.com/api-reference/bonus.md): Bonus accounting and bonus calculation endpoints. - [Bonus Accounting](https://help.lobyco.com/api-reference/bonus/bonus-accounting.md): Bonus balances, accruals and adjustments on the customer account. - [Get account balances](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-accounts-accountid-balancesbytransactiontype.md): Get account balances grouped by the type of transaction - [Get account statements](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-accounts-accountid-detailed-statements.md): Get detailed statements of an account based on account Id. The sort of statements is done in descending order based on the creation date. The statements includes running balance and all partitions. - [Get account details](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-accounts-externalid.md): Gets account details by id. Can include balance calculation in response. - [Get account statements](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-accounts-externalid-statements.md): Get account's statements in descending order using the account's externalId - [Create account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-accounts.md): Create a new account using an external unique identifier - [Attach members to account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-accounts-accountid-members.md): Attach members to an existing account - [Update account details](https://help.lobyco.com/api-reference/bonus/bonus-accounting/patch-v1-accounts-accountid.md): Partially updates the account details. If new account property value is not specified, existing value will be used. - [Get member's accounts](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-members-memberid-accounts.md): Get member's accounts based on member id. Can include member's balance in the response. - [Get member's account balance](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-members-memberid-balance.md): Get member's active account balance - [Get statements of member's account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-members-memberid-statements.md): Get statements of member's active account - [Get statistics of member's account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-members-memberid-statistics.md): Get statistics of the member's active account - [Create new member account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-accounts.md): Create a new account attached to a member - [Activate account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-activate.md): Activate the account of a member. In case the member has multiple inactive accounts, then the latest one created is activated. - [Load bonus](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-bonuses.md): The bonus is loaded to member's active account. - [Toggle IsAllowedToSpend](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-changeallowancetospend.md): Changes IsAllowedToSpend flag of account. - [Deactivate active account](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-deactivate.md): Deactivate the account with the specified id - [Create a payment transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-payments.md): Create a payment transaction using the active account of the member. The transaction created is in waiting state, in order to complete the transaction use capture or cancel endpoints. The operation is idempotent. - [Create a transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-members-memberid-transactions.md): The transaction can be captured instantly if 'InstantCapture' parameter is set to true. Accrues the specified amount on the member's active account. The specified amount can be negative, then the amount will be deducted from the member's account. The operation is idempotent. Attention:… - [Get transactions](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-transactions.md): Get transactions by operationId - [Get transaction details](https://help.lobyco.com/api-reference/bonus/bonus-accounting/get-v1-transactions-id.md): Get transaction details by transaction id - [Create a transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-transactions.md): The transaction can be captured instantly if 'InstantCapture' parameter is set to true. Accrues the specified amount on the member's active account. The specified amount can be negative, then the amount will be deducted from the member's account. The operation is idempotent. Attention:… - [Cancel waiting transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-transactions-id-cancel.md): Cancels a waiting transaction by id. - [Capture waiting transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-transactions-id-capture.md): Captures waiting transaction by id. - [Refund transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-transactions-id-refund.md): Refund a successful transaction. Current implementation allows only Payment transactions to be refunded. - [Cancel transaction V2](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v2-transactions-id-cancel.md): Cancel the specified amount from the reserved amount of the transaction. In case the amount is not specified, the full reserved amount of the transaction is cancelled. The operation is idempotent. - [Capture waiting transaction V2](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v2-transactions-id-capture.md): Captures the specified amount from the reserved amount of the transaction. In case the amount is not specified, the full reserved amount of the transaction is captured. The operation is idempotent. - [Refund transaction V2](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v2-transactions-id-refund.md): Refunds the specified amount from the captured amount of a transaction. In case the amount is not specified, the full captured amount of the transaction is refunded. The operation is idempotent and creates a new transaction with the refunded amount. - [Partially update a transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/patch-v1-transactions-id.md): Currently only update of metadata is supported. The values from request will replace the values from transaction. - [Create a payment transaction](https://help.lobyco.com/api-reference/bonus/bonus-accounting/post-v1-payments.md): The transaction can be captured instantly if 'InstantCapture' parameter is set to true. The operation is idempotent. - [Bonus Calculation](https://help.lobyco.com/api-reference/bonus/bonus-calculation.md): How bonus is calculated from purchases and campaigns. - [Upload product filter](https://help.lobyco.com/api-reference/bonus/bonus-calculation/post-v1-campaigns-id-files-filetype.md): Uploads a file for the specified bonus campaign and updates the campaign's associated file reference based on the specified CampaignFileType. Supported file types vary depending on the BonusType of the campaign. Upload will fail if the selected fileType is not compatible with the campaign's bonus t… - [Communication](https://help.lobyco.com/api-reference/communication.md): Banner, feed, prompt, push and customer feedback endpoints. - [Banner](https://help.lobyco.com/api-reference/communication/banner.md): Banners shown in app and web surfaces. - [Get available banners](https://help.lobyco.com/api-reference/communication/banner/get-v1-banners.md) - [Get available banners.](https://help.lobyco.com/api-reference/communication/banner/get-v2-banners.md): This endpoint returns banners associated with the provided memberId. Filtering options can be applied to control which banners are retrieved. - [Customer Feedback](https://help.lobyco.com/api-reference/communication/customer-feedback.md): Collect and read customer feedback. - [Get feedback by receipt unique identifier](https://help.lobyco.com/api-reference/communication/customer-feedback/get-v1-feedback.md): Retrieves a specific feedback entry by its receipt unique identifier. - [Get recent feedback](https://help.lobyco.com/api-reference/communication/customer-feedback/get-v1-feedback-recent.md): Retrieves recent feedback entries for a specific member within a specified duration. - [Get feedback state](https://help.lobyco.com/api-reference/communication/customer-feedback/get-v1-feedback-state.md): Retrieves the current state of a feedback entry by receipt unique identifier. - [Create feedback](https://help.lobyco.com/api-reference/communication/customer-feedback/post-v1-feedback.md): Creates a new customer feedback entry for a specific receipt and member. - [Update feedback](https://help.lobyco.com/api-reference/communication/customer-feedback/put-v1-feedback.md): Updates an existing customer feedback entry for a specific receipt and member. - [Complete feedback](https://help.lobyco.com/api-reference/communication/customer-feedback/patch-v1-feedback-complete.md): Marks a feedback entry as complete based on the receipt unique identifier. - [Delete feedback](https://help.lobyco.com/api-reference/communication/customer-feedback/delete-v1-feedback.md): Deletes an existing customer feedback entry. - [Get aggregate report](https://help.lobyco.com/api-reference/communication/customer-feedback/get-v1-feedback-aggregate-report.md): Generates an aggregated feedback report for a specified date range. - [Get daily report](https://help.lobyco.com/api-reference/communication/customer-feedback/get-v1-feedback-report.md): Generates a feedback report for a specified date range. - [Upload report](https://help.lobyco.com/api-reference/communication/customer-feedback/post-v1-feedback-report.md): Uploads a feedback report to blob storage. - [Get predefined options by chain](https://help.lobyco.com/api-reference/communication/customer-feedback/get-v1-feedback-options-chainid.md): Retrieves predefined feedback options and ratings for a specific chain. - [Feed](https://help.lobyco.com/api-reference/communication/feed.md): The in-app content feed. - [Get a content item](https://help.lobyco.com/api-reference/communication/feed/get-v1-content.md): Retrieves a detailed representation of a content item. The content item can be looked up either by its internal identifier (id) or by an external system identifier (externalId). At least one of the parameters must be provided. - [Get list of content items](https://help.lobyco.com/api-reference/communication/feed/get-v1-content-filter.md): Allows clients to query content items based on filters such as campaign name, status, publish/modified date ranges, and author. Supports pagination using limit and offset. - [Create content item](https://help.lobyco.com/api-reference/communication/feed/post-v1-content.md): Accepts a request body with the details of the content item to be created. - [Update content item](https://help.lobyco.com/api-reference/communication/feed/put-v1-content.md): Accepts a request body with the updated content item. - [Enable content item](https://help.lobyco.com/api-reference/communication/feed/patch-v1-content-id-enable.md) - [Delete content item](https://help.lobyco.com/api-reference/communication/feed/delete-v1-content.md): At least one of the parameters must be provided to identify the content item. - [Publish a content feed](https://help.lobyco.com/api-reference/communication/feed/patch-v1-feed-externalid-externalid-publish.md): The content item is identified using the externalId provided in the route. A content item is published or scheduled depending on the PublishDate of the content. - [Unpublish a content feed](https://help.lobyco.com/api-reference/communication/feed/patch-v1-feed-externalid-externalid-unpublish.md): The content item is identified using the externalId provided in the route. - [Prompt](https://help.lobyco.com/api-reference/communication/prompt.md): In-app prompts. - [Get URL to prompt web view.](https://help.lobyco.com/api-reference/communication/prompt/get-core-v1-interaction-available.md): Retrieves the URL for a prompt popup if there are available prompts for the specified member, optionally filtered by device type. - [Get available prompts.](https://help.lobyco.com/api-reference/communication/prompt/get-core-v1-interaction-available-details.md): Retrieves the list of available prompts for a specified member, optionally filtered by device type. - [Accept prompt.](https://help.lobyco.com/api-reference/communication/prompt/post-core-v1-interaction-id-accept.md): Accepts the specified prompt for a specific member. - [Decline or close prompt.](https://help.lobyco.com/api-reference/communication/prompt/post-core-v1-interaction-id-decline.md): Declines or Closes the specified prompt on behalf of a member. - [Upsert prompt](https://help.lobyco.com/api-reference/communication/prompt/post-s2s-v1-prompt.md): This endpoint accepts a request payload containing the prompt details. If the prompt already exists, it will be updated; otherwise, a new prompt will be created. - [Push](https://help.lobyco.com/api-reference/communication/push.md): Push notifications to customers. - [Get push notification](https://help.lobyco.com/api-reference/communication/push/get-v1-notification-externalid.md): This endpoint fetches the details of a push notification identified by the externalId. - [Create push notification.](https://help.lobyco.com/api-reference/communication/push/post-v1-notification.md): Accepts a request body containing all the necessary details for the push notification. - [Update push notification.](https://help.lobyco.com/api-reference/communication/push/put-v1-notification.md): Accepts a request body containing all the necessary details for the push notification. - [Delete push notification](https://help.lobyco.com/api-reference/communication/push/delete-v1-notification-externalid.md): This endpoint removes the specified push notification from the system using the provided externalId. Deletion is permanent and cannot be undone. - [Create notification](https://help.lobyco.com/api-reference/communication/push/post-v1-campaign-notifications-send.md) - [Create notification campaign](https://help.lobyco.com/api-reference/communication/push/post-v2-campaign-notifications-send.md) - [Subscribe device](https://help.lobyco.com/api-reference/communication/push/post-v1-customers-customerid-subscription.md): This endpoint associates the specified customer device, identified by customerId, to push notifications. - [Unsubscribes a device](https://help.lobyco.com/api-reference/communication/push/delete-v1-customers-customerid-subscription.md): This endpoint removes the association between a customer’s device and its active subscription. Once unsubscribed, the device identified by installationId will no longer receive notifications for the specified customer. - [Delta Sharing Protocol](https://help.lobyco.com/api-reference/delta-sharing-protocol.md): The Delta Sharing protocol endpoints — shares, schemas and tables. - [Shares](https://help.lobyco.com/api-reference/delta-sharing-protocol/shares.md): The Delta Sharing shares available to your credentials. - [List the shares accessible to the recipient](https://help.lobyco.com/api-reference/delta-sharing-protocol/shares/get-shares.md): Without any query parameters the request will return the first page of "shares" available to the authenticated recipient - [get the metadata of a share](https://help.lobyco.com/api-reference/delta-sharing-protocol/shares/get-shares-share.md) - [List the tables under all schemas in a share](https://help.lobyco.com/api-reference/delta-sharing-protocol/shares/get-shares-share-all-tables.md) - [List the schemas in a share](https://help.lobyco.com/api-reference/delta-sharing-protocol/shares/get-shares-share-schemas.md) - [Schemas](https://help.lobyco.com/api-reference/delta-sharing-protocol/schemas.md): The schemas within a Delta Sharing share. - [List the tables in a given share's schema](https://help.lobyco.com/api-reference/delta-sharing-protocol/schemas/get-shares-share-schemas-schema-tables.md) - [Tables](https://help.lobyco.com/api-reference/delta-sharing-protocol/tables.md): Delta Sharing table metadata and data files. - [Read Change Data Feed from a Table](https://help.lobyco.com/api-reference/delta-sharing-protocol/tables/get-shares-share-schemas-schema-tables-table-changes.md): This is the API for clients to read change data feed from a table. The API supports a start parameter and and an end parameter. The start/end parameter can either be a version or a timestamp. The start parameter must be provided. If the end parameter is not provided, the API will use the latest tabl… - [Query the metadata and schema of the given table](https://help.lobyco.com/api-reference/delta-sharing-protocol/tables/get-shares-share-schemas-schema-tables-table-metadata.md) - [Return the table version](https://help.lobyco.com/api-reference/delta-sharing-protocol/tables/get-shares-share-schemas-schema-tables-table-version.md): This is the API for clients to get a table version without any other extra information. The server usually can implement this API effectively. If a client caches information about a shared table locally, it can store the table version and use this cheap API to quickly check whether their cache is st… - [Query the table](https://help.lobyco.com/api-reference/delta-sharing-protocol/tables/post-shares-share-schemas-schema-tables-table-query.md) - [Digital Receipts](https://help.lobyco.com/api-reference/digital-receipts.md): Retrieve digital receipts for customer purchases, as JSON, rendered HTML or a barcode. - [Receipts](https://help.lobyco.com/api-reference/digital-receipts/receipts.md): List, fetch and render digital receipts. - [Get receipts.](https://help.lobyco.com/api-reference/digital-receipts/receipts/get-v1-receipts.md): This endpoint returns all available receipts associated with a specific member. Supports offset-based pagination (limit/offset) and cursor-based pagination (limit/cursor). Both modes cannot be used in the same request. - [Get receipt in HTML format.](https://help.lobyco.com/api-reference/digital-receipts/receipts/get-v1-receipts-receiptid.md): This endpoint returns a single receipt rendered as HTML. - [Get barcode.](https://help.lobyco.com/api-reference/digital-receipts/receipts/get-v1-receipts-receiptid-barcode.md): This endpoint generates and returns a barcode image encoding the specified receipt identifier. - [Data Import](https://help.lobyco.com/api-reference/data-import.md): Bulk data import endpoints. - [Jobs V1](https://help.lobyco.com/api-reference/data-import/jobs-v1.md): Create and manage bulk import jobs. - [Post v1 jobs](https://help.lobyco.com/api-reference/data-import/jobs-v1/post-v1-jobs.md): Creates a new import job. Returns a job ID that you'll use to upload the file and track progress. - [Post v1 jobs jobid batch](https://help.lobyco.com/api-reference/data-import/jobs-v1/post-v1-jobs-jobid-batch.md): Upload your data file for an existing job. Supports CSV, JSONL. - [Get v1 jobs jobid](https://help.lobyco.com/api-reference/data-import/jobs-v1/get-v1-jobs-jobid.md): Get the status of an import job. Returns how many records processed, succeeded, failed, and overall job state. - [Get v1 jobs jobid errors](https://help.lobyco.com/api-reference/data-import/jobs-v1/get-v1-jobs-jobid-errors.md): Returns detailed errors for records that failed validation. - [Delete v1 jobs jobid](https://help.lobyco.com/api-reference/data-import/jobs-v1/delete-v1-jobs-jobid.md): Delete a job and all its data (file, errors, history). Permanent - can't be undone. - [Jobs V2](https://help.lobyco.com/api-reference/data-import/jobs-v2.md): Current import job endpoint. - [Post v2 jobs](https://help.lobyco.com/api-reference/data-import/jobs-v2/post-v2-jobs.md): Imports file for a specific Entity type. Supports CSV and JSONL formats. - [Loyalty & Membership](https://help.lobyco.com/api-reference/loyalty-and-membership.md): Customer records and consent management. - [Members](https://help.lobyco.com/api-reference/loyalty-and-membership/members.md): Create, read and update customer records. - [Returns information about a specific member](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v1-members-memberid.md) - [Searches members by a specific property](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v1-members-search.md) - [Imports or updates members.](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-members-import.md): This endpoint will handle adding new members or updating existing members based on the provided data. - [Activates a member account](https://help.lobyco.com/api-reference/loyalty-and-membership/members/put-v1-members-memberid-activate.md) - [Deactivates a member account](https://help.lobyco.com/api-reference/loyalty-and-membership/members/put-v1-members-memberid-deactivate.md) - [Updates member properties.](https://help.lobyco.com/api-reference/loyalty-and-membership/members/patch-v1-members-memberid.md) - [Deletes a member and anonymizes their data](https://help.lobyco.com/api-reference/loyalty-and-membership/members/delete-v1-members-memberid.md) - [Finds loyalty cards by member ID and state](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v1-loyalty-cards.md): If the state is not specified, returns all cards for the member ID. - [Creates a new loyalty card](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-loyalty-cards.md) - [Deactivates all active loyalty cards for a member](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-loyalty-cards-memberid-deactivate.md) - [Imports or updates loyalty cards](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-loyalty-cards-import.md): This endpoint will handle adding new loyalty cards or updating existing ones based on the provided data. - [Updates loyalty card properties](https://help.lobyco.com/api-reference/loyalty-and-membership/members/put-v1-loyalty-cards-cardid.md) - [Returns both primary and related member links](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v1-linked-members-memberid.md) - [Creates a new link between primary and related member](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-linked-members.md) - [Imports multiple linked member relationships](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-linked-members-import.md) - [Removes link between members for the specified relationship type](https://help.lobyco.com/api-reference/loyalty-and-membership/members/delete-v1-linked-members.md) - [Lists all registered custom property definitions](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v1-custom-properties-definitions.md) - [Registers one or more custom property definitions](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-custom-properties-definitions.md) - [Removes a custom property definition. Blocked if any member values are associated with it.](https://help.lobyco.com/api-reference/loyalty-and-membership/members/delete-v1-custom-properties-definitions-name.md) - [Returns employee bonus information at a specific date and time](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v1-employee-bonuses-memberid.md): Returns NoContent (204) if no bonus information is found. Returns BadRequest (400) if the member is not active. - [Returns all employee bonus information by member ID](https://help.lobyco.com/api-reference/loyalty-and-membership/members/get-v2-employee-bonuses-memberid.md): Returns NoContent (204) if no bonus information is found for the member. - [Imports or updates employee bonuses compatible with data import service](https://help.lobyco.com/api-reference/loyalty-and-membership/members/post-v1-employee-bonuses-upsert.md): This endpoint will handle adding new employee bonuses or updating existing ones based on the provided data. - [Consent](https://help.lobyco.com/api-reference/loyalty-and-membership/consent.md): Record and query customer consents. - [Get single consent by id](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/get-v1-consents-id.md) - [Gets list of all consents for user.](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/get-v1-consents-all.md): Retrieves all consents regardless of expiration status. - [Gets latest available consent by key](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/get-v1-consents-latest.md): Consent is available if it's not expired. - [Gets list of available consents for user.](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/get-v1-consents-latest-all.md): Consent is available if it's not expired. - [Gets list of available consents for user by keys](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-consents-latest.md): Consent is available if it's not expired. - [Get consents items by query](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-consents-searches.md) - [Returns a list of all user consents. Can be filtered by Active flag.](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/get-v1-userconsents-all.md) - [Activates user consent](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-userconsents-activate.md) - [Activates member consents](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-userconsents-activate-bulk.md) - [Withdraws user consent even when it was not accepted before](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-userconsents-reject.md) - [Withdraws user consent](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-userconsents-withdraw.md): Withdraws user consent - [Withdraws member consents](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/post-v1-userconsents-withdraw-bulk.md) - [Updates the metadata of a user consent](https://help.lobyco.com/api-reference/loyalty-and-membership/consent/put-v1-userconsents-metadata.md) - [Payments](https://help.lobyco.com/api-reference/payments.md): The Payment Coordinator — customer check-in and payment authorization, capture, refund and cancellation. - [Payment Coordinator](https://help.lobyco.com/api-reference/payments/payment-coordinator.md): Customer check-in at a payment location, and payment creation, capture, refund and cancel. - [Get payment location details](https://help.lobyco.com/api-reference/payments/payment-coordinator/get-v1-payment-locations-paymentlocationid.md): Get payment location details based on id. - [Set up payment location.](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payment-locations-paymentlocation-setup.md): Set up a new payment location or update an existing one. A paymentLocation is required either way. Having a registered payment location is a prerequisite for the POS system to create payments. - [Get check-ins](https://help.lobyco.com/api-reference/payments/payment-coordinator/get-v1-checkin-paymentlocation.md): Get check-ins by paymentLocation and checked-in time. Requested by Purchase Load service. - [Get reverse check-in code details by id](https://help.lobyco.com/api-reference/payments/payment-coordinator/get-v1-checkin-code-checkincodeid.md): Get a check-in code by id - [Register member at payment location](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-checkin-paymentlocation.md): Lock POS by it's paymentLocation. Requested by POS. - [Clear check-in](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-checkin-paymentlocation-clear.md): Clear check-in by it's paymentLocation. Releases the lock on the POS if any member has been checked-in. Requested by POS. - [Check for registered member at payment location](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-checkin-paymentlocation-register-member.md): Register member by it's paymentLocation. Returns memberId if any checked in on the payment location. Requested by POS. - [Generate reverse check-in code](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-checkin-code.md): Generate a check-in code for the member. - [Register member at payment location - v2](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v2-checkin-paymentlocation.md): Register a member at the payment location using either their member ID, loyalty card, phone number, or check-in code. Requested by POS. - [Check for registered member at payment location - v2](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v2-checkin-paymentlocation-register-member.md): Register member by it's paymentLocation. Returns memberId and available balance if any checked in on the payment location. Requested by POS. - [Get payments](https://help.lobyco.com/api-reference/payments/payment-coordinator/get-v1-payments.md): Get payments by receiptId. - [Get payment state](https://help.lobyco.com/api-reference/payments/payment-coordinator/get-v1-payments-paymentid.md): Get payment state by paymentId. - [Get payment](https://help.lobyco.com/api-reference/payments/payment-coordinator/get-v2-payments-paymentid.md): Get a payment by it's paymentId. - [Create POS payment](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payments.md): If requestMemberConfirmation = true, then this payment should be confirmed by member. Otherwise - will try to confirm payment automatically using 'Bonus' payment type. - [Cancel payment](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payments-paymentid-cancel.md): Cancel a payment by it's paymentId. Having a payment that has not yet been captured is a prerequisite for canceling a payment. - [Capture payment](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payments-paymentid-capture.md): Capture a payment by it's paymentId. Having a payment that has been previously authorized is a prerequisite for capturing a payment. - [Refund payment](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payments-paymentid-refund.md): Refund an already successful payment by it's paymentId. Having a payment that has been captured is a prerequisite for refunding a payment. - [External Action Callback](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payments-external-action.md): Used for updating the state of a transaction on the checkout flow. - [Init payment](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v1-payments-init.md): Create POS payment in it's initial state, which is WaitingMemberConfirmation. This means, that payment will be shown in mobile app where member should select payment methods and confirm the payment. - [Create payment - v2](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v2-payments.md): Create payment with specific type: POS, Ecommerce, ScanAndPay, ManualTopUp, SubscriptionTopUp. If requestMemberConfirmation = true, then this payment should be confirmed by member. Otherwise - will try to confirm payment automatically using 'Bonus' payment type. - [Capture payment - v2](https://help.lobyco.com/api-reference/payments/payment-coordinator/post-v2-payments-paymentid-capture.md): Capture transaction by paymentId. Supports partial capture. If partial capture is requested, then remaining amount is cancelled. - [Promotion Platform](https://help.lobyco.com/api-reference/promotion-platform.md): Offers, coupons, discounts, challenges and games — everything that gives a customer a benefit. - [Offers V2](https://help.lobyco.com/api-reference/promotion-platform/offers-v2.md): Earlier offer endpoints. Prefer Offers V3 for new work. - [Get offers by filters](https://help.lobyco.com/api-reference/promotion-platform/offers-v2/get-v2-campaigns.md): By default, does not return any relations or statistics. Needed relations should be explicitly specified. - [Get offer by id](https://help.lobyco.com/api-reference/promotion-platform/offers-v2/get-v2-campaigns-campaignid.md): Get offer by id with requested set of fields. - [Upsert offer](https://help.lobyco.com/api-reference/promotion-platform/offers-v2/post-v2-campaigns.md): If offer with given ID does not exist in promotion service, it is created. - [Upload file](https://help.lobyco.com/api-reference/promotion-platform/offers-v2/post-v2-campaigns-file.md): Upload file for later use. For now, this is limited only to images. - [Mark offer as deleted](https://help.lobyco.com/api-reference/promotion-platform/offers-v2/delete-v2-campaigns-offerid.md): Idempotent. Deleted offer cannot be restored. - [Offers V3](https://help.lobyco.com/api-reference/promotion-platform/offers-v3.md): Current offer endpoints. - [Get offers by filters](https://help.lobyco.com/api-reference/promotion-platform/offers-v3/get-v3-offers.md): By default, does not return any relations or statistics. Needed relations should be explicitly specified. - [Get offer by id](https://help.lobyco.com/api-reference/promotion-platform/offers-v3/get-v3-offers-offerid.md): Get offer by id with requested set of fields. - [Get all available offer types](https://help.lobyco.com/api-reference/promotion-platform/offers-v3/get-v3-offers-types.md) - [Upsert offer](https://help.lobyco.com/api-reference/promotion-platform/offers-v3/post-v3-offers.md): If offer with given ID does not exist in promotion service, it is created. - [Mark offer as deleted](https://help.lobyco.com/api-reference/promotion-platform/offers-v3/delete-v3-offers-offerid.md): Idempotent. Deleted offer cannot be restored. - [Personal Offers V3](https://help.lobyco.com/api-reference/promotion-platform/personal-offers-v3.md): Assign and bulk-import one-to-one personal offers. - [Get import job status](https://help.lobyco.com/api-reference/promotion-platform/personal-offers-v3/get-v3-personaloffers-status.md): This endpoint is a part of CST-based flow. Called by CST to display import progress in Turboflow tool UI. - [Start internal CST import job](https://help.lobyco.com/api-reference/promotion-platform/personal-offers-v3/post-v3-personaloffers.md): This endpoint initiates an internal personal offers import job from Data platform. It is called by CST and works via self-scheduling with a servicebus. - [Imports personal offers to Promotion DB](https://help.lobyco.com/api-reference/promotion-platform/personal-offers-v3/post-v3-personaloffers-bulk.md): Used with external offer allocation imports. This endpoint can work directly through YARP integration layer of a client and via data import service if client choses to use file uploads. All imported offers are expected to have the same start and end dates. Dates from the first row will be used for o… - [Finalize import job](https://help.lobyco.com/api-reference/promotion-platform/personal-offers-v3/post-v3-personaloffers-finish-bulk.md): Used with external offer allocation imports. Marks the import job as finished and ready to use by customers. Idempotent. It is necessary to call this finalization after all batches were loaded via API. Data Import flow will finalization as a part of import. - [Terminate import job](https://help.lobyco.com/api-reference/promotion-platform/personal-offers-v3/delete-v3-personaloffers.md): Cancells import and deletes all imported records. Requires either executionId and flowId if cancelling CST import, or jobId for DataImport jobs. Works idempotently and is safe to retry. Use by both external API and CST flows. - [Bulk V2](https://help.lobyco.com/api-reference/promotion-platform/bulk-v2.md): Earlier bulk endpoints. Prefer Bulk V3 for new work. - [Import campaigns](https://help.lobyco.com/api-reference/promotion-platform/bulk-v2/post-v2-bulk-campaigns.md): Format compatible with Data Import. - [Upsert offers group](https://help.lobyco.com/api-reference/promotion-platform/bulk-v2/post-v2-groups.md) - [Bulk V3](https://help.lobyco.com/api-reference/promotion-platform/bulk-v3.md): Current bulk endpoints. - [Import Offers](https://help.lobyco.com/api-reference/promotion-platform/bulk-v3/post-v3-bulk-offers.md): Format compatible with Data Import. - [Coupons (Web & Mobile) V2](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v2.md): Earlier coupon endpoints for app and web. Prefer V3 for new work. - [Get member coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v2/get-v2-coupons.md): Returns coupons with specified types or all types if no type filters are specified. - [Activate coupon](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v2/post-v2-coupons-couponid-activate.md): Activation sends coupon information to client Coupon or POS integration layer, making it available for pick-up in store. - [Deactivate coupon](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v2/post-v2-coupons-couponid-deactivate.md): Deactivation sends coupon deactivation information to client Coupon or POS integration layer, making it unavailable for pick-up in store. - [Create coupon](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v2/post-v2-coupons-assign.md): Create coupon for the offer (optionally activate) - [Coupons (Web & Mobile) V3](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v3.md): Current coupon endpoints for app and web channels. - [Get customer coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v3/get-v3-customers-customerid-coupons.md): Returns a customer's coupons that are not expired, have been assigned, and have not yet been picked up in store. - [Get coupon by id](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v3/get-v3-customers-customerid-coupons-couponid.md) - [Activate coupon](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v3/post-v3-customers-customerid-coupons-couponid-activate.md): Activation sends coupon information to client Coupon or POS integration layer, making it available for pick-up in store. - [Deactivate coupon](https://help.lobyco.com/api-reference/promotion-platform/coupons-web-and-mobile-v3/post-v3-customers-customerid-coupons-couponid-deactivate.md): Deactivation sends coupon deactivation information to client Coupon or POS integration layer, making it unavailable for pick-up in store. - [Coupons (POS)](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos.md): Retrieve, reserve and redeem customer coupons at the till. - [Get customer coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/get-api-v1-customers-customerid-coupons.md): Returns coupons that can be used in provided store. If storeId is not provided, returns coupons available in any store. - [Get customer coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/get-v2-customers-customerid-coupons.md): Returns coupons that can be used in provided store. If storeId is not provided, returns coupons available in any store. - [Reserve coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/post-api-v1-customers-customerid-coupons-reserve.md): Reserve coupons in order to disallow to use same coupon simultaneously. - [Cancel coupon reservation](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/post-api-v1-customers-customerid-coupons-cancel-reservation.md): If the ReservedBy is different than one that already populated, error will be returned and reservation will not be cancelled. - [Redeem coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/post-api-v1-customers-customerid-coupons-redeem.md): If any of the provided coupons is not found, the error will be returned, but existing coupons will still be redeemed. The error will contain coupons that were not found. - [Redeem coupons](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/post-v2-customers-customerid-coupons-redeem.md): If any of the provided coupons is not found, the error will be returned, but existing coupons will still be redeemed. The error will contain coupons that were not found. - [Cancel coupon redemptions](https://help.lobyco.com/api-reference/promotion-platform/coupons-pos/post-api-v1-customers-customerid-coupons-cancel-redeem.md): If any of the provided coupons or redemptions is not found, the error will be returned, but all found redemptions will be cancelled. The error will contain coupons that were not found. - [Challenges](https://help.lobyco.com/api-reference/promotion-platform/challenges.md): Continuity mechanics: stamp cards, streaks and goals. - [Get available challenges](https://help.lobyco.com/api-reference/promotion-platform/challenges/get-v3-cards.md): When no StoreId or ChainId is provided, all available challenges for the customer are returned. When StoreId and/or ChainId are provided, only the challenges available for the specified store/chain are returned. If both StoreId and ChainId are provided, challenges available in specified store or spe… - [Activate challenge](https://help.lobyco.com/api-reference/promotion-platform/challenges/put-v3-cards-id-activate.md) - [Games](https://help.lobyco.com/api-reference/promotion-platform/games.md): Gameplay and rewards. - [Get all games available to the member](https://help.lobyco.com/api-reference/promotion-platform/games/get-v1-games.md) - [Get v1 games current](https://help.lobyco.com/api-reference/promotion-platform/games/get-v1-games-current.md) - [Start game](https://help.lobyco.com/api-reference/promotion-platform/games/post-v1-games-gameid-start.md) - [Discounts](https://help.lobyco.com/api-reference/promotion-platform/discounts.md): Send a basket and get back applicable offers and calculated discounts. - [Calculate the discounts for a specified purchase](https://help.lobyco.com/api-reference/promotion-platform/discounts/post-v1-discounted-purchases.md) - [Calculate the discounts for a specified basket](https://help.lobyco.com/api-reference/promotion-platform/discounts/post-v1-discounted-baskets.md) - [Retail Master Data](https://help.lobyco.com/api-reference/retail-master-data.md): Purchases, stores, products, hierarchies and articles. - [Purchases](https://help.lobyco.com/api-reference/retail-master-data/purchases.md): Record finalized sales. This is the call that triggers bonus, receipts and challenge progress. - [Get purchase by receiptId.](https://help.lobyco.com/api-reference/retail-master-data/purchases/get-v1-purchases-receiptid.md): Returns the purchase data if available. - [Loads purchase.](https://help.lobyco.com/api-reference/retail-master-data/purchases/post-v1-purchases.md): Tries to enrich original request with memberId from LoyaltyCard service, if loyaltyCardId has value and memberId is null, then saves the purchase. - [Stores](https://help.lobyco.com/api-reference/retail-master-data/stores.md): Stores and chains. - [Returns all chains.](https://help.lobyco.com/api-reference/retail-master-data/stores/get-v3-chains.md) - [Returns chain by chain id.](https://help.lobyco.com/api-reference/retail-master-data/stores/get-v3-chains-chainid.md) - [Import chains](https://help.lobyco.com/api-reference/retail-master-data/stores/post-v3-chains-import.md): Imports chains from .csv file. Will totally replace all chains with new ones. If invalid chain row passed, it won't be imported. Expected CSV columns: - Id*: string - Identifier of chain, to which store belongs - Name*: string - Name of store chain - LogoAssetId*: string - Identifier of logo… - [Get stores by specified query criteria. By default, opening hours are included in the response model. Set includeOpeningHours=false to exclude them.](https://help.lobyco.com/api-reference/retail-master-data/stores/get-v3-stores.md): QueryParameters description: - Name - searches stores, which name contains searched name - GeoCoordinates - the results will be ordered in such way, that closest stores are displayed first - ChainIds - filters stores by ChainIds - GeoCoordinates.Radius - Radius range is from 0m to 1.000.000m -… - [Returns store by id. By default, opening hours are included in the response model. Set includeOpeningHours=false to exclude them.](https://help.lobyco.com/api-reference/retail-master-data/stores/get-v3-stores-storeid.md) - [Get stores page by specified query criteria.](https://help.lobyco.com/api-reference/retail-master-data/stores/get-v3-stores-page.md) - [Imports Adjustment Opening Hours for specified stores.](https://help.lobyco.com/api-reference/retail-master-data/stores/post-v3-stores-adjustments-import.md) - [Imports stores including opening hours.](https://help.lobyco.com/api-reference/retail-master-data/stores/post-v3-stores-import.md) - [Imports stores including opening hours. Introduced for DataImport service.](https://help.lobyco.com/api-reference/retail-master-data/stores/post-v3-stores-import-data-import.md) - [Deletes store record with specified store id.](https://help.lobyco.com/api-reference/retail-master-data/stores/delete-v3-stores-storeid.md) - [Uploads assets with specified path to the storage.](https://help.lobyco.com/api-reference/retail-master-data/stores/post-v3-assets-path.md): Path validation rules: - The path must be no longer then 1024 characters - Max segments count is 256 - Must be valid DNS name - Can not contain two separators '/' in a row. - Max file name length is 256 characters - [Products](https://help.lobyco.com/api-reference/retail-master-data/products.md): Product master data. - [Get product by external id](https://help.lobyco.com/api-reference/retail-master-data/products/get-v1-products-externalid.md): Returns product by its external identifier. - [Get product by EAN](https://help.lobyco.com/api-reference/retail-master-data/products/get-v1-products-ean-ean.md): Returns product by its EAN. Can be configured to return also hierarchy images based on provided query parameters. - [Upsert products](https://help.lobyco.com/api-reference/retail-master-data/products/post-v1-products-import.md): Imports products (upserts existing products and adds new products). Usually performed via direct integration with Data Import service. - [Hierarchies](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies.md): Product category hierarchies. - [Get hierarchy by hierarchy ids](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies/get-v1-hierarchies.md): Returns hierarchy from itself to the root level for specified hierarchies - [Get hierarchy tree by hierarchy id](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies/get-v1-hierarchies-hierarchyid.md): Returns the entire hierarchy tree from the specified hierarchy identifier up to the root level - [Get hierarchy for products](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies/get-v1-hierarchies-product.md): Returns the entire hierarchy tree for the specified products (either by productIds or EANs) - [Upsert full hierarchy tree](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies/post-v1-hierarchies-import.md): Imports full hierarchies (upserts existing and adds new hierarchies with all their nodes). Usually performed via direct integration with Data Import service - [Partial upsert of hierarchies](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies/patch-v1-hierarchies-import.md): Imports hierarchy's nodes (upserts existing and adds new leaf nodes or leaf subtrees). Usually performed via direct integration with Data Import service - [Get products](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchies/get-v1-products.md): Returns paginated list of products based on the provided query parameters. - [Hierarchy Reference Book](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchyreferencebook.md): The hierarchy reference book. - [Get full hierarchy reference book](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchyreferencebook/get-v1-hierarchyreferencebook.md): Returns full hierarchy reference book as a list of hierarchy levels - [Upsert reference book](https://help.lobyco.com/api-reference/retail-master-data/products/hierarchyreferencebook/post-v1-hierarchyreferencebook-import.md): Imports hierarchy reference book (upserts existing levels and adds new levels). Usually performed via direct integration with Data Import service. - [Articles V1](https://help.lobyco.com/api-reference/retail-master-data/articles-v1.md): Earlier article endpoints. Prefer Articles V2 for new work. - [Legacy article upsert](https://help.lobyco.com/api-reference/retail-master-data/articles-v1/post-v1-import.md): Imports article information in bulk. Since this endpoint has been developed for backwards compatibility purpose, the endpoint may be removed in future versions. Use v2 import of articles instead. - [Get article by storeId and EAN](https://help.lobyco.com/api-reference/retail-master-data/articles-v1/get-v1-stores-storeid-articles.md): Returns article by its EAN within a specific store - [Get article by storeId and articleId](https://help.lobyco.com/api-reference/retail-master-data/articles-v1/get-v1-stores-storeid-articles-articleid.md): Returns article by its id within a specific store - [Articles V2](https://help.lobyco.com/api-reference/retail-master-data/articles-v2.md): Current article endpoints. - [Upsert articles](https://help.lobyco.com/api-reference/retail-master-data/articles-v2/post-v2-articles-import.md): Import or update full article information(including prices) in bulk. Usually performed via direct integration with Data Import service. - [Upsert article prices](https://help.lobyco.com/api-reference/retail-master-data/articles-v2/post-v2-articles-prices-import.md): Import or update article prices in bulk. Usually performed via direct integration with Data Import service. - [Get articles by store id](https://help.lobyco.com/api-reference/retail-master-data/articles-v2/get-v2-stores-storeid-articles.md): Retrieve the list of articles based on specific search criteria. At least one query parameter needs to be supplied. - [Get article by id](https://help.lobyco.com/api-reference/retail-master-data/articles-v2/get-v2-stores-storeid-articles-articleid.md): Retrieve article information based on storeId and articleId. - [Savings History](https://help.lobyco.com/api-reference/savings-history.md): Aggregated customer savings across bonus, offers, games and challenges, for app and web channels. - [Member Savings](https://help.lobyco.com/api-reference/savings-history/member-savings.md): Savings statements and aggregated statistics. - [Gets member's active account statements](https://help.lobyco.com/api-reference/savings-history/member-savings/get-web-v1-statements.md) - [Gets member's active account statistics](https://help.lobyco.com/api-reference/savings-history/member-savings/get-web-v1-statistics.md) - [Get Started](https://help.lobyco.com/business-documentation/get-started.md): First steps for a new Lobyco admin — orientation, access, and the shape of the platform. - [Audiences & Data](https://help.lobyco.com/business-documentation/audiences-and-data.md): Build and target audiences, and manage the data underneath them. - [Campaigns](https://help.lobyco.com/business-documentation/campaigns.md): Wrap activities and audiences into a scheduled, tracked promotion. - [Measure](https://help.lobyco.com/business-documentation/measure.md): See how activities and campaigns performed. - [Administer](https://help.lobyco.com/business-documentation/administer.md): Configure the platform and manage access. - [Reference](https://help.lobyco.com/business-documentation/reference.md): Look things up — glossary, block reference, field tables and API docs. - [Get Help](https://help.lobyco.com/business-documentation/get-help.md): Reach support — routed by your support tier. - [Use Cases](https://help.lobyco.com/business-documentation/use-cases.md): Goal-framed worked examples — pick a real scenario and follow it end to end. - [Reuse a saved segment across campaigns](https://help.lobyco.com/business-documentation/use-cases/reuse-a-saved-segment-across-campaigns.md): Save an audience definition once, then select it in any campaign. - [Find customers who bought a specific product](https://help.lobyco.com/business-documentation/use-cases/find-customers-who-bought-a-specific-product.md): Reach the customers who have bought a given product in a recent window. - [Find customers by spend in a chain](https://help.lobyco.com/business-documentation/use-cases/find-customers-by-spend-in-a-chain.md): Target customers who spent over a threshold in one chain, in a recent window. - [Find customers by purchase volume in a store](https://help.lobyco.com/business-documentation/use-cases/find-customers-by-purchase-volume-in-a-store.md): Target customers by how many items they bought in one store, in a given period. - [Find customers by profile and purchase frequency](https://help.lobyco.com/business-documentation/use-cases/find-customers-by-profile-and-purchase-frequency.md): Combine a profile attribute with how often someone shops. - [Add extra customer data to your results](https://help.lobyco.com/business-documentation/use-cases/add-extra-customer-data-to-your-results.md): Use the Enrich block to attach customer attributes to a segment's output. - [Split a segment into groups](https://help.lobyco.com/business-documentation/use-cases/split-a-segment-into-groups.md): Divide one audience into groups that can be treated differently. - [Use an imported customer list instead of a segment](https://help.lobyco.com/business-documentation/use-cases/use-an-imported-customer-list-instead-of-a-segment.md): Feed a campaign from a file of customer IDs rather than a segment. - [Reuse a previous campaign's results](https://help.lobyco.com/business-documentation/use-cases/reuse-a-previous-campaigns-results.md): Chain one campaign into the next by seeding it with an earlier result. - [Schedule a campaign and check its results](https://help.lobyco.com/business-documentation/use-cases/schedule-a-campaign-and-check-its-results.md): Put a campaign on a schedule, then read what happened in Execution History. - [Offer examples: what you can build](https://help.lobyco.com/business-documentation/use-cases/offer-examples-what-you-can-build.md): The discount shapes the promotion platform supports, with a worked example of each. - [Journeys](https://help.lobyco.com/business-documentation/journeys.md): Automate sequences of actions on the orchestration canvas. - [Journey canvas](https://help.lobyco.com/business-documentation/journeys/journey-canvas.md): Build an automated flow on the orchestration canvas. - [Journey list](https://help.lobyco.com/business-documentation/journeys/journey-list.md): Find, clone and monitor your journeys. - [Block reference](https://help.lobyco.com/business-documentation/journeys/block-reference.md): Every block on the canvas, what it does and what it needs. - [Activities](https://help.lobyco.com/business-documentation/activities.md): The mechanics customers engage with — offers, games, challenges, bonuses and vouchers. - [Offers](https://help.lobyco.com/business-documentation/activities/offers.md): Discounts and rewards targeted at a segment. - [Create an offer](https://help.lobyco.com/business-documentation/activities/offers/create-an-offer.md): Configure an offer step by step, from its basics through to how it looks in the app. - [Discount types reference](https://help.lobyco.com/business-documentation/activities/offers/discount-types-reference.md): The seven discount models an offer can use, what each one supports, and a worked example of each. - [Overview](https://help.lobyco.com/business-documentation/activities/offers/overview.md): What an offer is, how a coupon differs from it, and how the two produce a discount. - [Why isn't a customer's coupon working?](https://help.lobyco.com/business-documentation/activities/offers/why-isnt-a-customers-coupon-working.md): Check the state of one customer's coupons and work out why a discount wasn't applied. - [Games](https://help.lobyco.com/business-documentation/activities/games.md): Interactive mechanics — the largest activity type. - [Game types](https://help.lobyco.com/business-documentation/activities/games/game-types.md): The catalogue of game mechanics available. - [Game design](https://help.lobyco.com/business-documentation/activities/games/game-design.md): Configure and brand a game before it goes live. - [Game activity](https://help.lobyco.com/business-documentation/activities/games/game-activity.md): Run, monitor and troubleshoot a live game. - [Challenges](https://help.lobyco.com/business-documentation/activities/challenges.md): Multi-step goals customers work towards. - [Bonuses](https://help.lobyco.com/business-documentation/activities/bonuses.md): Points and bonus accrual mechanics. - [New Vouchers](https://help.lobyco.com/business-documentation/activities/new-vouchers.md): The current voucher mechanic. - [Channels](https://help.lobyco.com/business-documentation/channels.md): Reach customers through push, email, banners, feeds, prompts and deeplinks. - [Triggering](https://help.lobyco.com/business-documentation/channels/triggering.md): How a communication gets sent — documented once, for every channel. - [Lifecycle](https://help.lobyco.com/business-documentation/channels/lifecycle.md): The states a communication moves through — documented once, for every channel. - [Push](https://help.lobyco.com/business-documentation/channels/push.md): Push notifications. - [Email](https://help.lobyco.com/business-documentation/channels/email.md): Email communications. - [Banner](https://help.lobyco.com/business-documentation/channels/banner.md): In-app banners. - [Feeds](https://help.lobyco.com/business-documentation/channels/feeds.md): The in-app feed. - [Prompt](https://help.lobyco.com/business-documentation/channels/prompt.md): In-app prompts. - [Deeplinks](https://help.lobyco.com/business-documentation/channels/deeplinks.md): Linking straight into a place in the app. ## OpenAPI Specs - [audience-dataimport-v1](https://help.lobyco.com/openapi/audience-dataimport-v1.json) - [website-v1](https://help.lobyco.com/openapi/website-v1.json) - [store-v3](https://help.lobyco.com/openapi/store-v3.json) - [receipts-v1](https://help.lobyco.com/openapi/receipts-v1.json) - [push-v1](https://help.lobyco.com/openapi/push-v1.json) - [purchase-v1](https://help.lobyco.com/openapi/purchase-v1.json) - [prompt-v1](https://help.lobyco.com/openapi/prompt-v1.json) - [promotion-v3](https://help.lobyco.com/openapi/promotion-v3.json) - [promotion-v2](https://help.lobyco.com/openapi/promotion-v2.json) - [promotion-v1](https://help.lobyco.com/openapi/promotion-v1.json) - [product-catalog-v2](https://help.lobyco.com/openapi/product-catalog-v2.json) - [product-catalog-v1](https://help.lobyco.com/openapi/product-catalog-v1.json) - [pos-discount-v1](https://help.lobyco.com/openapi/pos-discount-v1.json) - [payment-v1](https://help.lobyco.com/openapi/payment-v1.json) - [member-v1](https://help.lobyco.com/openapi/member-v1.json) - [game-v1](https://help.lobyco.com/openapi/game-v1.json) - [feed-v1](https://help.lobyco.com/openapi/feed-v1.json) - [dataimport-v2](https://help.lobyco.com/openapi/dataimport-v2.json) - [dataimport-v1](https://help.lobyco.com/openapi/dataimport-v1.json) - [customerfeedback-v1](https://help.lobyco.com/openapi/customerfeedback-v1.json) - [coupon-v1](https://help.lobyco.com/openapi/coupon-v1.json) - [consent-v1](https://help.lobyco.com/openapi/consent-v1.json) - [challenge-v3](https://help.lobyco.com/openapi/challenge-v3.json) - [bonus-v1](https://help.lobyco.com/openapi/bonus-v1.json) - [bonus-calculation-v1](https://help.lobyco.com/openapi/bonus-calculation-v1.json) - [banner-v1](https://help.lobyco.com/openapi/banner-v1.json) - [audience-v1](https://help.lobyco.com/openapi/audience-v1.json) - [delta-sharing-v0-2](https://help.lobyco.com/openapi/delta-sharing-v0-2.yaml)