diff --git a/README.md b/README.md
index 7ff38926..81b6e60d 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ Add this dependency to your project's POM:
one.talon
talon-one-client
- 14.3.0
+ 15.0.0
compile
```
@@ -50,7 +50,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:
```groovy
-compile "one.talon:talon-one-client:14.3.0"
+compile "one.talon:talon-one-client:15.0.0"
```
### Others
@@ -219,8 +219,8 @@ Class | Method | HTTP request | Description
*IntegrationApi* | [**getLoyaltyProgramProfilePoints**](docs/IntegrationApi.md#getLoyaltyProgramProfilePoints) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points | List customer's unused loyalty points
*IntegrationApi* | [**getLoyaltyProgramProfileTransactions**](docs/IntegrationApi.md#getLoyaltyProgramProfileTransactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions
*IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved
+*IntegrationApi* | [**integrationGetAllCampaigns**](docs/IntegrationApi.md#integrationGetAllCampaigns) | **GET** /v1/integration/campaigns | List all running campaigns
*IntegrationApi* | [**linkLoyaltyCardToProfile**](docs/IntegrationApi.md#linkLoyaltyCardToProfile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card
-*IntegrationApi* | [**priceHistory**](docs/IntegrationApi.md#priceHistory) | **POST** /v1/best_prior_price_history | Get summary of price history
*IntegrationApi* | [**reopenCustomerSession**](docs/IntegrationApi.md#reopenCustomerSession) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session
*IntegrationApi* | [**returnCartItems**](docs/IntegrationApi.md#returnCartItems) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items
*IntegrationApi* | [**syncCatalog**](docs/IntegrationApi.md#syncCatalog) | **PUT** /v1/catalogs/{catalogId}/sync | Sync cart item catalog
@@ -271,9 +271,11 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**disconnectCampaignStores**](docs/ManagementApi.md#disconnectCampaignStores) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores
*ManagementApi* | [**exportAccountCollectionItems**](docs/ManagementApi.md#exportAccountCollectionItems) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
*ManagementApi* | [**exportAchievements**](docs/ManagementApi.md#exportAchievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
+*ManagementApi* | [**exportApplicationCampaignAnalytics**](docs/ManagementApi.md#exportApplicationCampaignAnalytics) | **GET** /v1/applications/{applicationId}/campaign_analytics/export | Export Application analytics aggregated by campaign
*ManagementApi* | [**exportAudiencesMemberships**](docs/ManagementApi.md#exportAudiencesMemberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
*ManagementApi* | [**exportCampaignStoreBudgets**](docs/ManagementApi.md#exportCampaignStoreBudgets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export | Export campaign store budgets
*ManagementApi* | [**exportCampaignStores**](docs/ManagementApi.md#exportCampaignStores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
+*ManagementApi* | [**exportCampaignValueMap**](docs/ManagementApi.md#exportCampaignValueMap) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/value_maps/{valueMapId}/export | Export campaign value map
*ManagementApi* | [**exportCollectionItems**](docs/ManagementApi.md#exportCollectionItems) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
*ManagementApi* | [**exportCoupons**](docs/ManagementApi.md#exportCoupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
*ManagementApi* | [**exportCustomerSessions**](docs/ManagementApi.md#exportCustomerSessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
@@ -298,6 +300,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**getAdditionalCosts**](docs/ManagementApi.md#getAdditionalCosts) | **GET** /v1/additional_costs | List additional costs
*ManagementApi* | [**getApplication**](docs/ManagementApi.md#getApplication) | **GET** /v1/applications/{applicationId} | Get Application
*ManagementApi* | [**getApplicationApiHealth**](docs/ManagementApi.md#getApplicationApiHealth) | **GET** /v1/applications/{applicationId}/health_report | Get Application health
+*ManagementApi* | [**getApplicationCartItemFilterExpression**](docs/ManagementApi.md#getApplicationCartItemFilterExpression) | **GET** /v1/applications/{applicationId}/cart_item_filters/{cartItemFilterId}/expressions/{expressionId} | Get Application cart item filter expression
*ManagementApi* | [**getApplicationCustomer**](docs/ManagementApi.md#getApplicationCustomer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer
*ManagementApi* | [**getApplicationCustomerFriends**](docs/ManagementApi.md#getApplicationCustomerFriends) | **GET** /v1/applications/{applicationId}/profile/{integrationId}/friends | List friends referred by customer profile
*ManagementApi* | [**getApplicationCustomers**](docs/ManagementApi.md#getApplicationCustomers) | **GET** /v1/applications/{applicationId}/customers | List application's customers
@@ -370,6 +373,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**listAccountCollections**](docs/ManagementApi.md#listAccountCollections) | **GET** /v1/collections | List collections in account
*ManagementApi* | [**listAchievements**](docs/ManagementApi.md#listAchievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
*ManagementApi* | [**listAllRolesV2**](docs/ManagementApi.md#listAllRolesV2) | **GET** /v2/roles | List roles
+*ManagementApi* | [**listApplicationCartItemFilters**](docs/ManagementApi.md#listApplicationCartItemFilters) | **GET** /v1/applications/{applicationId}/cart_item_filters | List Application cart item filters
*ManagementApi* | [**listCampaignStoreBudgetLimits**](docs/ManagementApi.md#listCampaignStoreBudgetLimits) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
*ManagementApi* | [**listCatalogItems**](docs/ManagementApi.md#listCatalogItems) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
*ManagementApi* | [**listCollections**](docs/ManagementApi.md#listCollections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
@@ -377,6 +381,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**listExperiments**](docs/ManagementApi.md#listExperiments) | **GET** /v1/applications/{applicationId}/experiments | List experiments
*ManagementApi* | [**listStores**](docs/ManagementApi.md#listStores) | **GET** /v1/applications/{applicationId}/stores | List stores
*ManagementApi* | [**oktaEventHandlerChallenge**](docs/ManagementApi.md#oktaEventHandlerChallenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
+*ManagementApi* | [**priceHistory**](docs/ManagementApi.md#priceHistory) | **POST** /v1/applications/{applicationId}/price_history | Get summary of price history
*ManagementApi* | [**removeLoyaltyPoints**](docs/ManagementApi.md#removeLoyaltyPoints) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
*ManagementApi* | [**resetPassword**](docs/ManagementApi.md#resetPassword) | **POST** /v1/reset_password | Reset password
*ManagementApi* | [**scimCreateGroup**](docs/ManagementApi.md#scimCreateGroup) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
@@ -431,10 +436,14 @@ Class | Method | HTTP request | Description
- [AccountLimits](docs/AccountLimits.md)
- [Achievement](docs/Achievement.md)
- [AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md)
+- [AchievementAdditionalPropertiesV2](docs/AchievementAdditionalPropertiesV2.md)
- [AchievementBase](docs/AchievementBase.md)
+- [AchievementBaseV2](docs/AchievementBaseV2.md)
- [AchievementProgress](docs/AchievementProgress.md)
- [AchievementProgressWithDefinition](docs/AchievementProgressWithDefinition.md)
+- [AchievementReference](docs/AchievementReference.md)
- [AchievementStatusEntry](docs/AchievementStatusEntry.md)
+- [AchievementV2](docs/AchievementV2.md)
- [ActivateLoyaltyPoints](docs/ActivateLoyaltyPoints.md)
- [ActivateLoyaltyPointsResponse](docs/ActivateLoyaltyPointsResponse.md)
- [AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
@@ -590,8 +599,10 @@ Class | Method | HTTP request | Description
- [CouponsNotificationData](docs/CouponsNotificationData.md)
- [CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md)
- [CreateAchievement](docs/CreateAchievement.md)
+- [CreateAchievementV2](docs/CreateAchievementV2.md)
- [CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
- [CreateCouponData](docs/CreateCouponData.md)
+- [CreateMCPKey](docs/CreateMCPKey.md)
- [CreateManagementKey](docs/CreateManagementKey.md)
- [CreateTemplateCampaign](docs/CreateTemplateCampaign.md)
- [CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md)
@@ -618,6 +629,9 @@ Class | Method | HTTP request | Description
- [Effect](docs/Effect.md)
- [EffectEntity](docs/EffectEntity.md)
- [EmailEntity](docs/EmailEntity.md)
+- [EmbeddedAnalyticsConfiguration](docs/EmbeddedAnalyticsConfiguration.md)
+- [EmbeddedAnalyticsConfigurationDashboards](docs/EmbeddedAnalyticsConfigurationDashboards.md)
+- [EmbeddedDashboardConfiguration](docs/EmbeddedDashboardConfiguration.md)
- [Endpoint](docs/Endpoint.md)
- [Entity](docs/Entity.md)
- [EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md)
@@ -636,11 +650,20 @@ Class | Method | HTTP request | Description
- [ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
- [ExperimentCopy](docs/ExperimentCopy.md)
- [ExperimentCopyExperiment](docs/ExperimentCopyExperiment.md)
+- [ExperimentListResults](docs/ExperimentListResults.md)
+- [ExperimentListResultsRequest](docs/ExperimentListResultsRequest.md)
+- [ExperimentResult](docs/ExperimentResult.md)
- [ExperimentResults](docs/ExperimentResults.md)
+- [ExperimentSegmentInsight](docs/ExperimentSegmentInsight.md)
+- [ExperimentSegmentInsightMetric](docs/ExperimentSegmentInsightMetric.md)
+- [ExperimentSegmentInsightVariant](docs/ExperimentSegmentInsightVariant.md)
+- [ExperimentSegmentInsights](docs/ExperimentSegmentInsights.md)
- [ExperimentVariant](docs/ExperimentVariant.md)
- [ExperimentVariantAllocation](docs/ExperimentVariantAllocation.md)
- [ExperimentVariantResult](docs/ExperimentVariantResult.md)
- [ExperimentVariantResultConfidence](docs/ExperimentVariantResultConfidence.md)
+- [ExperimentVerdict](docs/ExperimentVerdict.md)
+- [ExperimentVerdictResponse](docs/ExperimentVerdictResponse.md)
- [ExpiringCardPointsData](docs/ExpiringCardPointsData.md)
- [ExpiringCardPointsNotification](docs/ExpiringCardPointsNotification.md)
- [ExpiringCouponsData](docs/ExpiringCouponsData.md)
@@ -671,6 +694,8 @@ Class | Method | HTTP request | Description
- [GenerateUserSessionSummary](docs/GenerateUserSessionSummary.md)
- [GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
- [Giveaway](docs/Giveaway.md)
+- [GiveawayPoolNotification](docs/GiveawayPoolNotification.md)
+- [GiveawayPoolNotificationData](docs/GiveawayPoolNotificationData.md)
- [GiveawaysPool](docs/GiveawaysPool.md)
- [HiddenConditionsEffects](docs/HiddenConditionsEffects.md)
- [History](docs/History.md)
@@ -726,11 +751,14 @@ Class | Method | HTTP request | Description
- [InlineResponse2005](docs/InlineResponse2005.md)
- [InlineResponse20050](docs/InlineResponse20050.md)
- [InlineResponse20051](docs/InlineResponse20051.md)
+- [InlineResponse20052](docs/InlineResponse20052.md)
+- [InlineResponse20053](docs/InlineResponse20053.md)
- [InlineResponse2006](docs/InlineResponse2006.md)
- [InlineResponse2007](docs/InlineResponse2007.md)
- [InlineResponse2008](docs/InlineResponse2008.md)
- [InlineResponse2009](docs/InlineResponse2009.md)
- [InlineResponse201](docs/InlineResponse201.md)
+- [IntegrationCampaign](docs/IntegrationCampaign.md)
- [IntegrationCoupon](docs/IntegrationCoupon.md)
- [IntegrationCustomerProfileAudienceRequest](docs/IntegrationCustomerProfileAudienceRequest.md)
- [IntegrationCustomerProfileAudienceRequestItem](docs/IntegrationCustomerProfileAudienceRequestItem.md)
@@ -741,6 +769,21 @@ Class | Method | HTTP request | Description
- [IntegrationEventV2Response](docs/IntegrationEventV2Response.md)
- [IntegrationEventV3Request](docs/IntegrationEventV3Request.md)
- [IntegrationEventV3Response](docs/IntegrationEventV3Response.md)
+- [IntegrationHubConfig](docs/IntegrationHubConfig.md)
+- [IntegrationHubEventPayloadCouponBasedNotifications](docs/IntegrationHubEventPayloadCouponBasedNotifications.md)
+- [IntegrationHubEventPayloadCouponBasedNotificationsLimits](docs/IntegrationHubEventPayloadCouponBasedNotificationsLimits.md)
+- [IntegrationHubEventPayloadLoyaltyProfileBasedNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedNotification.md)
+- [IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotification.md)
+- [IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction](docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md)
+- [IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md)
+- [IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification](docs/IntegrationHubEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md)
+- [IntegrationHubEventRecord](docs/IntegrationHubEventRecord.md)
+- [IntegrationHubFlow](docs/IntegrationHubFlow.md)
+- [IntegrationHubFlowConfig](docs/IntegrationHubFlowConfig.md)
+- [IntegrationHubFlowConfigResponse](docs/IntegrationHubFlowConfigResponse.md)
+- [IntegrationHubFlowResponse](docs/IntegrationHubFlowResponse.md)
+- [IntegrationHubFlowWithConfig](docs/IntegrationHubFlowWithConfig.md)
+- [IntegrationHubPaginatedEventPayload](docs/IntegrationHubPaginatedEventPayload.md)
- [IntegrationProfileEntity](docs/IntegrationProfileEntity.md)
- [IntegrationProfileEntityV3](docs/IntegrationProfileEntityV3.md)
- [IntegrationRequest](docs/IntegrationRequest.md)
@@ -789,6 +832,7 @@ Class | Method | HTTP request | Description
- [LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md)
- [LoyaltySubLedger](docs/LoyaltySubLedger.md)
- [LoyaltyTier](docs/LoyaltyTier.md)
+- [MCPKey](docs/MCPKey.md)
- [ManagementKey](docs/ManagementKey.md)
- [ManagerConfig](docs/ManagerConfig.md)
- [MessageLogEntries](docs/MessageLogEntries.md)
@@ -851,6 +895,7 @@ Class | Method | HTTP request | Description
- [NewInviteEmail](docs/NewInviteEmail.md)
- [NewLoyaltyProgram](docs/NewLoyaltyProgram.md)
- [NewLoyaltyTier](docs/NewLoyaltyTier.md)
+- [NewMCPKey](docs/NewMCPKey.md)
- [NewManagementKey](docs/NewManagementKey.md)
- [NewMessageTest](docs/NewMessageTest.md)
- [NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md)
@@ -865,6 +910,7 @@ Class | Method | HTTP request | Description
- [NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md)
- [NewReturn](docs/NewReturn.md)
- [NewRevisionVersion](docs/NewRevisionVersion.md)
+- [NewReward](docs/NewReward.md)
- [NewRole](docs/NewRole.md)
- [NewRoleV2](docs/NewRoleV2.md)
- [NewRuleset](docs/NewRuleset.md)
@@ -905,21 +951,6 @@ Class | Method | HTTP request | Description
- [PriceType](docs/PriceType.md)
- [PriceTypeReferenceDetail](docs/PriceTypeReferenceDetail.md)
- [PriceTypeReferences](docs/PriceTypeReferences.md)
-- [PrismaticConfig](docs/PrismaticConfig.md)
-- [PrismaticEventPayloadCouponBasedNotifications](docs/PrismaticEventPayloadCouponBasedNotifications.md)
-- [PrismaticEventPayloadCouponBasedNotificationsLimits](docs/PrismaticEventPayloadCouponBasedNotificationsLimits.md)
-- [PrismaticEventPayloadLoyaltyProfileBasedNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedNotification.md)
-- [PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotification.md)
-- [PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction](docs/PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md)
-- [PrismaticEventPayloadLoyaltyProfileBasedTierDowngradeNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md)
-- [PrismaticEventPayloadLoyaltyProfileBasedTierUpgradeNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md)
-- [PrismaticEventRecord](docs/PrismaticEventRecord.md)
-- [PrismaticFlow](docs/PrismaticFlow.md)
-- [PrismaticFlowConfig](docs/PrismaticFlowConfig.md)
-- [PrismaticFlowConfigResponse](docs/PrismaticFlowConfigResponse.md)
-- [PrismaticFlowResponse](docs/PrismaticFlowResponse.md)
-- [PrismaticFlowWithConfig](docs/PrismaticFlowWithConfig.md)
-- [PrismaticPaginatedEventPayload](docs/PrismaticPaginatedEventPayload.md)
- [Product](docs/Product.md)
- [ProductSearchMatch](docs/ProductSearchMatch.md)
- [ProductUnitAnalytics](docs/ProductUnitAnalytics.md)
@@ -947,6 +978,7 @@ Class | Method | HTTP request | Description
- [RevisionActivation](docs/RevisionActivation.md)
- [RevisionActivationRequest](docs/RevisionActivationRequest.md)
- [RevisionVersion](docs/RevisionVersion.md)
+- [Reward](docs/Reward.md)
- [Role](docs/Role.md)
- [RoleAssign](docs/RoleAssign.md)
- [RoleMembership](docs/RoleMembership.md)
@@ -957,6 +989,7 @@ Class | Method | HTTP request | Description
- [RoleV2Permissions](docs/RoleV2Permissions.md)
- [RoleV2Readonly](docs/RoleV2Readonly.md)
- [RoleV2RolesGroup](docs/RoleV2RolesGroup.md)
+- [RolesV2Thresholds](docs/RolesV2Thresholds.md)
- [RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md)
- [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
- [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
@@ -965,6 +998,7 @@ Class | Method | HTTP request | Description
- [RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
- [Rule](docs/Rule.md)
- [RuleFailureReason](docs/RuleFailureReason.md)
+- [RuleMetadata](docs/RuleMetadata.md)
- [Ruleset](docs/Ruleset.md)
- [SSOConfig](docs/SSOConfig.md)
- [SamlConnection](docs/SamlConnection.md)
@@ -1036,6 +1070,7 @@ Class | Method | HTTP request | Description
- [TwoFAConfig](docs/TwoFAConfig.md)
- [UpdateAccount](docs/UpdateAccount.md)
- [UpdateAchievement](docs/UpdateAchievement.md)
+- [UpdateAchievementV2](docs/UpdateAchievementV2.md)
- [UpdateApplication](docs/UpdateApplication.md)
- [UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md)
- [UpdateApplicationCIF](docs/UpdateApplicationCIF.md)
diff --git a/api/openapi.yaml b/api/openapi.yaml
index de2382ae..d7750232 100644
--- a/api/openapi.yaml
+++ b/api/openapi.yaml
@@ -5,16 +5,17 @@ info:
manage applications and campaigns:
- Use the operations in the [Integration API section](#integration-api)
- are used to integrate with our platform
+ to integrate with our platform.
- Use the operation in the [Management API section](#management-api) to
manage applications and campaigns.
## 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 [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint
- is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
+ the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
+ endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`.
title: Talon.One API
version: ""
servers:
@@ -115,7 +116,7 @@ tags:
- **Custom events:** They are triggered by the [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.
name: Events
- description: |
- Operations for managing experiments and experiment variants.
+ Represents an A/B testing configuration within a campaign that splits customer sessions across multiple variants to compare rule effects against each other.
name: Experiments
- description: |
Represents a program that rewards customers with giveaways, such as free gift cards.
@@ -155,7 +156,7 @@ tags:
name: Roles
- description: |
Represents a session used for authentication purposes.
- Create one with the [Create session](#operation/createSession) endpoint.
+ Create one with the [Create session](#tag/Sessions/operation/createSession) endpoint.
name: Sessions
- description: Represents store budgets. You can set a store budget to limit the total
amount an individual store can spend in a campaign.
@@ -163,6 +164,9 @@ tags:
- description: |
Represents physical or digital stores, branches, and franchises.
name: Stores
+- description: Represents the value maps that the user can create within a campaign
+ ruleset.
+ name: Value maps
- description: |
A way to send information from Talon.One to the URI of your choice.
@@ -184,7 +188,7 @@ paths:
The `integration ID` of the customer session. You set this ID when you create a customer session.
You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the
- [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
in: path
name: customerSessionId
required: true
@@ -216,33 +220,52 @@ paths:
- integration
x-accepts: application/json
put:
- description: "Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).\n\
- The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects)\
- \ that match the current cart.\nFor example, use this endpoint to share the\
- \ contents of a customer's cart with Talon.One.\n\n**Note:** \n- The currency\
- \ for the session and the cart items in it is the currency set for the Application\
- \ linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign)\
- \ are not considered for rule evaluation.\n\n### Session management\n\nTo\
- \ use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions)\n\
- and their states and refer to the `state` parameter documentation the request\
- \ body schema docs below.\n\n### Sessions and customer profiles\n\n- To link\
- \ a session to a customer profile, set the `profileId` parameter in the request\
- \ body to a customer profile's `integrationId`.\n- While you can create an\
- \ anonymous session with `profileId=\"\"`, we recommend you use a guest ID\
- \ instead.\n- A profile can be linked to simultaneous sessions in different\
- \ Applications. Either:\n - Use unique session integration IDs or,\n - Use\
- \ the same session integration ID across all of the Applications.\n\n**Note:**\
- \ If the specified profile does not exist, an empty profile is **created automatically**.\n\
- \ You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).\n\
- \n\n
Performance tips
\n\
- \n - Updating a customer session returns a response with the new integration\
- \ state. Use the `responseContent` property to save yourself extra API calls.\n\
- \ For example, you can get the customer profile details directly without\
- \ extra requests.\n - We recommend sending requests sequentially. See [Managing\
- \ parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).\n\
-
\n\
- \ Effects and budgets unimpacted by a session reopening
\n\
- \ \n
The following effects and budgets remain in the state they\
- \ were in when the session closed:
\n
\n - Add free item\
- \ effect
\n - Award giveaway
\n - Coupon and referral\
- \ creation
\n - Coupon reservation
\n - Custom effect
\n\
- \ - Update attribute value
\n - Update cart item attribute\
- \ value
\n
\n
\nTo see an example of\
- \ a rollback, see the Cancelling a session with campaign budgets tutorial.
\n\n**Note:**\
- \ If your order workflow requires you to create a new session instead of reopening\
- \ a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)\
- \ endpoint to cancel a closed session and create a new one.\n"
+ description: |
+ Reopen a closed [customer
+ session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).
+
+ For example, if a session has been completed but still needs to be edited,
+ you can reopen it with this endpoint.
+
+ A reopen session is treated like a standard open session.
+
+ When reopening a session:
+
+ - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager.
+ - The session state is updated to `open`.
+ - Any modified budgets and triggered effects are rolled back when the session closes.
+ - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy)
+ in your loyalty programs, points are rolled back in the following ways:
+ - Pending points are rolled back automatically.
+ - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed
+ are rolled back.
+ - If **Negative balance** is enabled, the rollback can create a negative points balance.
+
+
+ Effects and budgets unimpacted by a session reopening
+
+
The following effects and budgets remain in the state they were in when the session closed:
+
+ - Add free item effect
+ - Award giveaway
+ - Coupon and referral creation
+ - Coupon reservation
+ - Custom effect
+ - Update attribute value
+ - Update cart item attribute value
+
+
+
+ To see an example of a rollback, see the
+ [Cancelling a session with campaign budgets](https://docs.talon.one/docs/dev/tutorials/rolling-back-effects) tutorial.
+
+ > [!note] If your order workflow requires you to create a new session
+ > instead of reopening a session, use the
+ > [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
+ > endpoint to cancel a closed session and create a new one.
operationId: reopenCustomerSession
parameters:
- description: |
The `integration ID` of the customer session. You set this ID when you create a customer session.
You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the
- [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
+ [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
in: path
name: customerSessionId
required: true
@@ -453,21 +510,21 @@ paths:
/v2/customer_profiles/{integrationId}:
put:
description: |
- Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.
+ Update or create a [Customer
+ Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles).
+ This endpoint triggers the Rule Builder.
You can use this endpoint to:
- Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first.
- Modify the audience the customer profile is a member of.
- **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`.
-
-
Performance tips
-
- - Updating a customer profile returns a response with the requested integration state.
- - You can use the `responseContent` property to save yourself extra API calls. For example, you can get
- the customer profile details directly without extra requests.
- - We recommend sending requests sequentially.
- See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
-
+ Talon.One also offers a set of [built-in
+ events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure
+ you do not create a custom event when you can use a built-in event.
-
Important
+ For example, use this endpoint to trigger an event when a customer shares a
+ link to a product.
- 1. `profileId` is required even though the schema does not specify it.
- 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.
- 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
- 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.
+ See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).
-
-
Important
-
- - Only send sequential requests to this endpoint.
- - Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.
- - With this
PUT endpoint, if you do not explicitly set a value for the startDate and expiryDate properties in your request, it is automatically set to null.
-
+ You can find the `batchId` on the **Coupons** page of your campaign in the
+ Campaign Manager, or you can use [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
-
-
Important
-
-
With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.
-
-
+ Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
+
+ Available units:
+
+ - `s`: seconds
+ - `m`: minutes
+ - `h`: hours
+ - `D`: days
+ - `W`: weeks
+ - `M`: months
+ - `Y`: years
+
+ You can round certain units up or down:
+
+ - `_D` for rounding down days only. Signifies the start of the day.
+ - `_U` for rounding up days, weeks, months and years. Signifies the end of
+ the day, week, month or year.
+
+ If passed, `expirydate` should be omitted.
+ - `subledgerid` (optional): The ID of the subledger that should received the points.
+ - `reason` (optional): The reason why these points are awarded.
+
+ You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
+
+ > [!note] For existing customer profiles and loyalty cards, the imported
+ > points are added to any previous active or pending points, depending on the
+ > value provided for `startdate`. If `startdate` matches the current date, the
+ > imported points are _active_. If it is later, the points are _pending_ until
+ > the date provided for `startdate` is reached.
+
+ > [!note] We recommend limiting your file size to 500 MB.
+
+ ## Example for profile-based programs
+
+ ```text
+ customerprofileid,amount,startdate,expirydate,subledgerid,reason
+ URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement
+ ```
+
+ ## Example for card-based programs
+
+ ```text
+ identifier,amount,startdate,expirydate,subledgerid,reason
+ summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement
+ ```
operationId: importLoyaltyPoints
parameters:
- description: |
@@ -4945,29 +5283,45 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers:
post:
description: |
- Upload a CSV file containing existing customers to be assigned to existing tiers.
+ Upload a CSV file containing existing customers to be assigned to existing
+ tiers.
+
Send the file as multipart data.
- **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled.
+ > [!important] This endpoint only works with loyalty programs with advanced
+ > tiers (with expiration and downgrade policy) feature enabled.
The CSV file should contain the following columns:
- - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used.
- - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned.
+
+ - `subledgerid` (optional): The ID of the subledger. If this field is empty,
+ the main ledger will be used.
+ - `customerprofileid`: The integration ID of the customer profile to whom
+ the tier should be assigned.
- `tiername`: The name of an existing tier to assign to the customer.
- - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date.
+ - `expirydate`: The expiration date of the tier when the tier is
+ reevaluated. It should be a future date.
About customer assignment to a tier:
- - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import.
- - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated.
- **Note:** We recommend not using this endpoint to update the tier of a customer.
- To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points.
+ - If the customer isn't already in a tier, the customer is assigned to the
+ specified tier during the tier import.
+ - If the customer is already in the tier that's specified in the CSV file,
+ only the expiration date is updated.
- You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
+ > [!note] We recommend not using this endpoint to update the tier of a customer.
+
+ To update a customer's tier, you can
+ [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or
+ [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their
+ loyalty points.
+
+ You can use the time zone of your choice. It is converted to UTC internally
+ by Talon.One.
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500 MB.
+
+ ## Example
- **Example:**
```csv
subledgerid,customerprofileid,tiername,expirydate
SUB1,alexa,Gold,2024-03-21T07:32:14Z
@@ -5031,7 +5385,7 @@ paths:
Get the loyalty ledger for this profile integration ID.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
**Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program,
we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
@@ -5071,7 +5425,7 @@ paths:
Add points in the specified loyalty program for the given customer.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.
operationId: addLoyaltyPoints
parameters:
- description: The identifier for the loyalty program.
@@ -5129,14 +5483,16 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points:
put:
description: |
- Deduct points from the specified loyalty program and specified customer profile.
+ Deduct points from the specified loyalty program and specified customer
+ profile.
- **Important:**
- - Only active points can be deducted.
- - Only pending points are rolled back when a session is cancelled or reopened.
+ > [!note] **Note**
+ > - Only active points can be deducted.
+ > - Only pending points are rolled back when a session is cancelled or reopened.
To get the `integrationId` of the profile from a `sessionId`, use the
- [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
+ [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)
+ endpoint.
operationId: removeLoyaltyPoints
parameters:
- description: The identifier for the loyalty program.
@@ -5194,9 +5550,11 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log:
get:
description: |
- Download a CSV file containing a customer's transaction logs in the loyalty program.
+ Download a CSV file containing a customer's transaction logs in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The generated file can contain the following columns:
@@ -5222,9 +5580,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeStart
required: true
@@ -5234,9 +5593,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeEnd
required: true
@@ -5285,7 +5645,8 @@ paths:
description: |
Download a CSV file containing the join dates of all customers in the loyalty program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The generated file can contain the following columns:
@@ -5384,9 +5745,10 @@ paths:
get:
deprecated: true
description: |
- ⚠️ Deprecation notice: Support for requests to this endpoint will end soon.
- To retrieve statistics for a loyalty program, use the [Get statistics for
- loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics)
+ > [warning] This endpoint is deprecated.
+
+ To retrieve statistics for a loyalty program, use the
+ [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics)
endpoint.
Retrieve the statistics of the specified loyalty program, such as the
@@ -5416,14 +5778,16 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances:
get:
description: |
- Download a CSV file containing the balance of each customer in the loyalty program.
+ Download a CSV file containing the balance of each customer in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The generated file can contain the following columns:
- `loyaltyProgramID`: The ID of the loyalty program.
- - `loyaltySubledger`: The name of the subdleger, when applicatble.
+ - `loyaltySubledger`: The name of the subledger, when applicable.
- `profileIntegrationID`: The integration ID of the customer profile.
- `currentBalance`: The current point balance.
- `pendingBalance`: The number of pending points.
@@ -5438,15 +5802,15 @@ paths:
required: true
schema:
type: string
- - description: "Used to return expired, active, and pending loyalty balances\
- \ before this\ntimestamp. You can enter any past, present, or future timestamp\
- \ value.\n\n**Note:**\n\n- It must be an RFC3339 timestamp string.\n- You\
- \ can include a time component in your string, for example,\n`T23:59:59`\
- \ to specify the end of the day. The time zone setting\nconsidered is `UTC`.\
- \ If you do not include a time component, a default\ntime value of `T00:00:00`\
- \ (midnight) in `UTC` is considered.\n- This parameter does not affect the\
- \ `currentTier` field in the CSV file, \nwhich shows the customer's tier\
- \ at the time of export.\n"
+ - description: |
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
+
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > - This parameter does not affect the `currentTier` field in the CSV file, which shows the customer's tier at the time of export.
in: query
name: endDate
schema:
@@ -5480,12 +5844,14 @@ paths:
get:
deprecated: true
description: |
- ⚠️ Deprecation notice: Support for requests to this endpoint will end soon.
- To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint.
+ To export customer loyalty balances to CSV, use the [Export customer loyalty
+ balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint.
- Download a CSV file containing the balance of each customer in the loyalty program.
+ Download a CSV file containing the balance of each customer in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
operationId: exportLoyaltyBalance
parameters:
- description: The identifier for the loyalty program.
@@ -5495,12 +5861,13 @@ paths:
schema:
type: string
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
-
- **Note:**
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: endDate
schema:
@@ -5533,11 +5900,15 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/transactions:
get:
description: |
- Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included.
- **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned.
-
- **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program,
- we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
+ Retrieve loyalty program transaction logs in a given loyalty program with
+ filtering options applied. Manual and imported transactions are also
+ included.
+
+ > [!note] **Note**
+ > - If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned.
+ > - To get loyalty transaction logs for a given Integration ID in
+ > a loyalty program, we recommend using the Integration API's [Get customer's loyalty
+ > logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
operationId: getLoyaltyProgramTransactions
parameters:
- description: |
@@ -5567,10 +5938,13 @@ paths:
name: subledgerId
schema:
type: string
- - description: "Filter the results by a list of customer session IDs. \n\nTo\
- \ include multiple IDs, repeat the parameter for each one, for example,\
- \ \n`?customerSessionIDs=id1&customerSessionIDs=id2`.\n\nThe response contains\
- \ only data associated with the specified sessions.\n"
+ - description: |
+ Filter the results by a list of customer session IDs.
+
+ To include multiple IDs, repeat the parameter for each one, for example,
+ `?customerSessionIDs=id1&customerSessionIDs=id2`.
+
+ The response contains only data associated with the specified sessions.
explode: true
in: query
name: customerSessionIDs
@@ -5579,9 +5953,13 @@ paths:
type: string
type: array
style: form
- - description: "Filter the results by a list of transaction UUIDs.\n\nTo include\
- \ multiple IDs, repeat the parameter for each one, for example, \n`?transactionUUIDs=uuid1&transactionUUIDs=uuid2`.\n\
- \nThe response contains only data associated with the specified transactions.\n"
+ - description: |
+ Filter the results by a list of transaction UUIDs.
+
+ To include multiple IDs, repeat the parameter for each one, for example,
+ `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`.
+
+ The response contains only data associated with the specified transactions.
explode: true
in: query
name: transactionUUIDs
@@ -5591,24 +5969,26 @@ paths:
type: array
style: form
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: startDate
schema:
format: date-time
type: string
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: endDate
schema:
@@ -5643,7 +6023,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_18'
+ $ref: '#/components/schemas/inline_response_200_19'
description: OK
"400":
content:
@@ -5670,23 +6050,28 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/import_cards:
post:
description: |
- Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program.
+ Upload a CSV file containing the loyalty cards that you want to use in your
+ card-based loyalty program.
+
Send the file as multipart data.
It contains the following columns for each card:
- - `identifier` (required): The alphanumeric identifier of the loyalty card.
- - `state` (required): The state of the loyalty card. It can be `active` or `inactive`.
- - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;).
- - `attributes` (optional): A JSON object that contains the loyalty card's custom attributes and their values. These attributes must be created and connected to this loyalty program before they can be assigned to the cards through this endpoint.
+ - `identifier` (required): The identifier of the loyalty card,
+ which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.
+ - `state` (required): The state of the loyalty card. It can be `active` or
+ `inactive`.
+ - `customerprofileids` (optional): An array of strings representing the
+ identifiers of the customer profiles linked to the loyalty card. The
+ identifiers should be separated with a semicolon (;).
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500MB.
- **Example:**
+ ## Example
```csv
- identifier,state,customerprofileids,attributes
- 123-456-789AT,active,Alexa001;UserA,"{""my_attribute"": ""10_off""}"
+ identifier,state,customerprofileids
+ 123-456-789AT,active,Alexa001;UserA
```
operationId: importLoyaltyCards
parameters:
@@ -5735,14 +6120,16 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/batch:
post:
description: |
- Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types).
+ Create a batch of loyalty cards in a specified [card-based loyalty
+ program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types).
Customers can use loyalty cards to collect and spend loyalty points.
- **Important:**
-
- - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes.
- - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
+ > [!important] **Note**
+ > - The specified card-based loyalty program must have a defined card code
+ > format that is used to generate the loyalty card codes.
+ > - Trying to create more than 20,000 loyalty cards in a single request
+ > returns an error message with a `400` status code.
operationId: createBatchLoyaltyCards
parameters:
- description: |
@@ -5795,15 +6182,19 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/export_card_balances:
get:
description: |
- Download a CSV file containing the balances of all cards in the loyalty program.
+ Download a CSV file containing the balances of all cards in the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The CSV file contains the following columns:
- `loyaltyProgramID`: The ID of the loyalty program.
- `loyaltySubledger`: The name of the subdleger, when applicatble.
- - `cardIdentifier`: The alphanumeric identifier of the loyalty card.
- - `cardState`:The state of the loyalty card. It can be `active` or `inactive`.
+ - `cardIdentifier`: The identifier of the loyalty card, which must match the regular
+ expression `^[A-Za-z0-9._%+@-]+$`.
+ - `cardState`:The state of the loyalty card. It can be `active` or
+ `inactive`.
- `currentBalance`: The current point balance.
- `pendingBalance`: The number of pending points.
- `expiredBalance`: The number of expired points.
@@ -5820,12 +6211,13 @@ paths:
format: int64
type: integer
- description: |
- Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
-
- **Note:**
+ Used to return expired, active, and pending loyalty balances before this
+ timestamp. You can enter any past, present, or future timestamp value.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: endDate
schema:
@@ -5894,7 +6286,13 @@ paths:
schema:
format: int64
type: integer
- - description: The card code by which to filter loyalty cards in the response.
+ - description: |
+ The card code by which to filter loyalty cards in the response.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: query
name: identifier
schema:
@@ -5917,7 +6315,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_19'
+ $ref: '#/components/schemas/inline_response_200_20'
description: OK
"400":
content:
@@ -5943,16 +6341,13 @@ paths:
To link the card to one or more customer profiles, use the
`customerProfileIds` parameter in the request body.
- **Note:**
-
- - The number of customer profiles linked to the loyalty card cannot exceed
- the loyalty program's `usersPerCardLimit`. To find the program's limit, use
- the [Get loyalty
- program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram)
- endpoint.
-
- - If the loyalty program has a defined code format, it will be used for the
- loyalty card identifier.
+ > [!note] **Note**
+ > - The number of customer profiles linked to the loyalty card cannot exceed
+ > the loyalty program's `usersPerCardLimit`. To find the program's limit, use
+ > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram)
+ > endpoint.
+ > - If the loyalty program has a defined code format, it will be used for the
+ > loyalty card identifier.
operationId: generateLoyaltyCard
parameters:
- description: |
@@ -6001,11 +6396,14 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/export:
get:
description: |
- Download a CSV file containing the loyalty cards from a specified loyalty program.
+ Download a CSV file containing the loyalty cards from a specified loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The CSV file contains the following columns:
+
- `identifier`: The unique identifier of the loyalty card.
- `created`: The date and time the loyalty card was created.
- `status`: The status of the loyalty card.
@@ -6014,6 +6412,7 @@ paths:
- `blockreason`: The reason for transferring and blocking the loyalty card.
- `generated`: An indicator of whether the loyalty card was generated.
- `batchid`: The ID of the batch the loyalty card is in.
+ - `attributes`: The custom attributes of this loyalty card. Currently, this feature is only available upon request.
operationId: exportLoyaltyCards
parameters:
- description: |
@@ -6033,8 +6432,7 @@ paths:
- description: |
Only return loyalty cards created before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
+ **Note:** This must be an RFC3339 timestamp string.
in: query
name: createdBefore
schema:
@@ -6043,8 +6441,7 @@ paths:
- description: |
Only return loyalty cards created after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
+ **Note:** This must be an RFC3339 timestamp string.
in: query
name: createdAfter
schema:
@@ -6098,7 +6495,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6141,7 +6545,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6179,9 +6590,9 @@ paths:
- management
x-accepts: application/json
put:
- description: 'Update the details of a specific loyalty card. You can set the
- card''s status to `active` or `inactive` through this endpoint. At least one
- of `status` or `attributes` must be provided. '
+ description: Update the details of a specific loyalty card. You can set the
+ card's status to `active` or `inactive` through this endpoint. At least one
+ of `status` or `attributes` must be provided.
operationId: updateLoyaltyCard
parameters:
- description: |
@@ -6195,7 +6606,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6248,8 +6666,15 @@ paths:
operationId: addLoyaltyCardPoints
parameters:
- description: |
- Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with
- the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ Identifier of the card-based loyalty program containing the loyalty
+ card. You can get the ID with the [List loyalty
+ programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyProgramId
required: true
@@ -6257,8 +6682,7 @@ paths:
format: int64
type: integer
- description: |
- Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
in: path
name: loyaltyCardId
required: true
@@ -6318,7 +6742,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6364,9 +6795,11 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log:
get:
description: |
- Download a CSV file containing a loyalty card ledger log of the loyalty program.
+ Download a CSV file containing a loyalty card ledger log of the loyalty
+ program.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
operationId: exportLoyaltyCardLedger
parameters:
- description: |
@@ -6380,7 +6813,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6391,9 +6831,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeStart
required: true
@@ -6403,9 +6844,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeEnd
required: true
@@ -6463,7 +6905,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6472,24 +6921,26 @@ paths:
minLength: 4
type: string
- description: |
- Date and time from which results are returned. Results are filtered by transaction creation date.
+ Date and time from which results are returned. Results are filtered by
+ transaction creation date.
- **Note:**
-
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: startDate
schema:
format: date-time
type: string
- description: |
- Date and time by which results are returned. Results are filtered by transaction creation date.
-
- **Note:**
+ Date and time by which results are returned. Results are filtered by
+ transaction creation date.
- - It must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: endDate
schema:
@@ -6516,10 +6967,13 @@ paths:
name: subledgerId
schema:
type: string
- - description: "Filter the results by a list of customer session IDs. \n\nTo\
- \ include multiple IDs, repeat the parameter for each one, for example,\
- \ \n`?customerSessionIDs=id1&customerSessionIDs=id2`.\n\nThe response contains\
- \ only data associated with the specified sessions.\n"
+ - description: |
+ Filter the results by a list of customer session IDs.
+
+ To include multiple IDs, repeat the parameter for each one, for example,
+ `?customerSessionIDs=id1&customerSessionIDs=id2`.
+
+ The response contains only data associated with the specified sessions.
explode: true
in: query
name: customerSessionIDs
@@ -6528,9 +6982,13 @@ paths:
type: string
type: array
style: form
- - description: "Filter the results by a list of transaction UUIDs.\n\nTo include\
- \ multiple IDs, repeat the parameter for each one, for example, \n`?transactionUUIDs=uuid1&transactionUUIDs=uuid2`.\n\
- \nThe response contains only data associated with the specified transactions.\n"
+ - description: |
+ Filter the results by a list of transaction UUIDs.
+
+ To include multiple IDs, repeat the parameter for each one, for example,
+ `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`.
+
+ The response contains only data associated with the specified transactions.
explode: true
in: query
name: transactionUUIDs
@@ -6544,7 +7002,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_20'
+ $ref: '#/components/schemas/inline_response_200_21'
description: OK
"401":
content:
@@ -6565,12 +7023,14 @@ paths:
/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer:
put:
description: |
- Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card.
-
- **Important:**
-
- - The original card is automatically blocked once the new card is created, and it cannot be activated again.
- - The default status of the new card is _active_.
+ Transfer loyalty card data, such as linked customers, loyalty balances and
+ transactions, from a given loyalty card to a new, automatically created
+ loyalty card.
+
+ > [!important] **Note**
+ > - The original card is automatically blocked once the new card is created,
+ and it cannot be activated again.
+ > - The default status of the new card is _active_.
operationId: transferLoyaltyCard
parameters:
- description: |
@@ -6584,7 +7044,14 @@ paths:
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
- the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
+ the [List loyalty
+ cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards)
+ endpoint.
+
+ **Important**: The loyalty card ID requires [URL
+ encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it
+ contains special characters. For example, you must encode `NewCard2026%`
+ as `NewCard2026%25`.
in: path
name: loyaltyCardId
required: true
@@ -6630,32 +7097,38 @@ paths:
/v1/giveaways/pools/{poolId}/import:
post:
description: |
- Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data.
+ Upload a CSV file containing the giveaway codes that should be created. Send
+ the file as multipart data.
The CSV file contains the following columns:
+
- `code` (required): The code of your giveaway, for instance, a gift card redemption code.
- `startdate`: The start date in RFC3339 of the code redemption period.
- `enddate`: The last date in RFC3339 of the code redemption period.
- - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.
-
+ - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks.
For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes)
called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `"{"provider": "myPartnerCompany"}"`.
- The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not.
- You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One.
+ The `startdate` and `enddate` have nothing to do with the _validity_ of the
+ codes. They are only used by the Rule Engine to award the codes or not.
- **Note:**
+ You can use the time zone setting of your choice. The values are converted
+ to UTC internally by Talon.One.
- - We recommend limiting your file size to 500MB.
- - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes.
+ > [!note] **Note**
+ > - We recommend limiting your file size to 500MB.
+ > - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes.
- **Example:**
+ ## Example
```text
code,startdate,enddate,attributes
- GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}"
- GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}"
- GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Aliexpress""}"
+ GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"":
+ ""Amazon""}"
+ GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"":
+ ""Amazon""}"
+ GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"":
+ ""Aliexpress""}"
```
operationId: importPoolGiveaways
parameters:
@@ -6691,9 +7164,11 @@ paths:
/v1/giveaways/pools/{poolId}/export:
get:
description: |
- Download a CSV file containing the giveaway codes of a specific giveaway pool.
+ Download a CSV file containing the giveaway codes of a specific giveaway
+ pool.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The CSV file contains the following columns:
@@ -6706,8 +7181,12 @@ paths:
- `used`: An indication of whether the giveaway is already awarded.
- `importid`: The ID of the import which created the giveaway.
- `created`: The creation time of the giveaway code.
- - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded.
- - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
+ - `profileintegrationid`: The third-party integration ID of the customer
+ profile that was awarded the giveaway. Can be empty if the giveaway was not
+ awarded.
+ - `profileid`: The internal ID of the customer profile that was awarded the
+ giveaway. Can be empty if the giveaway was not awarded or an internal ID
+ does not exist.
operationId: exportPoolGiveaways
parameters:
- description: The ID of the pool. You can find it in the Campaign Manager,
@@ -6780,10 +7259,10 @@ paths:
schema:
type: string
- description: |
- When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
+ When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.
- - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero.
- - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ - When `true`: `totalResultSize` contains the total number of results for this query.
+ - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.
in: query
name: withTotalResultSize
schema:
@@ -6798,7 +7277,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_21'
+ $ref: '#/components/schemas/inline_response_200_22'
description: OK
"400":
content:
@@ -6869,7 +7348,7 @@ paths:
operationId: deleteAccountCollection
parameters:
- description: The ID of the collection. You can get it with the [List collections
- in account](#operation/listAccountCollections) endpoint.
+ in account](#tag/Collections/operation/listAccountCollections) endpoint.
in: path
name: collectionId
required: true
@@ -6895,7 +7374,7 @@ paths:
operationId: getAccountCollection
parameters:
- description: The ID of the collection. You can get it with the [List collections
- in account](#operation/listAccountCollections) endpoint.
+ in account](#tag/Collections/operation/listAccountCollections) endpoint.
in: path
name: collectionId
required: true
@@ -6925,7 +7404,7 @@ paths:
operationId: updateAccountCollection
parameters:
- description: The ID of the collection. You can get it with the [List collections
- in account](#operation/listAccountCollections) endpoint.
+ in account](#tag/Collections/operation/listAccountCollections) endpoint.
in: path
name: collectionId
required: true
@@ -6995,7 +7474,7 @@ paths:
format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
- in account](#operation/listAccountCollections) endpoint.
+ in account](#tag/Collections/operation/listAccountCollections) endpoint.
in: path
name: collectionId
required: true
@@ -7007,7 +7486,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_22'
+ $ref: '#/components/schemas/inline_response_200_23'
description: OK
"404":
content:
@@ -7057,10 +7536,10 @@ paths:
schema:
type: string
- description: |
- When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
+ When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.
- - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero.
- - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ - When `true`: `totalResultSize` contains the total number of results for this query.
+ - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.
in: query
name: withTotalResultSize
schema:
@@ -7075,7 +7554,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_21'
+ $ref: '#/components/schemas/inline_response_200_22'
description: OK
"404":
content:
@@ -7133,10 +7612,10 @@ paths:
schema:
type: string
- description: |
- When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
+ When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.
- - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero.
- - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ - When `true`: `totalResultSize` contains the total number of results for this query.
+ - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.
in: query
name: withTotalResultSize
schema:
@@ -7151,7 +7630,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_21'
+ $ref: '#/components/schemas/inline_response_200_22'
description: OK
"404":
content:
@@ -7225,7 +7704,8 @@ paths:
format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
- in Application](#operation/listCollectionsInApplication) endpoint.
+ in Application](#tag/Collections/operation/listCollectionsInApplication)
+ endpoint.
in: path
name: collectionId
required: true
@@ -7267,7 +7747,8 @@ paths:
format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
- in Application](#operation/listCollectionsInApplication) endpoint.
+ in Application](#tag/Collections/operation/listCollectionsInApplication)
+ endpoint.
in: path
name: collectionId
required: true
@@ -7312,7 +7793,8 @@ paths:
format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
- in Application](#operation/listCollectionsInApplication) endpoint.
+ in Application](#tag/Collections/operation/listCollectionsInApplication)
+ endpoint.
in: path
name: collectionId
required: true
@@ -7348,7 +7830,9 @@ paths:
/v1/collections/{collectionId}/import:
post:
description: |
- Upload a CSV file containing the collection of string values that should be attached as payload for collection.
+ Upload a CSV file containing the collection of string values that should be
+ attached as payload for collection.
+
The file should be sent as multipart data.
The import **replaces** the initial content of the collection.
@@ -7359,20 +7843,21 @@ paths:
A collection is limited to 500,000 items.
- Example:
+ ## Example
```
item
- Addidas
+ Adidas
Nike
Asics
```
- **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ > [!note] Before sending a request to this endpoint, ensure the data in the
+ > CSV to import is different from the data currently stored in the collection.
operationId: importAccountCollection
parameters:
- description: The ID of the collection. You can get it with the [List collections
- in account](#operation/listAccountCollections) endpoint.
+ in account](#tag/Collections/operation/listAccountCollections) endpoint.
in: path
name: collectionId
required: true
@@ -7415,7 +7900,9 @@ paths:
/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import:
post:
description: |
- Upload a CSV file containing the collection of string values that should be attached as payload for collection.
+ Upload a CSV file containing the collection of string values that should be
+ attached as payload for collection.
+
The file should be sent as multipart data.
The import **replaces** the initial content of the collection.
@@ -7426,16 +7913,17 @@ paths:
A collection is limited to 500,000 items.
- Example:
+ ## Example
```
item
- Addidas
+ Adidas
Nike
Asics
```
- **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
+ > [!note] Before sending a request to this endpoint, ensure the data in the
+ > CSV to import is different from the data currently stored in the collection.
operationId: importCollection
parameters:
- description: The ID of the Application. It is displayed in your Talon.One
@@ -7455,7 +7943,8 @@ paths:
format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
- in Application](#operation/listCollectionsInApplication) endpoint.
+ in Application](#tag/Collections/operation/listCollectionsInApplication)
+ endpoint.
in: path
name: collectionId
required: true
@@ -7494,11 +7983,12 @@ paths:
description: |
Download a CSV file containing items from a given account-level collection.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
operationId: exportAccountCollectionItems
parameters:
- description: The ID of the collection. You can get it with the [List collections
- in account](#operation/listAccountCollections) endpoint.
+ in account](#tag/Collections/operation/listAccountCollections) endpoint.
in: path
name: collectionId
required: true
@@ -7534,7 +8024,8 @@ paths:
description: |
Download a CSV file containing items from a given campaign-level collection.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
operationId: exportCollectionItems
parameters:
- description: The ID of the Application. It is displayed in your Talon.One
@@ -7554,7 +8045,8 @@ paths:
format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
- in Application](#operation/listCollectionsInApplication) endpoint.
+ in Application](#tag/Collections/operation/listCollectionsInApplication)
+ endpoint.
in: path
name: collectionId
required: true
@@ -7657,9 +8149,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeStart
required: true
@@ -7669,9 +8162,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeEnd
required: true
@@ -7707,7 +8201,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_23'
+ $ref: '#/components/schemas/inline_response_200_24'
description: OK
summary: Get access logs for Application
tags:
@@ -7737,9 +8231,10 @@ paths:
- description: |
Only return results from after this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeStart
required: true
@@ -7749,9 +8244,10 @@ paths:
- description: |
Only return results from before this timestamp.
- **Note:**
- - This must be an RFC3339 timestamp string.
- - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
+ > [!note] **Note**
+ > - This must be an RFC3339 timestamp string.
+ > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting
+ > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
in: query
name: rangeEnd
required: true
@@ -7774,7 +8270,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_24'
+ $ref: '#/components/schemas/inline_response_200_25'
description: OK
summary: Get analytics of campaigns
tags:
@@ -7816,10 +8312,10 @@ paths:
format: int64
type: integer
- description: |
- When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
+ When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.
- - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero.
- - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ - When `true`: `totalResultSize` contains the total number of results for this query.
+ - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.
in: query
name: withTotalResultSize
schema:
@@ -7829,7 +8325,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_25'
+ $ref: '#/components/schemas/inline_response_200_26'
description: OK
summary: List application's customers
tags:
@@ -7868,10 +8364,10 @@ paths:
format: int64
type: integer
- description: |
- When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
+ When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.
- - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero.
- - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ - When `true`: `totalResultSize` contains the total number of results for this query.
+ - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.
in: query
name: withTotalResultSize
schema:
@@ -7888,7 +8384,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_26'
+ $ref: '#/components/schemas/inline_response_200_27'
description: OK
summary: List application customers matching the given attributes
tags:
@@ -7938,7 +8434,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_27'
+ $ref: '#/components/schemas/inline_response_200_28'
description: OK
summary: List customer profiles matching the given attributes
tags:
@@ -7951,20 +8447,16 @@ paths:
description: |
Return the details of the specified customer profile.
-
-
Performance tips
-
- You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options:
-
- - Request the customer profile to be part of the response content using
- [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2).
- - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
-
Adding an item to the catalog
@@ -9600,7 +10139,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_39'
+ $ref: '#/components/schemas/inline_response_200_40'
description: OK
summary: List additional costs
tags:
@@ -9760,7 +10299,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_40'
+ $ref: '#/components/schemas/inline_response_200_41'
description: OK
summary: List webhooks
tags:
@@ -9973,7 +10512,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_41'
+ $ref: '#/components/schemas/inline_response_200_42'
description: OK
summary: List event types
tags:
@@ -9982,7 +10521,8 @@ paths:
/v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons:
post:
description: |
- Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
+ Upload a CSV file containing the coupons that should be created. The file
+ should be sent as multipart data.
The CSV file contains the following columns:
@@ -9990,31 +10530,29 @@ paths:
There is no maximum length but limiting the code to 30 characters
ensures it is fully readable in the Campaign Manager.
The code should be unique unless you set `skipDuplicates` to `true`.
-
- `expirydate`: The end date in RFC3339 of the code redemption period.
- `startdate`: The start date in RFC3339 of the code redemption period.
- `recipientintegrationid`: The integration ID of the recipient of the coupon.
Only the customer with this integration ID can redeem this code. Available only for personal codes.
- `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided.
- `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value.
- - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.
-
+ - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks.
For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes)
called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `"{"category": "10_off"}"`.
You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500 MB.
- **Example:**
+ ## Example
```text
"value","expirydate","startdate","recipientintegrationid","limitval","attributes","discountlimit"
- COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"": ""10_off""}",2.4
+ COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"":
+ ""10_off""}",2.4
```
- Once imported, you can find the `batchId` in the Campaign Manager or by
- using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
+ Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
operationId: importCoupons
parameters:
- description: The ID of the Application. It is displayed in your Talon.One
@@ -10066,7 +10604,8 @@ paths:
description: |
Download a CSV file containing the coupons that match the given properties.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The CSV file can contain the following columns:
@@ -10088,7 +10627,7 @@ paths:
- `limits`: The limits set on this coupon.
- `limitval`: The maximum number of redemptions of this code.
- `recipientintegrationid`: The integration ID of the recipient of the coupon.
- Only the customer with this integration ID can redeem this code. Available only for personal codes.
+ Only the customer with this integration ID can redeem this code. Available only for personal codes.
- `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect).
- `reservation`: Whether the coupon can be reserved for multiple customers.
- `reservation_counter`: How many times this coupon has been reserved.
@@ -10235,9 +10774,11 @@ paths:
/v1/applications/{applicationId}/export_referrals:
get:
description: |
- Download a CSV file containing the referrals that match the given parameters.
+ Download a CSV file containing the referrals that match the given
+ parameters.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The CSV file contains the following columns:
@@ -10328,9 +10869,11 @@ paths:
/v1/applications/{applicationId}/export_effects:
get:
description: |
- Download a CSV file containing the triggered effects that match the given attributes.
+ Download a CSV file containing the triggered effects that match the given
+ attributes.
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
The generated file can contain the following columns:
@@ -10406,9 +10949,11 @@ paths:
description: |
Download a CSV file containing the customer sessions that match the request.
- **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention).
+ > [!important] Archived sessions cannot be exported. See the [retention
+ > policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention).
- **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+ > [!tip] If the exported CSV file is too large to view, you can
+ > [split it into multiple files](https://www.google.com/search?q=split+CSV+into+multiple+files).
- `id`: The internal ID of the session.
- `firstsession`: Whether this is a first session.
@@ -10417,7 +10962,8 @@ paths:
- `profileid`: The internal ID of the customer profile.
- `profileintegrationid`: The integration ID of the customer profile.
- `created`: The timestamp when the session was created.
- - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session.
+ - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states)
+ of the session.
- `cartitems`: The cart items in the session.
- `discounts`: The discounts in the session.
- `total`: The total value of cart items and additional costs in the session, before any discounts are applied.
@@ -10426,7 +10972,8 @@ paths:
- `cancelledat`: Timestamp when the session was cancelled.
- `referral`: The referral code in the session.
- `identifiers`: The identifiers in the session.
- - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session.
+ - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs)
+ in the session.
- `updated`: Timestamp of the last session update.
- `store_integration_id`: The integration ID of the store.
- `coupons`: Coupon codes in the session.
@@ -10494,6 +11041,7 @@ paths:
post:
description: |
Upload a CSV file containing the referrals that should be created.
+
The file should be sent as multipart data.
The CSV file contains the following columns:
@@ -10503,26 +11051,29 @@ paths:
- `startdate`: The start date in RFC3339 of the code redemption period.
- `expirydate`: The end date in RFC3339 of the code redemption period.
- `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank.
- - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.
-
+ - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks.
For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes)
called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `"{"category": "10_off"}"`.
You can use the time zone of your choice. It is converted to UTC internally by Talon.One.
- **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles)
- is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2)
- endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2)
- endpoint to create the customer profiles.
+ > [!important] When you import a CSV file with referrals,
+ > a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles)
+ > is **not** automatically created for each `advocateprofileintegrationid`
+ > column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2)
+ > endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2)
+ > endpoint to create the customer profiles.
- **Note:** We recommend limiting your file size to 500MB.
+ > [!note] We recommend limiting your file size to 500 MB.
- **Example:**
+ ## Example
```text
code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes
- REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"{""my_attribute"": ""10_off""}"
- REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"{""my_attribute"": ""20_off""}"
+ REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"{""my_attribute"":
+ ""10_off""}"
+ REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"{""my_attribute"":
+ ""20_off""}"
```
operationId: importReferrals
parameters:
@@ -10598,7 +11149,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_42'
+ $ref: '#/components/schemas/inline_response_200_43'
description: OK
summary: List users in account
tags:
@@ -11206,10 +11757,10 @@ paths:
format: date-time
type: string
- description: |
- When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
+ When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.
- - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero.
- - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
+ - When `true`: `totalResultSize` contains the total number of results for this query.
+ - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.
in: query
name: withTotalResultSize
schema:
@@ -11231,7 +11782,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_43'
+ $ref: '#/components/schemas/inline_response_200_44'
description: OK
summary: Get audit logs for an account
tags:
@@ -11240,9 +11791,13 @@ paths:
/v2/invites:
post:
description: |
- Create a new user in the account and send an invitation to their email address.
+ Create a new user in the account and send an invitation to their email
+ address.
- **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
+ > [!note] The invitation token is valid for 24 hours after the email has
+ > been sent. You can resend an invitation to a user with the [Resend
+ > invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail)
+ > endpoint.
operationId: createInviteV2
requestBody:
content:
@@ -11269,7 +11824,7 @@ paths:
description: |
Resend an email invitation to an existing user.
- **Note:** The invitation token is valid for 24 hours after the email has been sent.
+ > [!note] The invitation token is valid for 24 hours after the email has been sent.
operationId: createInviteEmail
requestBody:
content:
@@ -11294,9 +11849,10 @@ paths:
/v1/password_recovery_emails:
post:
description: |
- Send an email with a password recovery link to the email address of an existing account.
+ Send an email with a password recovery link to the email address of an
+ existing account.
- **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
+ > [!note] The password recovery link expires 30 minutes after this endpoint is triggered.
operationId: createPasswordRecoveryEmail
requestBody:
content:
@@ -11352,7 +11908,7 @@ paths:
parameters:
- description: |
The identifier of the account. Retrieve it via the
- [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId`
+ [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId`
property.
in: path
name: accountId
@@ -11379,7 +11935,7 @@ paths:
parameters:
- description: |
The identifier of the account. Retrieve it via the
- [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId`
+ [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId`
property.
in: path
name: accountId
@@ -11413,18 +11969,19 @@ paths:
post:
description: |
Create a session to use the Management API endpoints.
- Use the value of the `token` property provided in the response as bearer token in other API calls.
- A token is valid for 3 months. In accordance with best pratices, use your generated token
- for all your API requests. Do **not** regenerate a token for each request.
+ Use the value of the `token` property provided in the response as bearer
+ token in other API calls.
+
+ A token is valid for 3 months. In accordance with best pratices, use your
+ generated token for all your API requests. Do **not** regenerate a token for each request.
- This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup.
+ This endpoint has a rate limit of 3 to 6 requests per second per account,
+ depending on your setup.
-
-
Granular API key
- Instead of using a session, you can also use the
Management API key feature
- in the Campaign Manager to decide which endpoints can be used with a given key.
-
@@ -1282,8 +1281,8 @@ public void deleteCustomerData(String integrationId) throws ApiException {
/**
* Delete customer's personal data
- * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Delete all attributes on the customer profile and on entities that reference this customer profile. > [!warning] **Warning** > - Customer data is deleted from all Applications in the > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) > that the API key belongs to. For example, if you use this endpoint with an API key that belongs > to a sandbox Application, customer data will be deleted from all sandbox Applications. > This is because customer data is shared between Applications from the same environment. > - To preserve performance, we recommend avoiding deleting customer data > during peak-traffic hours.
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1301,8 +1300,8 @@ public ApiResponse deleteCustomerDataWithHttpInfo(String integrationId) th
/**
* Delete customer's personal data (asynchronously)
- * Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * Delete all attributes on the customer profile and on entities that reference this customer profile. > [!warning] **Warning** > - Customer data is deleted from all Applications in the > [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) > that the API key belongs to. For example, if you use this endpoint with an API key that belongs > to a sandbox Application, customer data will be deleted from all sandbox Applications. > This is because customer data is shared between Applications from the same environment. > - To preserve performance, we recommend avoiding deleting customer data > during peak-traffic hours.
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -1323,7 +1322,7 @@ public okhttp3.Call deleteCustomerDataAsync(String integrationId, final ApiCallb
/**
* Build call for deleteLoyaltyTransactionsFromLedgers
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param body (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -1394,9 +1393,9 @@ private okhttp3.Call deleteLoyaltyTransactionsFromLedgersValidateBeforeCall(Long
/**
* Delete customer's transactions from loyalty ledgers
- * Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+ * Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param body (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1414,9 +1413,9 @@ public void deleteLoyaltyTransactionsFromLedgers(Long loyaltyProgramId, String i
/**
* Delete customer's transactions from loyalty ledgers
- * Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+ * Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param body (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1436,9 +1435,9 @@ public ApiResponse deleteLoyaltyTransactionsFromLedgersWithHttpInfo(Long l
/**
* Delete customer's transactions from loyalty ledgers (asynchronously)
- * Delete a customer's transactions in all loyalty ledgers or a specified ledger. **Note:** To retrieve loyalty transaction logs for a specific customer in a given loyalty program, use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) endpoint.
+ * Delete a customer's transactions in all loyalty ledgers or a specified ledger. > [!note] To retrieve loyalty transaction logs for a specific customer in a given loyalty program, > use the [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) > endpoint.
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param body (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -1524,7 +1523,7 @@ private okhttp3.Call generateLoyaltyCardValidateBeforeCall(Long loyaltyProgramId
/**
* Generate loyalty card
- * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+ * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param body body (required)
* @return LoyaltyCard
@@ -1544,7 +1543,7 @@ public LoyaltyCard generateLoyaltyCard(Long loyaltyProgramId, GenerateLoyaltyCar
/**
* Generate loyalty card
- * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+ * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param body body (required)
* @return ApiResponse<LoyaltyCard>
@@ -1565,7 +1564,7 @@ public ApiResponse generateLoyaltyCardWithHttpInfo(Long loyaltyProg
/**
* Generate loyalty card (asynchronously)
- * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
+ * Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. > [!note] **Note** > - The number of customer profiles linked to the loyalty card cannot exceed > the loyalty program's `usersPerCardLimit`. To find the program's limit, use > the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) > endpoint. > - If the loyalty program has a defined code format, it will be used for the > loyalty card identifier.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param body body (required)
* @param _callback The callback to be executed when the API call finishes
@@ -1687,7 +1686,7 @@ private okhttp3.Call getCustomerAchievementHistoryValidateBeforeCall(String inte
* @param endDate Timestamp that filters the results to only contain achievements created before or on the end date. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @return InlineResponse2002
+ * @return InlineResponse2003
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1698,8 +1697,8 @@ private okhttp3.Call getCustomerAchievementHistoryValidateBeforeCall(String inte
| 404 | Not found | - |
*/
- public InlineResponse2002 getCustomerAchievementHistory(String integrationId, Long achievementId, List progressStatus, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip) throws ApiException {
- ApiResponse localVarResp = getCustomerAchievementHistoryWithHttpInfo(integrationId, achievementId, progressStatus, startDate, endDate, pageSize, skip);
+ public InlineResponse2003 getCustomerAchievementHistory(String integrationId, Long achievementId, List progressStatus, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip) throws ApiException {
+ ApiResponse localVarResp = getCustomerAchievementHistoryWithHttpInfo(integrationId, achievementId, progressStatus, startDate, endDate, pageSize, skip);
return localVarResp.getData();
}
@@ -1713,7 +1712,7 @@ public InlineResponse2002 getCustomerAchievementHistory(String integrationId, Lo
* @param endDate Timestamp that filters the results to only contain achievements created before or on the end date. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @return ApiResponse<InlineResponse2002>
+ * @return ApiResponse<InlineResponse2003>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1724,9 +1723,9 @@ public InlineResponse2002 getCustomerAchievementHistory(String integrationId, Lo
| 404 | Not found | - |
*/
- public ApiResponse getCustomerAchievementHistoryWithHttpInfo(String integrationId, Long achievementId, List progressStatus, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip) throws ApiException {
+ public ApiResponse getCustomerAchievementHistoryWithHttpInfo(String integrationId, Long achievementId, List progressStatus, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip) throws ApiException {
okhttp3.Call localVarCall = getCustomerAchievementHistoryValidateBeforeCall(integrationId, achievementId, progressStatus, startDate, endDate, pageSize, skip, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -1752,10 +1751,10 @@ public ApiResponse getCustomerAchievementHistoryWithHttpInfo
| 404 | Not found | - |
*/
- public okhttp3.Call getCustomerAchievementHistoryAsync(String integrationId, Long achievementId, List progressStatus, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getCustomerAchievementHistoryAsync(String integrationId, Long achievementId, List progressStatus, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getCustomerAchievementHistoryValidateBeforeCall(integrationId, achievementId, progressStatus, startDate, endDate, pageSize, skip, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
@@ -1858,7 +1857,7 @@ private okhttp3.Call getCustomerAchievementsValidateBeforeCall(String integratio
* @param currentProgressStatus Filter by customer progress status in the achievement. (optional)
* @param pageSize The number of items in the response. (optional, default to 1000l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @return InlineResponse2001
+ * @return InlineResponse2002
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -1869,8 +1868,8 @@ private okhttp3.Call getCustomerAchievementsValidateBeforeCall(String integratio
| 404 | Not found | - |
*/
- public InlineResponse2001 getCustomerAchievements(String integrationId, List campaignIds, List achievementIds, List achievementStatus, List currentProgressStatus, Long pageSize, Long skip) throws ApiException {
- ApiResponse localVarResp = getCustomerAchievementsWithHttpInfo(integrationId, campaignIds, achievementIds, achievementStatus, currentProgressStatus, pageSize, skip);
+ public InlineResponse2002 getCustomerAchievements(String integrationId, List campaignIds, List achievementIds, List achievementStatus, List currentProgressStatus, Long pageSize, Long skip) throws ApiException {
+ ApiResponse localVarResp = getCustomerAchievementsWithHttpInfo(integrationId, campaignIds, achievementIds, achievementStatus, currentProgressStatus, pageSize, skip);
return localVarResp.getData();
}
@@ -1884,7 +1883,7 @@ public InlineResponse2001 getCustomerAchievements(String integrationId, List
@@ -1895,9 +1894,9 @@ public InlineResponse2001 getCustomerAchievements(String integrationId, List 404 | Not found | - |
*/
- public ApiResponse getCustomerAchievementsWithHttpInfo(String integrationId, List campaignIds, List achievementIds, List achievementStatus, List currentProgressStatus, Long pageSize, Long skip) throws ApiException {
+ public ApiResponse getCustomerAchievementsWithHttpInfo(String integrationId, List campaignIds, List achievementIds, List achievementStatus, List currentProgressStatus, Long pageSize, Long skip) throws ApiException {
okhttp3.Call localVarCall = getCustomerAchievementsValidateBeforeCall(integrationId, campaignIds, achievementIds, achievementStatus, currentProgressStatus, pageSize, skip, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -1923,16 +1922,16 @@ public ApiResponse getCustomerAchievementsWithHttpInfo(Strin
| 404 | Not found | - |
*/
- public okhttp3.Call getCustomerAchievementsAsync(String integrationId, List campaignIds, List achievementIds, List achievementStatus, List currentProgressStatus, Long pageSize, Long skip, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getCustomerAchievementsAsync(String integrationId, List campaignIds, List achievementIds, List achievementStatus, List currentProgressStatus, Long pageSize, Long skip, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getCustomerAchievementsValidateBeforeCall(integrationId, campaignIds, achievementIds, achievementStatus, currentProgressStatus, pageSize, skip, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getCustomerInventory
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2021,7 +2020,7 @@ private okhttp3.Call getCustomerInventoryValidateBeforeCall(String integrationId
/**
* List customer data
* Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2046,7 +2045,7 @@ public CustomerInventory getCustomerInventory(String integrationId, Boolean prof
/**
* List customer data
* Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2072,7 +2071,7 @@ public ApiResponse getCustomerInventoryWithHttpInfo(String in
/**
* List customer data (asynchronously)
* Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
- * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. (required)
+ * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint. (required)
* @param profile Set to `true` to include customer profile information in the response. (optional)
* @param referrals Set to `true` to include referral information in the response. (optional)
* @param coupons Set to `true` to include coupon information in the response. (optional)
@@ -2099,7 +2098,7 @@ public okhttp3.Call getCustomerInventoryAsync(String integrationId, Boolean prof
}
/**
* Build call for getCustomerSession
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -2158,7 +2157,7 @@ private okhttp3.Call getCustomerSessionValidateBeforeCall(String customerSession
/**
* Get customer session
* Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @return IntegrationCustomerSessionResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2177,7 +2176,7 @@ public IntegrationCustomerSessionResponse getCustomerSession(String customerSess
/**
* Get customer session
* Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @return ApiResponse<IntegrationCustomerSessionResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2197,7 +2196,7 @@ public ApiResponse getCustomerSessionWithHtt
/**
* Get customer session (asynchronously)
* Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
- * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. (required)
+ * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -2220,7 +2219,7 @@ public okhttp3.Call getCustomerSessionAsync(String customerSessionId, final ApiC
* Build call for getLoyaltyBalances
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2304,10 +2303,10 @@ private okhttp3.Call getLoyaltyBalancesValidateBeforeCall(Long loyaltyProgramId,
/**
* Get customer's loyalty balances
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2329,10 +2328,10 @@ public LoyaltyBalancesWithTiers getLoyaltyBalances(Long loyaltyProgramId, String
/**
* Get customer's loyalty balances
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2355,10 +2354,10 @@ public ApiResponse getLoyaltyBalancesWithHttpInfo(Long
/**
* Get customer's loyalty balances (asynchronously)
- * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
+ * Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. > [!note] If no filtering options are applied, you retrieve all loyalty > balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param includeTiers Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional, default to false)
* @param includeProjectedTier Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional, default to false)
@@ -2384,8 +2383,8 @@ public okhttp3.Call getLoyaltyBalancesAsync(Long loyaltyProgramId, String integr
/**
* Build call for getLoyaltyCardBalances
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -2461,8 +2460,8 @@ private okhttp3.Call getLoyaltyCardBalancesValidateBeforeCall(Long loyaltyProgra
* Get card's point balances
* Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @return LoyaltyCardBalances
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2484,8 +2483,8 @@ public LoyaltyCardBalances getLoyaltyCardBalances(Long loyaltyProgramId, String
* Get card's point balances
* Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @return ApiResponse<LoyaltyCardBalances>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -2508,8 +2507,8 @@ public ApiResponse getLoyaltyCardBalancesWithHttpInfo(Long
* Get card's point balances (asynchronously)
* Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
+ * @param endDate Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -2533,14 +2532,14 @@ public okhttp3.Call getLoyaltyCardBalancesAsync(Long loyaltyProgramId, String lo
/**
* Build call for getLoyaltyCardPoints
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
+ * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -2635,15 +2634,15 @@ private okhttp3.Call getLoyaltyCardPointsValidateBeforeCall(Long loyaltyProgramI
* List card's unused loyalty points
* Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
- * @return InlineResponse2005
+ * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
+ * @return InlineResponse2006
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2654,8 +2653,8 @@ private okhttp3.Call getLoyaltyCardPointsValidateBeforeCall(Long loyaltyProgramI
| 404 | Not found | - |
*/
- public InlineResponse2005 getLoyaltyCardPoints(Long loyaltyProgramId, String loyaltyCardId, String status, List subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
- ApiResponse localVarResp = getLoyaltyCardPointsWithHttpInfo(loyaltyProgramId, loyaltyCardId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort);
+ public InlineResponse2006 getLoyaltyCardPoints(Long loyaltyProgramId, String loyaltyCardId, String status, List subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
+ ApiResponse localVarResp = getLoyaltyCardPointsWithHttpInfo(loyaltyProgramId, loyaltyCardId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort);
return localVarResp.getData();
}
@@ -2663,15 +2662,15 @@ public InlineResponse2005 getLoyaltyCardPoints(Long loyaltyProgramId, String loy
* List card's unused loyalty points
* Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
- * @return ApiResponse<InlineResponse2005>
+ * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
+ * @return ApiResponse<InlineResponse2006>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2682,9 +2681,9 @@ public InlineResponse2005 getLoyaltyCardPoints(Long loyaltyProgramId, String loy
| 404 | Not found | - |
*/
- public ApiResponse getLoyaltyCardPointsWithHttpInfo(Long loyaltyProgramId, String loyaltyCardId, String status, List subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
+ public ApiResponse getLoyaltyCardPointsWithHttpInfo(Long loyaltyProgramId, String loyaltyCardId, String status, List subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyCardPointsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -2692,14 +2691,14 @@ public ApiResponse getLoyaltyCardPointsWithHttpInfo(Long loy
* List card's unused loyalty points (asynchronously)
* Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param status Filter points based on their status. (optional, default to active)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
- * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
+ * @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -2712,23 +2711,23 @@ public ApiResponse getLoyaltyCardPointsWithHttpInfo(Long loy
| 404 | Not found | - |
*/
- public okhttp3.Call getLoyaltyCardPointsAsync(Long loyaltyProgramId, String loyaltyCardId, String status, List subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getLoyaltyCardPointsAsync(Long loyaltyProgramId, String loyaltyCardId, String status, List subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyCardPointsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getLoyaltyCardTransactions
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -2834,17 +2833,17 @@ private okhttp3.Call getLoyaltyCardTransactionsValidateBeforeCall(Long loyaltyPr
* List card's transactions
* Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
- * @return InlineResponse2003
+ * @return InlineResponse2004
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2855,8 +2854,8 @@ private okhttp3.Call getLoyaltyCardTransactionsValidateBeforeCall(Long loyaltyPr
| 404 | Not found | - |
*/
- public InlineResponse2003 getLoyaltyCardTransactions(Long loyaltyProgramId, String loyaltyCardId, List subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
- ApiResponse localVarResp = getLoyaltyCardTransactionsWithHttpInfo(loyaltyProgramId, loyaltyCardId, subledgerId, loyaltyTransactionType, startDate, endDate, customerSessionIDs, transactionUUIDs, pageSize, skip, awaitsActivation);
+ public InlineResponse2004 getLoyaltyCardTransactions(Long loyaltyProgramId, String loyaltyCardId, List subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
+ ApiResponse localVarResp = getLoyaltyCardTransactionsWithHttpInfo(loyaltyProgramId, loyaltyCardId, subledgerId, loyaltyTransactionType, startDate, endDate, customerSessionIDs, transactionUUIDs, pageSize, skip, awaitsActivation);
return localVarResp.getData();
}
@@ -2864,17 +2863,17 @@ public InlineResponse2003 getLoyaltyCardTransactions(Long loyaltyProgramId, Stri
* List card's transactions
* Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
- * @return ApiResponse<InlineResponse2003>
+ * @return ApiResponse<InlineResponse2004>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -2885,9 +2884,9 @@ public InlineResponse2003 getLoyaltyCardTransactions(Long loyaltyProgramId, Stri
| 404 | Not found | - |
*/
- public ApiResponse getLoyaltyCardTransactionsWithHttpInfo(Long loyaltyProgramId, String loyaltyCardId, List subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
+ public ApiResponse getLoyaltyCardTransactionsWithHttpInfo(Long loyaltyProgramId, String loyaltyCardId, List subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyCardTransactionsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, subledgerId, loyaltyTransactionType, startDate, endDate, customerSessionIDs, transactionUUIDs, pageSize, skip, awaitsActivation, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -2895,13 +2894,13 @@ public ApiResponse getLoyaltyCardTransactionsWithHttpInfo(Lo
* List card's transactions (asynchronously)
* Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
* @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
+ * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`. (required)
* @param subledgerId Filter results by one or more subledger IDs. Must be exact match. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -2917,10 +2916,10 @@ public ApiResponse getLoyaltyCardTransactionsWithHttpInfo(Lo
| 404 | Not found | - |
*/
- public okhttp3.Call getLoyaltyCardTransactionsAsync(Long loyaltyProgramId, String loyaltyCardId, List subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, Boolean awaitsActivation, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getLoyaltyCardTransactionsAsync(Long loyaltyProgramId, String loyaltyCardId, List subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, Boolean awaitsActivation, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyCardTransactionsValidateBeforeCall(loyaltyProgramId, loyaltyCardId, subledgerId, loyaltyTransactionType, startDate, endDate, customerSessionIDs, transactionUUIDs, pageSize, skip, awaitsActivation, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
@@ -3037,7 +3036,7 @@ private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(Long loyal
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
- * @return InlineResponse2006
+ * @return InlineResponse2007
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3048,8 +3047,8 @@ private okhttp3.Call getLoyaltyProgramProfilePointsValidateBeforeCall(Long loyal
| 404 | Not found | - |
*/
- public InlineResponse2006 getLoyaltyProgramProfilePoints(Long loyaltyProgramId, String integrationId, String status, String subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
- ApiResponse localVarResp = getLoyaltyProgramProfilePointsWithHttpInfo(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort);
+ public InlineResponse2007 getLoyaltyProgramProfilePoints(Long loyaltyProgramId, String integrationId, String status, String subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
+ ApiResponse localVarResp = getLoyaltyProgramProfilePointsWithHttpInfo(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort);
return localVarResp.getData();
}
@@ -3065,7 +3064,7 @@ public InlineResponse2006 getLoyaltyProgramProfilePoints(Long loyaltyProgramId,
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time. (optional)
- * @return ApiResponse<InlineResponse2006>
+ * @return ApiResponse<InlineResponse2007>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3076,9 +3075,9 @@ public InlineResponse2006 getLoyaltyProgramProfilePoints(Long loyaltyProgramId,
| 404 | Not found | - |
*/
- public ApiResponse getLoyaltyProgramProfilePointsWithHttpInfo(Long loyaltyProgramId, String integrationId, String status, String subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
+ public ApiResponse getLoyaltyProgramProfilePointsWithHttpInfo(Long loyaltyProgramId, String integrationId, String status, String subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyProgramProfilePointsValidateBeforeCall(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -3106,10 +3105,10 @@ public ApiResponse getLoyaltyProgramProfilePointsWithHttpInf
| 404 | Not found | - |
*/
- public okhttp3.Call getLoyaltyProgramProfilePointsAsync(Long loyaltyProgramId, String integrationId, String status, String subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getLoyaltyProgramProfilePointsAsync(Long loyaltyProgramId, String integrationId, String status, String subledgerId, List customerSessionIDs, List transactionUUIDs, Long pageSize, Long skip, String sort, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyProgramProfilePointsValidateBeforeCall(loyaltyProgramId, integrationId, status, subledgerId, customerSessionIDs, transactionUUIDs, pageSize, skip, sort, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
@@ -3117,12 +3116,12 @@ public okhttp3.Call getLoyaltyProgramProfilePointsAsync(Long loyaltyProgramId, S
* Build call for getLoyaltyProgramProfileTransactions
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -3226,19 +3225,19 @@ private okhttp3.Call getLoyaltyProgramProfileTransactionsValidateBeforeCall(Long
/**
* List customer's loyalty transactions
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
- * @return InlineResponse2004
+ * @return InlineResponse2005
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3249,26 +3248,26 @@ private okhttp3.Call getLoyaltyProgramProfileTransactionsValidateBeforeCall(Long
| 404 | Not found | - |
*/
- public InlineResponse2004 getLoyaltyProgramProfileTransactions(Long loyaltyProgramId, String integrationId, List customerSessionIDs, List transactionUUIDs, String subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
- ApiResponse localVarResp = getLoyaltyProgramProfileTransactionsWithHttpInfo(loyaltyProgramId, integrationId, customerSessionIDs, transactionUUIDs, subledgerId, loyaltyTransactionType, startDate, endDate, pageSize, skip, awaitsActivation);
+ public InlineResponse2005 getLoyaltyProgramProfileTransactions(Long loyaltyProgramId, String integrationId, List customerSessionIDs, List transactionUUIDs, String subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
+ ApiResponse localVarResp = getLoyaltyProgramProfileTransactionsWithHttpInfo(loyaltyProgramId, integrationId, customerSessionIDs, transactionUUIDs, subledgerId, loyaltyTransactionType, startDate, endDate, pageSize, skip, awaitsActivation);
return localVarResp.getData();
}
/**
* List customer's loyalty transactions
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
- * @return ApiResponse<InlineResponse2004>
+ * @return ApiResponse<InlineResponse2005>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3279,23 +3278,23 @@ public InlineResponse2004 getLoyaltyProgramProfileTransactions(Long loyaltyProgr
| 404 | Not found | - |
*/
- public ApiResponse getLoyaltyProgramProfileTransactionsWithHttpInfo(Long loyaltyProgramId, String integrationId, List customerSessionIDs, List transactionUUIDs, String subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
+ public ApiResponse getLoyaltyProgramProfileTransactionsWithHttpInfo(Long loyaltyProgramId, String integrationId, List customerSessionIDs, List transactionUUIDs, String subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, Boolean awaitsActivation) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyProgramProfileTransactionsValidateBeforeCall(loyaltyProgramId, integrationId, customerSessionIDs, transactionUUIDs, subledgerId, loyaltyTransactionType, startDate, endDate, pageSize, skip, awaitsActivation, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* List customer's loyalty transactions (asynchronously)
- * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
+ * Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. > [!note] To retrieve all loyalty program transaction logs in a given > loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) > endpoint.
* @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
* @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. (required)
- * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
- * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
+ * @param customerSessionIDs Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. (optional)
+ * @param transactionUUIDs Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. (optional)
* @param subledgerId The ID of the subledger by which we filter the data. (optional)
* @param loyaltyTransactionType Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. (optional)
- * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
- * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startDate Date and time from which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endDate Date and time by which results are returned. Results are filtered by transaction creation date. > [!note] **Note** > - This must be an RFC3339 timestamp string. > - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting > considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param pageSize The number of items in the response. (optional, default to 50l)
* @param skip The number of items to skip when paging through large result sets. (optional)
* @param awaitsActivation If `true`: Filters results to include only point transactions that have action-based activation and have not expired. If `false`: Returns a `400` response. (optional)
@@ -3311,10 +3310,10 @@ public ApiResponse getLoyaltyProgramProfileTransactionsWithH
| 404 | Not found | - |
*/
- public okhttp3.Call getLoyaltyProgramProfileTransactionsAsync(Long loyaltyProgramId, String integrationId, List customerSessionIDs, List transactionUUIDs, String subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, Boolean awaitsActivation, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getLoyaltyProgramProfileTransactionsAsync(Long loyaltyProgramId, String integrationId, List customerSessionIDs, List transactionUUIDs, String subledgerId, String loyaltyTransactionType, OffsetDateTime startDate, OffsetDateTime endDate, Long pageSize, Long skip, Boolean awaitsActivation, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getLoyaltyProgramProfileTransactionsValidateBeforeCall(loyaltyProgramId, integrationId, customerSessionIDs, transactionUUIDs, subledgerId, loyaltyTransactionType, startDate, endDate, pageSize, skip, awaitsActivation, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
@@ -3381,7 +3380,7 @@ private okhttp3.Call getReservedCustomersValidateBeforeCall(String couponValue,
* List customers that have this coupon reserved
* Return all customers that have this coupon marked as reserved. This includes hard and soft reservations.
* @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
- * @return InlineResponse200
+ * @return InlineResponse2001
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3392,8 +3391,8 @@ private okhttp3.Call getReservedCustomersValidateBeforeCall(String couponValue,
| 404 | Not found | - |
*/
- public InlineResponse200 getReservedCustomers(String couponValue) throws ApiException {
- ApiResponse localVarResp = getReservedCustomersWithHttpInfo(couponValue);
+ public InlineResponse2001 getReservedCustomers(String couponValue) throws ApiException {
+ ApiResponse localVarResp = getReservedCustomersWithHttpInfo(couponValue);
return localVarResp.getData();
}
@@ -3401,7 +3400,7 @@ public InlineResponse200 getReservedCustomers(String couponValue) throws ApiExce
* List customers that have this coupon reserved
* Return all customers that have this coupon marked as reserved. This includes hard and soft reservations.
* @param couponValue The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`. (required)
- * @return ApiResponse<InlineResponse200>
+ * @return ApiResponse<InlineResponse2001>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3412,9 +3411,9 @@ public InlineResponse200 getReservedCustomers(String couponValue) throws ApiExce
| 404 | Not found | - |
*/
- public ApiResponse getReservedCustomersWithHttpInfo(String couponValue) throws ApiException {
+ public ApiResponse getReservedCustomersWithHttpInfo(String couponValue) throws ApiException {
okhttp3.Call localVarCall = getReservedCustomersValidateBeforeCall(couponValue, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -3434,18 +3433,22 @@ public ApiResponse getReservedCustomersWithHttpInfo(String co
| 404 | Not found | - |
*/
- public okhttp3.Call getReservedCustomersAsync(String couponValue, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getReservedCustomersAsync(String couponValue, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getReservedCustomersValidateBeforeCall(couponValue, _callback);
- Type localVarReturnType = new TypeToken(){}.getType();
+ Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
- * Build call for linkLoyaltyCardToProfile
- * @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param body body (required)
+ * Build call for integrationGetAllCampaigns
+ * @param pageSize The number of items in the response. (optional, default to 50l)
+ * @param skip The number of items to skip when paging through large result sets. (optional)
+ * @param campaignIds Filter by one or more campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
+ * @param startAfter Filter results to only include campaigns that start on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startBefore Filter results to only include campaigns that start on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endAfter Filter results to only include campaigns that end on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endBefore Filter results to only include campaigns that end on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
@@ -3458,16 +3461,42 @@ public okhttp3.Call getReservedCustomersAsync(String couponValue, final ApiCallb
| 404 | Not found | - |
*/
- public okhttp3.Call linkLoyaltyCardToProfileCall(Long loyaltyProgramId, String loyaltyCardId, LoyaltyCardRegistration body, final ApiCallback _callback) throws ApiException {
- Object localVarPostBody = body;
+ public okhttp3.Call integrationGetAllCampaignsCall(Long pageSize, Long skip, List campaignIds, OffsetDateTime startAfter, OffsetDateTime startBefore, OffsetDateTime endAfter, OffsetDateTime endBefore, final ApiCallback _callback) throws ApiException {
+ Object localVarPostBody = null;
// create path and map variables
- String localVarPath = "/v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile"
- .replaceAll("\\{" + "loyaltyProgramId" + "\\}", localVarApiClient.escapeString(loyaltyProgramId.toString()))
- .replaceAll("\\{" + "loyaltyCardId" + "\\}", localVarApiClient.escapeString(loyaltyCardId.toString()));
+ String localVarPath = "/v1/integration/campaigns";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
+ if (pageSize != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("pageSize", pageSize));
+ }
+
+ if (skip != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("skip", skip));
+ }
+
+ if (campaignIds != null) {
+ localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "campaignIds", campaignIds));
+ }
+
+ if (startAfter != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAfter", startAfter));
+ }
+
+ if (startBefore != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("startBefore", startBefore));
+ }
+
+ if (endAfter != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("endAfter", endAfter));
+ }
+
+ if (endBefore != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("endBefore", endBefore));
+ }
+
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
@@ -3480,46 +3509,35 @@ public okhttp3.Call linkLoyaltyCardToProfileCall(Long loyaltyProgramId, String l
}
final String[] localVarContentTypes = {
- "application/json"
+
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "api_key_v1" };
- return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call linkLoyaltyCardToProfileValidateBeforeCall(Long loyaltyProgramId, String loyaltyCardId, LoyaltyCardRegistration body, final ApiCallback _callback) throws ApiException {
-
- // verify the required parameter 'loyaltyProgramId' is set
- if (loyaltyProgramId == null) {
- throw new ApiException("Missing the required parameter 'loyaltyProgramId' when calling linkLoyaltyCardToProfile(Async)");
- }
-
- // verify the required parameter 'loyaltyCardId' is set
- if (loyaltyCardId == null) {
- throw new ApiException("Missing the required parameter 'loyaltyCardId' when calling linkLoyaltyCardToProfile(Async)");
- }
-
- // verify the required parameter 'body' is set
- if (body == null) {
- throw new ApiException("Missing the required parameter 'body' when calling linkLoyaltyCardToProfile(Async)");
- }
+ private okhttp3.Call integrationGetAllCampaignsValidateBeforeCall(Long pageSize, Long skip, List campaignIds, OffsetDateTime startAfter, OffsetDateTime startBefore, OffsetDateTime endAfter, OffsetDateTime endBefore, final ApiCallback _callback) throws ApiException {
- okhttp3.Call localVarCall = linkLoyaltyCardToProfileCall(loyaltyProgramId, loyaltyCardId, body, _callback);
+ okhttp3.Call localVarCall = integrationGetAllCampaignsCall(pageSize, skip, campaignIds, startAfter, startBefore, endAfter, endBefore, _callback);
return localVarCall;
}
/**
- * Link customer profile to card
- * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
- * @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param body body (required)
- * @return LoyaltyCard
+ * List all running campaigns
+ * Retrieve all running campaigns for the specified Application. You can filter the results by providing specific campaign IDs or a range of start and end dates.
+ * @param pageSize The number of items in the response. (optional, default to 50l)
+ * @param skip The number of items to skip when paging through large result sets. (optional)
+ * @param campaignIds Filter by one or more campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
+ * @param startAfter Filter results to only include campaigns that start on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startBefore Filter results to only include campaigns that start on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endAfter Filter results to only include campaigns that end on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endBefore Filter results to only include campaigns that end on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @return InlineResponse200
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3530,18 +3548,22 @@ private okhttp3.Call linkLoyaltyCardToProfileValidateBeforeCall(Long loyaltyProg
| 404 | Not found | - |
*/
- public LoyaltyCard linkLoyaltyCardToProfile(Long loyaltyProgramId, String loyaltyCardId, LoyaltyCardRegistration body) throws ApiException {
- ApiResponse localVarResp = linkLoyaltyCardToProfileWithHttpInfo(loyaltyProgramId, loyaltyCardId, body);
+ public InlineResponse200 integrationGetAllCampaigns(Long pageSize, Long skip, List campaignIds, OffsetDateTime startAfter, OffsetDateTime startBefore, OffsetDateTime endAfter, OffsetDateTime endBefore) throws ApiException {
+ ApiResponse localVarResp = integrationGetAllCampaignsWithHttpInfo(pageSize, skip, campaignIds, startAfter, startBefore, endAfter, endBefore);
return localVarResp.getData();
}
/**
- * Link customer profile to card
- * [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
- * @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. (required)
- * @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. (required)
- * @param body body (required)
- * @return ApiResponse<LoyaltyCard>
+ * List all running campaigns
+ * Retrieve all running campaigns for the specified Application. You can filter the results by providing specific campaign IDs or a range of start and end dates.
+ * @param pageSize The number of items in the response. (optional, default to 50l)
+ * @param skip The number of items to skip when paging through large result sets. (optional)
+ * @param campaignIds Filter by one or more campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. (optional)
+ * @param startAfter Filter results to only include campaigns that start on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param startBefore Filter results to only include campaigns that start on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endAfter Filter results to only include campaigns that end on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @param endBefore Filter results to only include campaigns that end on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional)
+ * @return ApiResponse<InlineResponse200>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -3552,18 +3574,22 @@ public LoyaltyCard linkLoyaltyCardToProfile(Long loyaltyProgramId, String loyalt
|