Skip to content
BranchesTags

Repository files navigation

Talon.One Java SDK

Note

The next-generation version of this SDK is available here. The new SDK offers significant improvements, including immediate feature parity with the latest Talon.One product releases, as well as enhanced security and reliability.

This SDK supports all of the operations of Talon.One's Integration API and Management API.

If you use Maven, we also host Maven Artifacts.

Requirements

Building the API client library requires:

  1. Java 21+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
<groupId>one.talon</groupId>
<artifactId>talon-one-client</artifactId>
<version>15.0.0</version>
<scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "one.talon:talon-one-client:15.0.0"

Others

  1. Generate the JAR by running mvn clean package.
  2. Manually install the following JARs:
    • target/talon-one-client-2.0.0.jar
    • target/lib/*.jar

Determining the base URL of the endpoints

The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at https://yourbaseurl.talon.one, the URL for the Update customer session endpoint is https://yourbaseurl.talon.one/v2/customer_sessions/{Id}.

Getting started

Integration API

The following code shows an example of using the Integration API:

packagecom.example.consumer;
importcom.google.gson.Gson;
importone.talon.ApiClient;
importone.talon.api.IntegrationApi;
importone.talon.api.ManagementApi;
importone.talon.model.*;
importjava.util.*;
publicclassTalonApiTest {
publicstaticvoidmain(String[] args) {
Gsongson = newGson();
IntegrationApiiApi = newIntegrationApi(newApiClient("api_key_v1"));
// Setup: basePathiApi.getApiClient().setBasePath("https://yourbaseurl.talon.one"); // No trailing slash!// Setup: when using 'api_key_v1', set apiKey & apiKeyPrefix must be providediApi.getApiClient().setApiKeyPrefix("ApiKey-v1");
iApi.getApiClient().setApiKey("dbc644d33aa74d582bd9479c59e16f970fe13bf34a208c39d6c7fa7586968468");
try {
// Creating a cart item objectCartItemcartItem = newCartItem();
cartItem.setName("Hawaiian Pizza");
cartItem.setSku("pizza-x");
cartItem.setQuantity(1L);
cartItem.setPrice(newjava.math.BigDecimal("5.5"));
// Creating a customer session of V2NewCustomerSessionV2customerSession = newNewCustomerSessionV2();
customerSession.setProfileId("Cool_Dude");
customerSession.addCouponCodesItem("Cool-Summer!");
customerSession.addCartItemsItem(cartItem);
// Initiating integration request wrapping the customer session updateIntegrationRequestrequest = newIntegrationRequest()
.customerSession(customerSession)
// Optional parameter of requested information to be present on the response related to the customer session update
.responseContent(Arrays.asList(
IntegrationRequest.ResponseContentEnum.CUSTOMERSESSION,
IntegrationRequest.ResponseContentEnum.CUSTOMERPROFILE
));
// Flag to communicate whether the request is a "dry run"BooleandryRun = false;
// Create/update a customer session using `updateCustomerSessionV2` functionIntegrationStateV2is = iApi.updateCustomerSessionV2("deetdoot", request, dryRun, null);
System.out.println(is.toString());
// Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding propertiesfor (Effecteff : is.getEffects()) {
if (eff.getEffectType().equals("addLoyaltyPoints")) {
// Typecasting according to the specific effect typeAddLoyaltyPointsEffectPropsprops = gson.fromJson(
gson.toJson(eff.getProps()),
AddLoyaltyPointsEffectProps.class
);
// Access the specific effect's propertiesSystem.out.println(props.getName());
System.out.println(props.getProgramId());
System.out.println(props.getValue());
}
if (eff.getEffectType().equals("acceptCoupon")) {
// Typecasting according to the specific effect typeAcceptCouponEffectPropsprops = gson.fromJson(
gson.toJson(eff.getProps()),
AcceptCouponEffectProps.class
);
// work with AcceptCouponEffectProps' properties// ...
}
}
} catch (Exceptione) {
System.out.println(e);
}
}
}

Management API

The following code shows an example of using the Management API:

packagecom.example.consumer;
importone.talon.ApiClient;
importone.talon.api.IntegrationApi;
importone.talon.api.ManagementApi;
importone.talon.model.*;
publicclassTalonApiTest {
publicstaticvoidmain(String[] args) {
// Management API example to load application with id 7ManagementApimApi = newManagementApi(newApiClient("management_key"));
// Setup: basePathmApi.getApiClient().setBasePath("https://yourbaseurl.talon.one"); // No trailing slash!// Setup: when using 'management_key', set apiKey & apiKeyPrefix must be providedmApi.getApiClient().setApiKeyPrefix("ManagementKey-v1");
mApi.getApiClient().setApiKey("2f0dce055da01ae595005d7d79154bae7448d319d5fc7c5b2951fadd6ba1ea07");
try {
// Calling `getApplication` function with the desired id (7)Applicationapplication = mApi.getApplication(7L);
System.out.println(application.toString());
} catch (Exceptione) {
System.out.println(e);
}
}
}

Documentation for API endpoints

All URLs are relative to https://yourbaseurl.talon.one.

ClassMethodHTTP requestDescription
IntegrationApiactivateLoyaltyPointsPOST /v1/loyalty_programs/{loyaltyProgramId}/activate_pointsActivate loyalty points
IntegrationApibestPriorPricePOST /v1/best_prior_priceFetch best prior price
IntegrationApicreateAudienceV2POST /v2/audiencesCreate audience
IntegrationApicreateCouponReservationPOST /v1/coupon_reservations/{couponValue}Create coupon reservation
IntegrationApicreateReferralPOST /v1/referralsCreate referral code for an advocate
IntegrationApicreateReferralsForMultipleAdvocatesPOST /v1/referrals_for_multiple_advocatesCreate referral codes for multiple advocates
IntegrationApideleteAudienceMembershipsV2DELETE /v2/audiences/{audienceId}/membershipsDelete audience memberships
IntegrationApideleteAudienceV2DELETE /v2/audiences/{audienceId}Delete audience
IntegrationApideleteCouponReservationDELETE /v1/coupon_reservations/{couponValue}Delete coupon reservations
IntegrationApideleteCustomerDataDELETE /v1/customer_data/{integrationId}Delete customer's personal data
IntegrationApideleteLoyaltyTransactionsFromLedgersPOST /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/delete_transactionsDelete customer's transactions from loyalty ledgers
IntegrationApigenerateLoyaltyCardPOST /v1/loyalty_programs/{loyaltyProgramId}/cardsGenerate loyalty card
IntegrationApigetCustomerAchievementHistoryGET /v1/customer_profiles/{integrationId}/achievements/{achievementId}List customer's achievement history
IntegrationApigetCustomerAchievementsGET /v1/customer_profiles/{integrationId}/achievementsList customer's available achievements
IntegrationApigetCustomerInventoryGET /v1/customer_profiles/{integrationId}/inventoryList customer data
IntegrationApigetCustomerSessionGET /v2/customer_sessions/{customerSessionId}Get customer session
IntegrationApigetLoyaltyBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balancesGet customer's loyalty balances
IntegrationApigetLoyaltyCardBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balancesGet card's point balances
IntegrationApigetLoyaltyCardPointsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/pointsList card's unused loyalty points
IntegrationApigetLoyaltyCardTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactionsList card's transactions
IntegrationApigetLoyaltyProgramProfilePointsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/pointsList customer's unused loyalty points
IntegrationApigetLoyaltyProgramProfileTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactionsList customer's loyalty transactions
IntegrationApigetReservedCustomersGET /v1/coupon_reservations/customerprofiles/{couponValue}List customers that have this coupon reserved
IntegrationApiintegrationGetAllCampaignsGET /v1/integration/campaignsList all running campaigns
IntegrationApilinkLoyaltyCardToProfilePOST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profileLink customer profile to card
IntegrationApireopenCustomerSessionPUT /v2/customer_sessions/{customerSessionId}/reopenReopen customer session
IntegrationApireturnCartItemsPOST /v2/customer_sessions/{customerSessionId}/returnsReturn cart items
IntegrationApisyncCatalogPUT /v1/catalogs/{catalogId}/syncSync cart item catalog
IntegrationApitrackEventV2POST /v2/eventsTrack event
IntegrationApiunlinkLoyaltyCardFromProfilePOST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/unlink_profileUnlink customer profile from a loyalty card
IntegrationApiupdateAudienceCustomersAttributesPUT /v2/audience_customers/{audienceId}/attributesUpdate profile attributes for all customers in audience
IntegrationApiupdateAudienceV2PUT /v2/audiences/{audienceId}Update audience name
IntegrationApiupdateCustomerProfileAudiencesPOST /v2/customer_audiencesUpdate multiple customer profiles' audiences
IntegrationApiupdateCustomerProfileV2PUT /v2/customer_profiles/{integrationId}Update customer profile
IntegrationApiupdateCustomerProfilesV2PUT /v2/customer_profilesUpdate multiple customer profiles
IntegrationApiupdateCustomerSessionV2PUT /v2/customer_sessions/{customerSessionId}Update customer session
ManagementApiactivateUserByEmailPOST /v1/users/activateEnable user by email address
ManagementApiaddLoyaltyCardPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_pointsAdd points to card
ManagementApiaddLoyaltyPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_pointsAdd points to customer profile
ManagementApicopyCampaignToApplicationsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/copyCopy the campaign into the specified Application
ManagementApicreateAccountCollectionPOST /v1/collectionsCreate account-level collection
ManagementApicreateAchievementPOST /v1/applications/{applicationId}/campaigns/{campaignId}/achievementsCreate achievement
ManagementApicreateAdditionalCostPOST /v1/additional_costsCreate additional cost
ManagementApicreateAttributePOST /v1/attributesCreate custom attribute
ManagementApicreateBatchLoyaltyCardsPOST /v1/loyalty_programs/{loyaltyProgramId}/cards/batchCreate loyalty cards
ManagementApicreateCampaignFromTemplatePOST /v1/applications/{applicationId}/create_campaign_from_templateCreate campaign from campaign template
ManagementApicreateCampaignStoreBudgetPOST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgetsCreate campaign store budget
ManagementApicreateCollectionPOST /v1/applications/{applicationId}/campaigns/{campaignId}/collectionsCreate campaign-level collection
ManagementApicreateCouponsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/couponsCreate coupons
ManagementApicreateCouponsAsyncPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_asyncCreate coupons asynchronously
ManagementApicreateCouponsDeletionJobPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobsCreates a coupon deletion job
ManagementApicreateCouponsForMultipleRecipientsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipientsCreate coupons for multiple recipients
ManagementApicreateInviteEmailPOST /v1/invite_emailsResend invitation email
ManagementApicreateInviteV2POST /v2/invitesInvite user
ManagementApicreatePasswordRecoveryEmailPOST /v1/password_recovery_emailsRequest a password reset
ManagementApicreateSessionPOST /v1/sessionsCreate session
ManagementApicreateStorePOST /v1/applications/{applicationId}/storesCreate store
ManagementApideactivateUserByEmailPOST /v1/users/deactivateDisable user by email address
ManagementApideductLoyaltyCardPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_pointsDeduct points from card
ManagementApideleteAccountCollectionDELETE /v1/collections/{collectionId}Delete account-level collection
ManagementApideleteAchievementDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}Delete achievement
ManagementApideleteCampaignDELETE /v1/applications/{applicationId}/campaigns/{campaignId}Delete campaign
ManagementApideleteCampaignStoreBudgetsDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgetsDelete campaign store budgets
ManagementApideleteCollectionDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Delete campaign-level collection
ManagementApideleteCouponDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}Delete coupon
ManagementApideleteCouponsDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/couponsDelete coupons
ManagementApideleteLoyaltyCardDELETE /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Delete loyalty card
ManagementApideleteReferralDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}Delete referral
ManagementApideleteStoreDELETE /v1/applications/{applicationId}/stores/{storeId}Delete store
ManagementApideleteUserDELETE /v1/users/{userId}Delete user
ManagementApideleteUserByEmailPOST /v1/users/deleteDelete user by email address
ManagementApidestroySessionDELETE /v1/sessionsDestroy session
ManagementApidisconnectCampaignStoresDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/storesDisconnect stores
ManagementApiexportAccountCollectionItemsGET /v1/collections/{collectionId}/exportExport account-level collection's items
ManagementApiexportAchievementsGET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/exportExport achievement customer data
ManagementApiexportApplicationCampaignAnalyticsGET /v1/applications/{applicationId}/campaign_analytics/exportExport Application analytics aggregated by campaign
ManagementApiexportAudiencesMembershipsGET /v1/audiences/{audienceId}/memberships/exportExport audience members
ManagementApiexportCampaignStoreBudgetsGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/exportExport campaign store budgets
ManagementApiexportCampaignStoresGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/exportExport stores
ManagementApiexportCampaignValueMapGET /v1/applications/{applicationId}/campaigns/{campaignId}/value_maps/{valueMapId}/exportExport campaign value map
ManagementApiexportCollectionItemsGET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/exportExport campaign-level collection's items
ManagementApiexportCouponsGET /v1/applications/{applicationId}/export_couponsExport coupons
ManagementApiexportCustomerSessionsGET /v1/applications/{applicationId}/export_customer_sessionsExport customer sessions
ManagementApiexportCustomersTiersGET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiersExport customers' tier data
ManagementApiexportEffectsGET /v1/applications/{applicationId}/export_effectsExport triggered effects
ManagementApiexportLoyaltyBalanceGET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balanceExport customer loyalty balance to CSV
ManagementApiexportLoyaltyBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balancesExport customer loyalty balances
ManagementApiexportLoyaltyCardBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/export_card_balancesExport all card transaction logs
ManagementApiexportLoyaltyCardLedgerGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_logExport card's ledger log
ManagementApiexportLoyaltyCardsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/exportExport loyalty cards
ManagementApiexportLoyaltyJoinDatesGET /v1/loyalty_programs/{loyaltyProgramId}/export_join_datesExport customers' loyalty program join dates
ManagementApiexportLoyaltyLedgerGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_logExport customer's transaction logs
ManagementApiexportPoolGiveawaysGET /v1/giveaways/pools/{poolId}/exportExport giveaway codes of a giveaway pool
ManagementApiexportReferralsGET /v1/applications/{applicationId}/export_referralsExport referrals
ManagementApigenerateCouponRejectionsGET /v1/coupon_rejectionsSummarize coupon redemption failures in session
ManagementApigetAccessLogsWithoutTotalCountGET /v1/applications/{applicationId}/access_logs/no_totalGet access logs for Application
ManagementApigetAccountGET /v1/accounts/{accountId}Get account details
ManagementApigetAccountAnalyticsGET /v1/accounts/{accountId}/analyticsGet account analytics
ManagementApigetAccountCollectionGET /v1/collections/{collectionId}Get account-level collection
ManagementApigetAchievementGET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}Get achievement
ManagementApigetAdditionalCostGET /v1/additional_costs/{additionalCostId}Get additional cost
ManagementApigetAdditionalCostsGET /v1/additional_costsList additional costs
ManagementApigetApplicationGET /v1/applications/{applicationId}Get Application
ManagementApigetApplicationApiHealthGET /v1/applications/{applicationId}/health_reportGet Application health
ManagementApigetApplicationCartItemFilterExpressionGET /v1/applications/{applicationId}/cart_item_filters/{cartItemFilterId}/expressions/{expressionId}Get Application cart item filter expression
ManagementApigetApplicationCustomerGET /v1/applications/{applicationId}/customers/{customerId}Get application's customer
ManagementApigetApplicationCustomerFriendsGET /v1/applications/{applicationId}/profile/{integrationId}/friendsList friends referred by customer profile
ManagementApigetApplicationCustomersGET /v1/applications/{applicationId}/customersList application's customers
ManagementApigetApplicationCustomersByAttributesPOST /v1/applications/{applicationId}/customer_searchList application customers matching the given attributes
ManagementApigetApplicationEventTypesGET /v1/applications/{applicationId}/event_typesList Applications event types
ManagementApigetApplicationEventsWithoutTotalCountGET /v1/applications/{applicationId}/events/no_totalList Applications events
ManagementApigetApplicationSessionGET /v1/applications/{applicationId}/sessions/{sessionId}Get Application session
ManagementApigetApplicationSessionsGET /v1/applications/{applicationId}/sessionsList Application sessions
ManagementApigetApplicationsGET /v1/applicationsList Applications
ManagementApigetAttributeGET /v1/attributes/{attributeId}Get custom attribute
ManagementApigetAttributesGET /v1/attributesList custom attributes
ManagementApigetAudienceMembershipsGET /v1/audiences/{audienceId}/membershipsList audience members
ManagementApigetAudiencesGET /v1/audiencesList audiences
ManagementApigetAudiencesAnalyticsGET /v1/audiences/analyticsList audience analytics
ManagementApigetCampaignGET /v1/applications/{applicationId}/campaigns/{campaignId}Get campaign
ManagementApigetCampaignAnalyticsGET /v1/applications/{applicationId}/campaigns/{campaignId}/analyticsGet analytics of campaigns
ManagementApigetCampaignByAttributesPOST /v1/applications/{applicationId}/campaigns_searchList campaigns that match the given attributes
ManagementApigetCampaignGroupGET /v1/campaign_groups/{campaignGroupId}Get campaign access group
ManagementApigetCampaignGroupsGET /v1/campaign_groupsList campaign access groups
ManagementApigetCampaignTemplatesGET /v1/campaign_templatesList campaign templates
ManagementApigetCampaignsGET /v1/applications/{applicationId}/campaignsList campaigns
ManagementApigetChangesGET /v1/changesGet audit logs for an account
ManagementApigetCollectionGET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Get campaign-level collection
ManagementApigetCollectionItemsGET /v1/collections/{collectionId}/itemsGet collection items
ManagementApigetCouponsWithoutTotalCountGET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_totalList coupons
ManagementApigetCustomerActivityReportGET /v1/applications/{applicationId}/customer_activity_reports/{customerId}Get customer's activity report
ManagementApigetCustomerActivityReportsWithoutTotalCountGET /v1/applications/{applicationId}/customer_activity_reports/no_totalGet Activity Reports for Application Customers
ManagementApigetCustomerAnalyticsGET /v1/applications/{applicationId}/customers/{customerId}/analyticsGet customer's analytics report
ManagementApigetCustomerProfileGET /v1/customers/{customerId}Get customer profile
ManagementApigetCustomerProfileAchievementProgressGET /v1/applications/{applicationId}/achievement_progress/{integrationId}List customer achievements
ManagementApigetCustomerProfilesGET /v1/customers/no_totalList customer profiles
ManagementApigetCustomersByAttributesPOST /v1/customer_search/no_totalList customer profiles matching the given attributes
ManagementApigetDashboardStatisticsGET /v1/loyalty_programs/{loyaltyProgramId}/dashboardGet statistics for loyalty dashboard
ManagementApigetEventTypesGET /v1/event_typesList event types
ManagementApigetExperimentGET /v1/applications/{applicationId}/experiments/{experimentId}Get experiment in Application
ManagementApigetExportsGET /v1/exportsGet exports
ManagementApigetLoyaltyCardGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Get loyalty card
ManagementApigetLoyaltyCardTransactionLogsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logsList card's transactions
ManagementApigetLoyaltyCardsGET /v1/loyalty_programs/{loyaltyProgramId}/cardsList loyalty cards
ManagementApigetLoyaltyLedgerBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balancesGet customer's loyalty balances
ManagementApigetLoyaltyPointsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}Get customer's full loyalty ledger
ManagementApigetLoyaltyProgramGET /v1/loyalty_programs/{loyaltyProgramId}Get loyalty program
ManagementApigetLoyaltyProgramProfileLedgerTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactionsList customer's loyalty transactions
ManagementApigetLoyaltyProgramTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/transactionsList loyalty program transactions
ManagementApigetLoyaltyProgramsGET /v1/loyalty_programsList loyalty programs
ManagementApigetLoyaltyStatisticsGET /v1/loyalty_programs/{loyaltyProgramId}/statisticsGet loyalty program statistics
ManagementApigetMessageLogsGET /v1/message_logsList message log entries
ManagementApigetReferralsWithoutTotalCountGET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_totalList referrals
ManagementApigetRoleV2GET /v2/roles/{roleId}Get role
ManagementApigetRulesetGET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}Get ruleset
ManagementApigetRulesetsGET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesetsList campaign rulesets
ManagementApigetStoreGET /v1/applications/{applicationId}/stores/{storeId}Get store
ManagementApigetUserGET /v1/users/{userId}Get user
ManagementApigetUsersGET /v1/usersList users in account
ManagementApigetWebhookGET /v1/webhooks/{webhookId}Get webhook
ManagementApigetWebhooksGET /v1/webhooksList webhooks
ManagementApiimportAccountCollectionPOST /v1/collections/{collectionId}/importImport data into existing account-level collection
ManagementApiimportAllowedListPOST /v1/attributes/{attributeId}/allowed_list/importImport allowed values for attribute
ManagementApiimportAudiencesMembershipsPOST /v1/audiences/{audienceId}/memberships/importImport audience members
ManagementApiimportCampaignStoreBudgetPOST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/importImport campaign store budgets
ManagementApiimportCampaignStoresPOST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/importImport stores
ManagementApiimportCollectionPOST /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/importImport data into existing campaign-level collection
ManagementApiimportCouponsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/import_couponsImport coupons
ManagementApiimportLoyaltyCardsPOST /v1/loyalty_programs/{loyaltyProgramId}/import_cardsImport loyalty cards
ManagementApiimportLoyaltyCustomersTiersPOST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiersImport customers into loyalty tiers
ManagementApiimportLoyaltyPointsPOST /v1/loyalty_programs/{loyaltyProgramId}/import_pointsImport loyalty points
ManagementApiimportPoolGiveawaysPOST /v1/giveaways/pools/{poolId}/importImport giveaway codes into a giveaway pool
ManagementApiimportReferralsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referralsImport referrals
ManagementApiinviteUserExternalPOST /v1/users/inviteInvite user from identity provider
ManagementApilistAccountCollectionsGET /v1/collectionsList collections in account
ManagementApilistAchievementsGET /v1/applications/{applicationId}/campaigns/{campaignId}/achievementsList achievements
ManagementApilistAllRolesV2GET /v2/rolesList roles
ManagementApilistApplicationCartItemFiltersGET /v1/applications/{applicationId}/cart_item_filtersList Application cart item filters
ManagementApilistCampaignStoreBudgetLimitsGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgetsList campaign store budget limits
ManagementApilistCatalogItemsGET /v1/catalogs/{catalogId}/itemsList items in a catalog
ManagementApilistCollectionsGET /v1/applications/{applicationId}/campaigns/{campaignId}/collectionsList collections in campaign
ManagementApilistCollectionsInApplicationGET /v1/applications/{applicationId}/collectionsList collections in Application
ManagementApilistExperimentsGET /v1/applications/{applicationId}/experimentsList experiments
ManagementApilistStoresGET /v1/applications/{applicationId}/storesList stores
ManagementApioktaEventHandlerChallengeGET /v1/provisioning/oktaValidate Okta API ownership
ManagementApipriceHistoryPOST /v1/applications/{applicationId}/price_historyGet summary of price history
ManagementApiremoveLoyaltyPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_pointsDeduct points from customer profile
ManagementApiresetPasswordPOST /v1/reset_passwordReset password
ManagementApiscimCreateGroupPOST /v1/provisioning/scim/GroupsCreate SCIM group
ManagementApiscimCreateUserPOST /v1/provisioning/scim/UsersCreate SCIM user
ManagementApiscimDeleteGroupDELETE /v1/provisioning/scim/Groups/{groupId}Delete SCIM group
ManagementApiscimDeleteUserDELETE /v1/provisioning/scim/Users/{userId}Delete SCIM user
ManagementApiscimGetGroupGET /v1/provisioning/scim/Groups/{groupId}Get SCIM group
ManagementApiscimGetGroupsGET /v1/provisioning/scim/GroupsList SCIM groups
ManagementApiscimGetResourceTypesGET /v1/provisioning/scim/ResourceTypesList supported SCIM resource types
ManagementApiscimGetSchemasGET /v1/provisioning/scim/SchemasList supported SCIM schemas
ManagementApiscimGetServiceProviderConfigGET /v1/provisioning/scim/ServiceProviderConfigGet SCIM service provider configuration
ManagementApiscimGetUserGET /v1/provisioning/scim/Users/{userId}Get SCIM user
ManagementApiscimGetUsersGET /v1/provisioning/scim/UsersList SCIM users
ManagementApiscimPatchGroupPATCH /v1/provisioning/scim/Groups/{groupId}Update SCIM group attributes
ManagementApiscimPatchUserPATCH /v1/provisioning/scim/Users/{userId}Update SCIM user attributes
ManagementApiscimReplaceGroupAttributesPUT /v1/provisioning/scim/Groups/{groupId}Update SCIM group
ManagementApiscimReplaceUserAttributesPUT /v1/provisioning/scim/Users/{userId}Update SCIM user
ManagementApisearchCouponsAdvancedApplicationWideWithoutTotalCountPOST /v1/applications/{applicationId}/coupons_search_advanced/no_totalList coupons that match the given attributes (without total count)
ManagementApisearchCouponsAdvancedWithoutTotalCountPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_totalList coupons that match the given attributes in campaign (without total count)
ManagementApisummarizeCampaignStoreBudgetGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summaryGet summary of campaign store budgets
ManagementApitransferLoyaltyCardPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transferTransfer card data
ManagementApiupdateAccountCollectionPUT /v1/collections/{collectionId}Update account-level collection
ManagementApiupdateAchievementPUT /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}Update achievement
ManagementApiupdateAdditionalCostPUT /v1/additional_costs/{additionalCostId}Update additional cost
ManagementApiupdateAttributePUT /v1/attributes/{attributeId}Update custom attribute
ManagementApiupdateCampaignPUT /v1/applications/{applicationId}/campaigns/{campaignId}Update campaign
ManagementApiupdateCollectionPUT /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Update campaign-level collection's description
ManagementApiupdateCouponPUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}Update coupon
ManagementApiupdateCouponBatchPUT /v1/applications/{applicationId}/campaigns/{campaignId}/couponsUpdate coupons
ManagementApiupdateLoyaltyCardPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Update loyalty card
ManagementApiupdateReferralPUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}Update referral
ManagementApiupdateRoleV2PUT /v2/roles/{roleId}Update role
ManagementApiupdateStorePUT /v1/applications/{applicationId}/stores/{storeId}Update store
ManagementApiupdateUserPUT /v1/users/{userId}Update user

Documentation for models

Authorization

Authentication schemes defined for the API:

api_key_v1

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

management_key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

manager_auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

About

Legacy version of the Talon.One Java SDK.

docs.talon.one/docs/dev/sdks/java

Topics

couponsjavaloyaltyprogramreferral-platformsdktalon-one

Resources

Readme
Activity
Custom properties

Stars

5 stars

Watchers

6 watching

Forks

6 forks
Report repository

Releases

Used by

Contributors

Languages