# Antavo Documentation > Explore comprehensive developer documentation on how to implement the capabilities of the Antavo Loyalty Cloud. ## Guides - [About Antavo](https://developers.antavo.com/docs/getting-started.md) - [Actions and Events](https://developers.antavo.com/docs/actions-events.md) - [API events](https://developers.antavo.com/docs/api-events.md) - [Internal events](https://developers.antavo.com/docs/internal-events.md): Internal events are automatically generated by the Loyalty Engine during its operations. These events cannot be triggered from external sources such as webhooks or API requests. - [Customers](https://developers.antavo.com/docs/customers.md) - [Transactions](https://developers.antavo.com/docs/transactions.md) - [Antavo APIs](https://developers.antavo.com/docs/antavo-apis.md) - [API browser](https://developers.antavo.com/docs/api-browser.md) - [API security](https://developers.antavo.com/docs/api-security.md) - [API signing](https://developers.antavo.com/docs/api-signing.md) - [Signing API requests in Postman](https://developers.antavo.com/docs/signing-api-requests-in-postman.md) - [Pagination, filtering and ordering](https://developers.antavo.com/docs/pagination-filtering-and-ordering.md) - [Integration concepts](https://developers.antavo.com/docs/integrations.md) - [In-store retail integration](https://developers.antavo.com/docs/in-store-retail-integration.md) - [E-commerce integrations](https://developers.antavo.com/docs/e-commerce-integrations.md) - [Shopify](https://developers.antavo.com/docs/shopify.md) - [Magento](https://developers.antavo.com/docs/magento.md) - [Salesforce Commerce Cloud](https://developers.antavo.com/docs/salesforce-commerce-cloud.md) - [Implementing the Promotion Engine](https://developers.antavo.com/docs/implementing-promotion-engine.md) ## API Reference - [About Events API](https://developers.antavo.com/reference/about-events-api.md) - [Submit an Antavo event](https://developers.antavo.com/reference/post_events.md): Use this endpoint to submit a single event for a specified customer. The attributes provided in the data object are examples of `point_add` and `checkout` events. Refer to the [complete list of events](/docs/api-events) for all available actions and their attributes. Examples of event submission: - **Standard event submission**: Submit an event for the customer without any additional identifiers. - **Event submission with an external ID**: Include the `external_id` attribute to link the event with an external identifier of the customer from another system or database. - **Event submission with multiple accounts**: Specify multiple accounts by including their IDs in the 'account' attribute. This requires the Points economy module to be enabled.
*Note*: if no account is specified, the event will be assigned to the default account. - [Submit multiple Antavo events in a single request](https://developers.antavo.com/reference/post_bulk-events.md): Use this endpoint to submit multiple events within a single API request. Events are processed individually and synchronously. Examples of event submissions: - **Standard event submission**: Submit events for the customers without any additional identifiers. - **Event submission with an external ID**: Include the `external_id` attribute to link the events with external identifiers of customers from another system or database. - **Event submission with multiple accounts**: Specify multiple accounts by including their IDs in the `account` attribute. This requires the Points economy module to be enabled.
*Note*: if no account is specified, the events will be assigned to the default account. The response will include a success message or an error for each event in the order they were submitted. An error code is only returned if the entire request is invalid, not for errors related to individual event submissions. > **Note** > This endpoint is **not compatible with guest checkout**. Guest checkout events must be submitted individually via the `/events` endpoint using `"guest": "true"`, and later linked to a member with the `checkout_claim` event. - [About Customer API](https://developers.antavo.com/reference/about-customer-api.md) - [Search Antavo database using customer filters](https://developers.antavo.com/reference/get_customers.md): This endpoint allows you to search the Antavo database for customers based on specific criteria and returns the Antavo Customer ID. Note that the filtering is case-sensitive and does not support partial matches. The filtering query requires that the filter parameter has been tagged as [searchable](https://docs.antavo.com/customers#add-a-new-field) in the Antavo Management UI. - [Returns detailed customer data using the Antavo unique ID](https://developers.antavo.com/reference/get_customers-customer-id.md): This endpoint returns detailed information for a specific customer. - [Merges the current customer into the target account](https://developers.antavo.com/reference/post_customers-customer-id-merge.md): This endpoint permanently merges the current customer into the target account. - [Returns the number of active customers](https://developers.antavo.com/reference/get_customers-count.md): This endpoint returns the number of customers with active status within Antavo. - [About Display API](https://developers.antavo.com/reference/about-display-api.md) - [List all available activities for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities.md): Aggregates available earn and spend options provided by modules including: * [Challenges](https://docs.antavo.com/docs/challenges) * [Gamified profiling](https://docs.antavo.com/docs/gamified-profiling) * [Incentivized purchase](https://docs.antavo.com/docs/incentivized-purchase) * [Rewards](https://docs.antavo.com/docs/rewards) * [Social follow](https://docs.antavo.com/docs/social-follow) * [Social share](https://docs.antavo.com/docs/social-share) * [Offline treasure hunt](https://docs.antavo.com/docs/offline-treasure-hunt) * [Contest lite](https://docs.antavo.com/docs/contest-lite) * [Content consumption](https://docs.antavo.com/docs/content-consumption) * [Gamified reviews](https://docs.antavo.com/docs/gamified-reviews) * [Friend referral](https://docs.antavo.com/docs/friend-referral) * [Instagram contests](https://docs.antavo.com/docs/instagram-contests) * [Offers](https://docs.antavo.com/docs/offers) * [Quizzes](https://docs.antavo.com/docs/quizzes) * [Online treasure hunt](https://docs.antavo.com/docs/online-treasure-hunt) * [Prize wheels](https://docs.antavo.com/docs/prize-wheels) * [Workflow campaigns](https://docs.antavo.com/docs/workflow-configuration#configure-campaign-settings) - [List all earn activities visible for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-earn.md): Aggregates all earn activities relevant to the customer, provided by modules including: * [Challenges](https://docs.antavo.com/docs/challenges) * [Gamified profiling](https://docs.antavo.com/docs/gamified-profiling) * [Incentivized purchase](https://docs.antavo.com/docs/incentivized-purchase) * [Social follow](https://docs.antavo.com/docs/social-follow) * [Offline treasure hunt](https://docs.antavo.com/docs/offline-treasure-hunt) * [Content consumption](https://docs.antavo.com/docs/content-consumption) * [Gamified reviews](https://docs.antavo.com/docs/gamified-reviews) - [List all available spend activities for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-spend.md): Aggregates available earn and spend options provided by modules including: * [Rewards](https://docs.antavo.com/docs/rewards) * [Contest lite](https://docs.antavo.com/docs/contest-lite) - [List all available challenges for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-challenges.md): This endpoint returns all active challenges that are available for the customer to complete. To access a filtered result, please use the [v2 endpoint](/reference/get_v2-customers-customer-id-activities-challenges). - [List a customer's completed challenges](https://developers.antavo.com/reference/get_customers-customer-id-challenges.md): This endpoint returns a customer's challenge completion history. Use the [v2 endpoint](/reference/get_v2-customers-customer-id-challenges) to get a more complete and filterable view. - [V2 List all available challenges for a customer](https://developers.antavo.com/reference/get_v2-customers-customer-id-activities-challenges.md): This endpoint returns all active challenges that are available for the customer to complete. Results can be [filtered](/docs/pagination-filtering-and-ordering#filtering) with query parameters listed below. - [V2 List a customer's completed challenges](https://developers.antavo.com/reference/get_v2-customers-customer-id-challenges.md): This endpoint returns a customer's challenge completion history. Results can be [filtered](/docs/pagination-filtering-and-ordering#filtering) with query parameters listed below. - [List available content consumption activities for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-content-consumption.md): This endpoint returns all content consumption activities that are available for a specific customer to complete. - [List all available contests for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-contests.md): This endpoint returns all contests that are available for a specific customer to enter. - [Submit a contest entry](https://developers.antavo.com/reference/post_customers-customer-id-activities-contests-contest-id-enter.md) - [List coupons assigned to a customer](https://developers.antavo.com/reference/get_customers-customer-id-coupons.md): Returns all coupons that has been assigned to a specified customer. - [Retrieve Antavo data extensions](https://developers.antavo.com/reference/get_customers-customer-id-data-data-extension.md): This endpoint allows for accesssing data of a specific customer stored in extensions. - [List all Antavo events associated with a customer](https://developers.antavo.com/reference/get_customers-customer-id-events.md): This endpoint returns a detailed list of events and the corresponding actions recorded with the specified customer ID. This information can be used as a customer activity source and can also be accessed using the `/history`endpoint. The event history/log/stream can be pre-filtered by specific event actions and paginated by limiting and offsetting the number of returned events. The response also includes event expiration dates, if set. This endpoint was historically known as `/customers/{customer_id}/history`. This endpoint is still valid and all options listed below are also applicable. - [Retrieve a time-filtered list of every event for all customers](https://developers.antavo.com/reference/get_customers-events.md): This endpoint returns all events for all customers that match the specified datetime timestamp query. The returned object contains the total number of matching events and an array of every matching event. The datetime filter accepts the following operators and can be combined to generate a time window: * `gt` - greater than * `lt` - less than * `gte` - greater than or equal * `lte` - less than or equal The timestamp filter must be in ISODate format. Example: ``timestamp.gt=2023-01-05``,``timestamp.gt=2023-01-05T13:28:55`` or ``timestamp.gt=2023-01-05T13:28:55.233+0000``. **Note**: The timezone offset optional parameter (e.g., +0000) must be URL-encoded. - [List all offers available for the customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-offers.md): This endpoints provides the list of all available offers for a specific customer. - [Claim an offer for a specific customer](https://developers.antavo.com/reference/post_customers-customer-id-activities-offers-offer-id-claim.md): This endpoint allows for claiming an offer for a customer. - [List profiling flows available to the customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-profiling.md): This endpoints provides the list of all available profiling flow for a specific customer to complete. - [Retrieve the next question to answer within a profiling flow](https://developers.antavo.com/reference/get_customers-customer-id-activities-profiling-flow-id-next.md): This endpoints returns the next question within a profiling flow that the customer should answer. If there are no more questions left to answer in the given flow, the call will trigger the ``profiling_flow`` event, and any associated points will be awarded to the customer. - [Submit an answer to a profiling question](https://developers.antavo.com/reference/post_customers-customer-id-activities-profiling-flow-id-questions-question-id.md): This endpoint allows for submitting the customer's answers to profiling questions. Two types of events are recorded through this endpoint: * A `profiling_answer` event is recorded each time an answer is submitted to a profiling question. * A `profiling_flow` event is recorded once all answers in a flow have been successfully submitted in separate requests. This event indicates that the entire profiling sequence has been completed. Learn more about these events under the list of [Internal events](/docs/internal-events#profiling_answer). - [List all quizzes](https://developers.antavo.com/reference/get_customers-customer-id-activities-quizzes.md): This endpoint returns all configured quiz questions that the customer may answer. - [List quiz details](https://developers.antavo.com/reference/get_customers-customer-id-activities-quizzes-quiz-id.md): This endpoint returns configured attributes of quiz questions. - [Submit an answer to a quiz](https://developers.antavo.com/reference/post_customers-customer-id-activities-quizzes-quiz-id-earn.md): This endpoint allows for the submission of answers to quiz questions. - [List all available rewards for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-rewards.md): This endpoints provides the list of all available rewards for a specific customer. - [Retrieve a specific reward available for a customer](https://developers.antavo.com/reference/get_customers-customer-id-activities-rewards-reward-id.md): A endpoint provides detailed information about a specified reward available for a specific customer. - [Claim a reward for a specific customer](https://developers.antavo.com/reference/post_customers-customer-id-activities-rewards-reward-id-claim.md): This endpoint allows for claiming a reward for a customer. - [Revoke a previously claimed reward](https://developers.antavo.com/reference/post_customers-customer-id-activities-rewards-reward-id-revoke.md): This endpoint revokes a specific reward claim. - [Submit a bid for the customer on a specified bidding reward](https://developers.antavo.com/reference/post_customers-customer-id-activities-rewards-reward-id-bid.md): The endpoint automatically calculates and submits a bid for a specified customer on the specific bidding reward. The bid amount is based on the current highest bid and the [bid step](https://docs.antavo.com/docs/rewards#bidding-rewards), which is set in the Antavo Management UI. Manually set value for bids is possible by submitting an amount in the request body. - [List a customer's claimed rewards](https://developers.antavo.com/reference/get_customers-customer-id-rewards.md): This endpoint provides the detailed list a customer's claimed rewards. - [Retrieve the transaction history for a specific customer](https://developers.antavo.com/reference/get_customers-customer-id-transactions.md): This endpoint provides a detailed list of a customer's transactions. Each returned transaction contains the transaction ID, transaction status and all other related transaction information submitted in the initial event. The list of returned transactions can also be subsequently paginated by limiting the number of returned transactions and subsequently offsetting the returned transactions. - [Retrieve a specified transaction for a specific customer](https://developers.antavo.com/reference/get_customers-customer-id-transactions-transaction-id.md): This endpoint provides a detailed breakdown of a customer's transaction. If you need to retrieve the event ID that created the transaction, use the [/transactions](/reference/get_customers-customer-id-transactions) endpoint with the ``id`` query parameter to access the corresponding event information. - [List all events associated with a specified transaction for a specific customer](https://developers.antavo.com/reference/get_customers-customer-id-transactions-transaction-id-events.md): This endpoint provides a detailed breakdown of a specified customer's transaction. The following events are returned by this endpoint: * [checkout](/docs/api-events#checkout), [checkout_item](/docs/api-events#checkout_item). * [checkout_update](/docs/api-events#checkout_update), [checkout_update_item](/docs/api-events#checkout_update_item). * [checkout_accept](/docs/api-events#checkout_accept), [checkout_reject](/docs/api-events#checkout_accept_item). * [point_add](/docs/api-events#point_add),[point_spend](/docs/api-events#point_spend),[point_unspend](/docs/api-events#point_unspend). * [refund](/docs/api-events#refund), [partial_refund](/docs/api-events#partial_refund), [refund_item](/docs/api-events#refund_item). * [release_points](/docs/api-events#release_points), [reserve_points](/docs/api-events#reserve_points). * any other event with a transaction ID. - [Search transactions for a specific customer using criteria](https://developers.antavo.com/reference/get_customers-customer-id-transactions-search.md): This endpoint provides transactional-based searches for a specific customer. Customer transactions can be filtered by transaction ID and status, and highly selective queries can be generated using the generic entity [filtering](/docs/pagination-filtering-and-ordering#filtering). Example: `GET /customers/001/transactions/-/search?id.in=trx01,trx02,trx03&status=pending` All inline examples within this documentation uses simple matching. This endpoint has a 8k request URI limit, this corresponds to approximately 5000 transaction IDs which are less than 15 character in length. Higher volumes of filtering are possible using the [POST Method](/post_customers-customer-id-transactions-search). - [Perform bulk transaction search for a specific customer](https://developers.antavo.com/reference/post_customers-customer-id-transactions-search.md): This endpoint provides the option of high-volume transaction-based searching. Customer transactions can be filtered by transaction ID and status provide in the request body. Highly selective queries can be generated using the generic entity [filtering](/docs/pagination-filtering-and-ordering#filtering). - [Retrieve download URLs for assigned wallet passes](https://developers.antavo.com/reference/get_customers-customer-id-wallet.md): This endpoint returns all wallet passes for a specific customer. A new access token is generated every time the endpoint is called. - [Create a new customer with log-in credentials](https://developers.antavo.com/reference/post_customers-customer-id-opt-in.md): This endpoint creates customer within Antavo according to the specified opt-in parameters stated in the body. This interface is primarily used as a customer-driven registration process which also generates login credentials, enabling the new customer to log into Antavo systems. This endpoint complements the [opt-in](https://developers.antavo.com/docs/api-events#opt_in) event. - [Log in a specific customer to Antavo](https://developers.antavo.com/reference/post_customers-login.md): This endpoint logs the specified customer into Antavo and a successful login returns the customer object. The username attribute can be specified in the Antavo Management UI from any available profile attribute. The customer ID can then be accessed and used for subsequent calls using Antavo Display API endpoints. A successful log-in will also create a ``daily_login`` event for the customer. This event will only be written once to the customer's event stream per calendar day. This requires the Custom login module to be enabled. - [Request a new password for Antavo login](https://developers.antavo.com/reference/post_customers-password-request.md): A forgotten password can be reset through this endpoint. The username can be set in the Customer login module in the Management UI and can be any customer profile attribute. The `url` string is a URL which can be extended with the reset token. - [Reset the password of the current customer](https://developers.antavo.com/reference/post_customers-password-reset.md): This provides a customer interface for changing a password. The token is captured from the link provided by the password reset email. A simple check is provided to ensure that the two passwords match. This requires the Custom login module to be enabled. - [Verify credentials provided during registration](https://developers.antavo.com/reference/get_customers-verify.md): This endpoint is used to confirm registration. A successful verification will change the status of the customer to `active` and enable them to log in and engage with the loyalty program. Failure will leave the customer in an `inactive` status. The verification process occurs using a token. This requires the Custom login module with the verification option enabled (disabled by default). - [List all available prize wheels](https://developers.antavo.com/reference/get_customers-customer-id-prize-wheels.md): This endpoint returns the list of all available prize wheels for a specific customer. - [Retrieve all slices for a specific prize wheel](https://developers.antavo.com/reference/get_customers-customer-id-prize-wheels-pw-id.md): This endpoint provides all information regarding each individual slice of the prize wheel. Configured rewards can be used in a slice, and the full reward information can be returned with the slice information using the `fields` query. - [Enters a customer into a specific prize wheel draw](https://developers.antavo.com/reference/post_customers-customer-id-prize-wheels-pw-id.md) - [List all available treasure hunts](https://developers.antavo.com/reference/get_customers-customer-id-activities-treasure-hunt.md): This endpoint returns the list of all available online treasure hunts for a specific customer. - [About Entities API](https://developers.antavo.com/reference/about-entities-api.md) - [List all available entity of an entity module](https://developers.antavo.com/reference/get_entities-module-entity.md): This endpoint lists all available entity items within the specified entity module. This interaction is customer-independent. - [Create a new entity](https://developers.antavo.com/reference/put_entities-module-entity.md): This endpoint created an entity in an entity module. Any parameter can be set as long as there is the corresponding attribute pre-configured in the Management UI. - [Retrieve all information regarding a specific entity](https://developers.antavo.com/reference/get_entities-module-entity-entity-id.md): This endpoint returns all information regarding a specific entity item. - [Update a specific entity](https://developers.antavo.com/reference/post_entities-module-entity-entity-id.md): Any pre-configured attribute in an entity itek can be modified using this API endpoint. Modification requires the use of attribute's unique ID, set in the Management UI. - [Create a new entity with a specific entity ID](https://developers.antavo.com/reference/put_entities-module-entity-entity-id.md): An entity item with a specified ID can be created in an entity module using this endpoint. Any parameter can be set as long as there is the corresponding attribute pre-configured in the Management UI. - [Archive an inactive entity](https://developers.antavo.com/reference/delete_entities-module-entity-entity-id.md): This endpoint archives a specific deactivated entity, effectively removing it from the system. The reward will be completely non-visible and inaccessible for member and Management UI users as well. - [Submit entities in bulk](https://developers.antavo.com/reference/post_entities.md): Multiple calls to various entity endpoints can be made by submitting a request with data in array format. The following options are available for error checking the submitted data: - `skip`: Erroneous data is not added, and the whole entry is skipped. - `pre-check`: The submitted data is checked for validity but not entered into the Antavo system. Any error messages are returned. - `fail`: The submission is stopped when an error is encountered. - [List all available rewards](https://developers.antavo.com/reference/get_entities-rewards-reward.md): This endpoint lists all available rewards.
It allows filtering by stores configured in the Stores module. - [Create a new reward](https://developers.antavo.com/reference/put_entities-rewards-reward.md): This endpoint facilitates the creation of rewards. - [Returns all information regarding a specific reward](https://developers.antavo.com/reference/put_entities-rewards-reward-entity-id.md): A detailed breakdown of all parameters for the specific reward is returned. - [Update specific reward attributes](https://developers.antavo.com/reference/post_entities-rewards-reward-entity-id.md): An attribute of a reward can be updated via this endpoint. - [Archive an inactive reward](https://developers.antavo.com/reference/delete_entities-rewards-reward-entity-id.md): This endpoint archives a specific deactivated reward, effectively removing it from the system. The reward will be completely non-visible and inaccessible for members and Management UI users as well. - [Create a new customer list](https://developers.antavo.com/reference/put_entities-core-customer-list.md): This endpoint allows you to create a new customer list. - [List all available customer lists](https://developers.antavo.com/reference/get_entities-core-customer-list.md): This endpoint returns all available customer lists. - [Retrieve information of a specific customer list](https://developers.antavo.com/reference/get_entities-core-customer-list-entity-id.md): This endpoint returns a specific customer list. - [Update a customer list](https://developers.antavo.com/reference/post_entities-core-customer-list-entity-id.md): This endpoint allows you to update a customer list. - [Archive a customer list](https://developers.antavo.com/reference/delete_entities-core-customer-list-entity-id.md): This endpoint allows archiving a customer list and removing users from it. Only inactive lists can be archived. Once archived, lists cannot be restored. - [About Clubs API](https://developers.antavo.com/reference/about-clubs-api.md) - [List club templates](https://developers.antavo.com/reference/get_v1-clubs-templates.md): This endpoint returns the list of club templates based on various query parameters. - [List clubs](https://developers.antavo.com/reference/get_v1-clubs.md): This endpoint returns the list of clubs based on various query parameters. - [Create a new club](https://developers.antavo.com/reference/post_v1-clubs.md): This endpoint allows users to create a new club, which can be assigned to different templates, allowing for varied functionalities and features based on specific user needs. To create a club, the user must provide key details, including the club's name, associated template, and owner ID. Once created, the `club_create` event is automatically registered in both the club's and the club owner's event history. - [Retrieve club details](https://developers.antavo.com/reference/get_v1-clubs-club-id.md): This endpoint returns details of a specific club. - [List members of a specific club](https://developers.antavo.com/reference/get_v1-clubs-club-id-members.md): This endpoint returns the registered club members of a specified club. You can filter members by various parameters, such as member ID, role, and status. Pagination is also supported through offset and limit query parameters. - [Retrieve details of a specific club member](https://developers.antavo.com/reference/get_v1-clubs-club-id-members-customer-id.md): This endpoint returns detailed information about a specific club member identified by their customer ID. The response includes the member's role, status, balance, and spending limits within the club. - [Remove a member from a club](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-remove.md): This endpoint allows users to remove a member from a club. The customer may rejoin the club later. Once created, the `club_member_remove` event is automatically registered in both the club's and the club member's event history. - [Ban a member from a club](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-ban.md): This endpoint is used to removes a member from a club with a ban, preventing the customer from rejoining in the future. Once created, the `club_member_ban` event is automatically registered in both the club's and the club member's event history. - [Unban a banned member from a club](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-unban.md): This endpoint allows banned member to rejoin a club. Once created, the `club_member_unban` event is automatically registered in both the club's and the club member's event history. - [Add a customer to a public club](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-join-public.md): This endpoint allows a registered loyalty member to join a public club as an active member. When a member joins, the `club_member_join` event is automatically registered in both the club's and customer's event history. - [Add a customer to a private club](https://developers.antavo.com/reference/post_v1-clubs-invitations-invitation-id.md): This endpoint allows a registered loyalty member to join a private club as an active club member. When a member joins, the `club_member_join` event is automatically registered in both the club's and customer's event history. - [Create an invitation to a club](https://developers.antavo.com/reference/post_v1-clubs-club-id-invitations.md): Creates an invitation from one member to another in a specified club. - [Accept club membership](https://developers.antavo.com/reference/post_v1-clubs-club-id-applicants-customer-id-accept.md): This endpoint allows the club owner to accept an applicant's request to join the club. When a customer is accepted, the `club_applicant_accept` event is automatically registered in both the club's and the new member's event history. - [Ban an applicant from a club](https://developers.antavo.com/reference/post_v1-clubs-club-id-applicants-customer-id-ban.md): This endpoint allows a user to ban an applicant from the club. The customer cannot apply to the club again in the future. When a customer is banned, the `club_applicant_ban` event is automatically registered in both the club's and the customer's event history. - [Refuse a club applicant](https://developers.antavo.com/reference/post_v1-clubs-club-id-applicants-customer-id-refuse.md): This endpoint allows a user to refuse an applicant from the club. The customer can apply to the club again in the future. When a customer is refused, the `club_applicant_refuse` event is automatically registered in both the club's and the customer's event history. - [Assign club ownership](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-ownership.md): This endpoint allows a user to refuse an applicant from the club. The customer can apply to the club again in the future. When a customer is refused, 2 types of events are created: - `club_revoke_ownership` is registered in the club's and the previous owner's event history - `club_assing_ownership` is registered in the club's and the new owner's event history. - [Disband a club](https://developers.antavo.com/reference/post_v1-clubs-club-id-disband.md): This endpoint allows usersclub owners to disband a specified club. When a club is disbanded, 3 types of events are created: - `club_revoke_ownership` is registered in the club's and the owner's event history - `club_disband` is registered in the club's and the owner's event history. - `club_member_remove` is registered in the club's and all club members' event history (including the club owner). - [Retrieve club history](https://developers.antavo.com/reference/get_v1-clubs-club-id-history.md): This endpoint provides the history of actions performed in a club with optional filtering. - [List expiring points by date](https://developers.antavo.com/reference/get_v1-clubs-club-id-point-expiry.md): This endpoint allows you to retrieve the list of expiring points within a given date range for a specific club. - [Update club details](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-club-update.md): This endpoint allows a club member to update the club's name and provide a reason for the update. When the name of the club is updated, the `club_detail_change` event is automatically registered in both the club's and the customer's event history. - [Adjust points for a specific club member](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-point-adjustment.md): This endpoint allows you to adjust the point contribution for a specific member of a club. Points can be modified positively or negatively. Based on the value of the adjustment, either the `club_point_add` or `club_point_remove` event is recorded in both the club's and the club member's event history. - [Donate account points to clubs](https://developers.antavo.com/reference/post_v1-clubs-club-id-members-customer-id-point-donation.md): Allows a club member to donate their account points to a club. Converts account points into club points and applies cycle limits according to the [configured contribution settings](https://docs.antavo.com/docs/club-templates#contribution-settings). When points are donated, the `club_point_donation` event is automatically registered in both the club's and the customer's event history. - [About Bulk Operations API](https://developers.antavo.com/reference/about-bulk-operations-api.md) - [Claim a specific reward to multiple customers](https://developers.antavo.com/reference/post_v1-bulk-operation-reward-claim-reward-id.md): Submit reward claim requests for a batch of customers. Each request can include a maximum of 100,000 customers. Please note that only one bulk reward claim process can run at a time for one specific reward. If additional batches are submitted while the current one is still processing, they will be added to the queue and processed once the ongoing batch is completed. By the end of the process, the reward events get registered in each customer's event history. - [Query the status of the reward claim process](https://developers.antavo.com/reference/get_v1-bulk-operation-reward-claim-batch-id-status.md): This API endpoint allows you to query the status of a bulk reward claim process, providing details on the processing status, any errors encountered, and the overall completion status. - [Query the failed reward claim attempts](https://developers.antavo.com/reference/get_v1-bulk-operation-reward-claim-batch-id-status-error.md): This endpoint returns the error occured while processing the batch. - [Add customers to a customer list](https://developers.antavo.com/reference/post_v1-bulk-operation-customer-list-add-customer-list-id.md): This API endpoint allows you to add a group of customers to a customer list all at once. It accepts a single customer list ID and an array of customer IDs as input. This API endpoint operates asynchronously, so customer list updates are processed separately. - [Remove customers from a customer list](https://developers.antavo.com/reference/post_v1-bulk-operation-customer-list-remove-customer-list-id.md): This endpoint supports the removal of customers from a customer list in batches. It operates asynchronously, processing customer list updates separately. - [Query the status of a list operation process](https://developers.antavo.com/reference/get_v1-bulk-operation-customer-list-batch-id-status.md): This endpoint allows you to query the status of a list operation process, such as adding or removing customers from a customer list. It provides information about the current processing status of the operation. - [Query the erronous list operation attempts](https://developers.antavo.com/reference/get_v1-bulk-operation-customer-list-batch-id-status-errors.md): This endpoint allows you to query information about any errors or issues encountered during a list operation process. It provides details about errors, if any, that occurred during the operation. - [Manage coupon codes in coupon pools](https://developers.antavo.com/reference/post_v1-bulk-operation-coupons-coupon-pool-id-action.md): This endpoint allows you to upload, assign, and unassign coupons in Coupon Pools in batches. It supports both pre-assigned and unassigned coupons. Uploaded coupon batches are processed asynchronously. Each request can process up to 50,000 coupon codes. - [Query the status of a coupon import](https://developers.antavo.com/reference/get_v1-bulk-operation-coupons-batch-id-status.md): This endpoint allows you to query the status of a coupon batch import. It provides information about the current processing status of the operation, which can be `queued`, `processing` or `done`. - [Query the list of errors related to a coupon import](https://developers.antavo.com/reference/get_v1-bulk-operation-coupons-batch-id-status-error.md): This endpoint allows you to query information about any errors or issues encountered during a coupon import. It provides details about failures that may have occurred during the process. - [About Social Share Campaigns API](https://developers.antavo.com/reference/social-share-campaigns-api.md) - [Submit a share intent](https://developers.antavo.com/reference/post_v1-social-share-campaigns-share-intent.md): This API endpoint registers a customer’s intent to share content for an active campaign configured in the [Social Share Campaigns module](https://docs.antavo.com/docs/social-share-campaigns). Triggers the `share_intent_success` [event](https://developers.antavo.com/docs/internal-events#/share_intent_success) when a campaign match occurs. Call this endpoint when a customer clicks a share button on a content page. Include the customer ID, target platform, and URL to be shared. - [About Rewards API](https://developers.antavo.com/reference/about-rewards-api.md) - [List reward items](https://developers.antavo.com/reference/get_rewards.md): This endpoint returns a list of available rewards based on various query parameters. - [Retrieve reward-specific information](https://developers.antavo.com/reference/get_rewards-reward-id.md) - [Claims a specific reward (deprecated)](https://developers.antavo.com/reference/post_rewards-reward-id-claim.md): This endpoint is used to register that a customer has claimed a specific reward. This endpoint is not supported anymore. Please use the [reward endpoint](https://developers.antavo.com/reference/post_customers-customer-id-activities-rewards-reward-id-claim) of the Display API. - [About Offers API](https://developers.antavo.com/reference/about-offers-api.md) - [List customer-specific offers](https://developers.antavo.com/reference/post_offers.md): This API endpoint is used to submit the contents of a cart and receive any available offers on the products within. The Offers API request body consists of 4 components: - `cart`: The intended purchase items, recorded in the same format as an Antavo checkout event. - `customer`: The Antavo ID of the customer. - `store`: The Antavo ID of the store. This may result in store-specific offers if configured. - `eligible_only`: Restricts the returned offers to those available to the customer. - [About Coupons API](https://developers.antavo.com/reference/about-coupon-api.md) - [Query coupons independent of customer](https://developers.antavo.com/reference/get_coupons.md): Use this endpoint to query coupons within Antavo independently of customer data. This allows searching for coupons based on criteria such as coupon code and status, providing flexibility in managing coupon data. - [About Coupon Pools API](https://developers.antavo.com/reference/about-coupon-pools-api.md) - [Create a new coupon pool](https://developers.antavo.com/reference/post_v1-coupon-pools.md): This endpoint can be used to create a new coupon pool with the attributes provided in the request body. - [Update a coupon pool](https://developers.antavo.com/reference/post_v1-coupon-pools-coupon-pool-id-update.md): This endpoint can be used to update a coupon pool with the attributes provided in the request body. - [About Points Preview API](https://developers.antavo.com/reference/about-points-preview-api.md) - [Preview loyalty points based on submitted transaction data](https://developers.antavo.com/reference/post_extensions-automation-campaign-bonus.md): The Points Preview API enables querying before purchase to retrieve points awarded for purchases. The returned response includes the number of bonus points to be awarded by Campaign bonus campaign workflow nodes. This endpoint works with standard and multi-account configurations. - [About FAQ API](https://developers.antavo.com/reference/about-faq-api.md) - [List FAQ entries](https://developers.antavo.com/reference/get_faq.md): The FAQ API provides access to the questions and answers configured and managed in the Antavo FAQ module. A valid request returns an array of FAQ entries, ensuring no personally identifiable data of customers is included. - [About Leaderboard API (deprecated)](https://developers.antavo.com/reference/about-leaderboard-api.md) - [List best-performing customers](https://developers.antavo.com/reference/get_customers-leaderboard.md): The Leaderboard API allows you to retrieve rankings and scores of customers based on various metrics within the Antavo Loyalty Cloud. This API provides a way to showcase top performers, track progress, and foster competition among participants in your loyalty program. - [About Promotion Engine API](https://developers.antavo.com/reference/about-promotion-engine-api.md) - [Retrieve the list of promotions](https://developers.antavo.com/reference/get_v1-promotions.md): Fetches all promotions [configured](https://docs.antavo.com/docs/configuring-promotions) in your workspace. The response includes the full promotion objects with all settings as configured in the UI. Useful for listing, syncing, or debugging active campaign setups. No request parameters are required. - [Retrieve a specific promotion by ID](https://developers.antavo.com/reference/get_v1-promotion-promotionid.md): The endpoint provides detailed information about a specific promotion. - [Update the status of a promotion](https://developers.antavo.com/reference/post_v1-promotion-promotionid-status.md): This endpoint allows you to change the status of an existing promotion, enabling you to activate it, return it to draft for further editing, or archive it permanently. Note: once a promotion is archived, it cannot be changed back to any other state. - [Submit cart details and retrieve applicable promotions](https://developers.antavo.com/reference/post_v1-cart.md): Submit a cart to simulate promotion calculations based on its current contents and applied conditions. The engine will calculate which promotions are applicable to the provided cart and return: - Cart object - All matched promotions - The exact discounts applied - Adjusted unit prices (after discount) - Updated tax amounts - Total discount values The same `cartId` can be submitted multiple times to recalculate promotions when the cart changes. If any promotions have [application limits](https://docs.antavo.com/docs/configuring-promotions#application-limit-and-reset) and [locking periods](https://docs.antavo.com/docs/promotion-general-settings#locking-period), a reservation is made when the promotion is found applicable. If the cart is not checked out via the [/cart/finalize](https://developers.antavo.com/reference/post_v1-cart-finalize) endpoint before the lock expires, the reservation is released automatically. - [Finalize checkout with applied promotions](https://developers.antavo.com/reference/post_v1-cart-finalize.md): Submit a cart to apply final promotion calculations and complete the checkout process. Similar to [/cart](https://developers.antavo.com/reference/post_v1-cart), the engine will: - Calculate applicable promotions - Apply relevant discounts to items - Return the adjusted cart with pricing breakdowns Additionally, when submitting to the this endpoint, any promotion usage limits (if any) are enforced — meaning: - The promotions are applied and counted toward their application limits - The cart cannot be resubmitted with the same `cartId` This endpoint can be used directly without first calling the `/cart` endpoint if you don't require prior simulation. - [About Authentication API](https://developers.antavo.com/reference/about-authentication-api.md) - [Generate access token](https://developers.antavo.com/reference/post_v1-auth-token.md) - [About Async Events API](https://developers.antavo.com/reference/about-async-events-api.md) - [Submit an async event](https://developers.antavo.com/reference/post_v1-async-events.md): Use this endpoint to submit a single event for a specified customer asyncronously. The event is accepted immediately and processed in the background. This endpoint is compatible with the following event actions: - `point_add` - `checkout` - `checkout_item` - `checkout_update` - `checkout_update_item` - `checkout_accept` - `checkout_accept_item` - `checkout_reject` - `partial_refund` - `refund_item` - `refund` - `opt_in` - `opt_out` - `profile` The attributes provided in the `data` object are examples of `point_add` and `checkout` events. Refer to the [complete list of events](/docs/api-events) for all the attributes of the mentioned actions. Examples of event submission: - **Standard event submission**: Submit an event for the customer without any additional identifiers. - **Event submission with an external ID**: Include the `external_id` attribute to link the event with an external identifier of the customer from another system or database. - **Event submission with multiple accounts**: Specify multiple accounts by including their IDs in the 'account' attribute. This requires the Points economy module to be enabled.
*Note*: if no account is specified, the event will be assigned to the default account. - [Query the status of async event processing](https://developers.antavo.com/reference/get_v1-async-events-correlation-id.md): Use this endpoint to query the processing status of an event sent through the `v1/async/events` endpoint. Once the event has been processed, the response includes the customer information and the detailed event data. - [List of errors](https://developers.antavo.com/reference/errors.md) - [About Loyalty Read API](https://developers.antavo.com/reference/about-loyalty-read-api.md) - [Retrieve the list of customers](https://developers.antavo.com/reference/listcustomers.md): Returns a paginated list of customers, including standard customer fields and any custom customer attributes configured in the workspace. Results can be filtered and sorted by `created_at` and `status` customer attribute values. - [Retrieve detailed customer data of a single customer](https://developers.antavo.com/reference/getcustomer.md): Retrieves a customer by customer ID and returns the data associated with the customer. - [Retrieve the list of a customer's coupons](https://developers.antavo.com/reference/listcustomercoupons.md): Returns a paginated list of coupons associated with a specific customer. Results can be filtered by `status`, `claimed_at`, `redeemed_at`, `expiration_date` coupon attribute values, and sorted by `claimed_at`, `redeemed_at`, `expiration_date` values. - [Retrieve the list of a customer's events](https://developers.antavo.com/reference/listcustomerevents.md): Returns paginated list of events registered in the customer's events history. Results can be filtered and sorted by `action`, `date`, `account`, `expdate` and `points` event attribute values. - [Retrieve the list of a customer's transactions](https://developers.antavo.com/reference/listcustomertransactions.md): Returns a paginated list of transactions registered for the customer, including their items, associated events, point values, and current processing status. Results can be filtered and sorted by `status`, `checkout_date`, `auto_accept`, `account`, `points_rewarded`, `earned`, and `burned` transaction attribute values. ## Pages - [Errors](https://developers.antavo.com/page/test.md) ## Changelog - [Discontinuing unsigned API requests](https://developers.antavo.com/changelog/discontinuing-unsigned-api-requests.md)