IntegrationApi.md

TalonOne.IntegrationApi

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

Method	HTTP request	Description
createAudienceV2	POST /v2/audiences	Create audience
createCouponReservation	POST /v1/coupon_reservations/{couponValue}	Create coupon reservation
createReferral	POST /v1/referrals	Create referral code for an advocate
createReferralsForMultipleAdvocates	POST /v1/referrals_for_multiple_advocates	Create referral codes for multiple advocates
deleteAudienceMembershipsV2	DELETE /v2/audiences/{audienceId}/memberships	Delete audience memberships
deleteAudienceV2	DELETE /v2/audiences/{audienceId}	Delete audience
deleteCouponReservation	DELETE /v1/coupon_reservations/{couponValue}	Delete coupon reservations
deleteCustomerData	DELETE /v1/customer_data/{integrationId}	Delete customer's personal data
generateLoyaltyCard	POST /v1/loyalty_programs/{loyaltyProgramId}/cards	Generate loyalty card
getCustomerInventory	GET /v1/customer_profiles/{integrationId}/inventory	List customer data
getCustomerSession	GET /v2/customer_sessions/{customerSessionId}	Get customer session
getLoyaltyBalances	GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances	Get customer's loyalty points
getLoyaltyCardBalances	GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances	Get card's point balances
getLoyaltyCardPoints	GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points	List card's unused loyalty points
getLoyaltyCardTransactions	GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions	List card's transactions
getLoyaltyProgramProfilePoints	GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points	List customer's unused loyalty points
getLoyaltyProgramProfileTransactions	GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions	List customer's loyalty transactions
getReservedCustomers	GET /v1/coupon_reservations/customerprofiles/{couponValue}	List customers that have this coupon reserved
linkLoyaltyCardToProfile	POST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile	Link customer profile to card
reopenCustomerSession	PUT /v2/customer_sessions/{customerSessionId}/reopen	Reopen customer session
returnCartItems	POST /v2/customer_sessions/{customerSessionId}/returns	Return cart items
syncCatalog	PUT /v1/catalogs/{catalogId}/sync	Sync cart item catalog
trackEventV2	POST /v2/events	Track event
updateAudienceCustomersAttributes	PUT /v2/audience_customers/{audienceId}/attributes	Update profile attributes for all customers in audience
updateAudienceV2	PUT /v2/audiences/{audienceId}	Update audience name
updateCustomerProfileAudiences	POST /v2/customer_audiences	Update multiple customer profiles' audiences
updateCustomerProfileV2	PUT /v2/customer_profiles/{integrationId}	Update customer profile
updateCustomerProfilesV2	PUT /v2/customer_profiles	Update multiple customer profiles
updateCustomerSessionV2	PUT /v2/customer_sessions/{customerSessionId}	Update customer session

createAudienceV2

Audience createAudienceV2(body)

Create audience

Create an audience. The audience can be created directly from scratch or can come from third party platforms. Note: Audiences can also be created from scratch via the Campaign Manager. See the docs. To create an audience from an existing audience from a technology partner: 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.NewAudience(); // NewAudience | body
apiInstance.createAudienceV2(body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	NewAudience	body

Return type

Audience

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createCouponReservation

Coupon createCouponReservation(couponValue, body)

Create coupon reservation

Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the Create coupon code reservation effect. - If the Reservation mandatory option was selected when creating the specified coupon, the endpoint creates a hard reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a soft reservation, meaning the coupon will be associated with the specified customer profiles (they show up when using the List customer data endpoint), but any user can redeem it. This can be useful, for example, to display a coupon wallet for customers when they visit your store. - If the Coupon visibility option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the List customer data endpoint. To delete a reservation, use the Delete reservation endpoint.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let couponValue = "couponValue_example"; // String | The code of the coupon.
let body = new TalonOne.CouponReservations(); // CouponReservations | body
apiInstance.createCouponReservation(couponValue, body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
couponValue	String	The code of the coupon.
body	CouponReservations	body

Return type

Coupon

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createReferral

Referral createReferral(body)

Create referral code for an advocate

Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.NewReferral(); // NewReferral | body
apiInstance.createReferral(body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	NewReferral	body

Return type

Referral

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createReferralsForMultipleAdvocates

InlineResponse201 createReferralsForMultipleAdvocates(body, opts)

Create referral codes for multiple advocates

Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.NewReferralsForMultipleAdvocates(); // NewReferralsForMultipleAdvocates | body
let opts = {
  'silent': "'yes'" // String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
};
apiInstance.createReferralsForMultipleAdvocates(body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	NewReferralsForMultipleAdvocates	body
silent	String	Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.	[optional] [default to 'yes']

Return type

InlineResponse201

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteAudienceMembershipsV2

deleteAudienceMembershipsV2(audienceId)

Delete audience memberships

Remove all members from this audience.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let audienceId = 56; // Number | The ID of the audience.
apiInstance.deleteAudienceMembershipsV2(audienceId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
audienceId	Number	The ID of the audience.

Return type

null (empty response body)

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteAudienceV2

deleteAudienceV2(audienceId)

Delete audience

Delete an audience created by a third-party integration. Warning: This endpoint also removes any associations recorded between a customer profile and this audience. Note: Audiences can also be deleted via the Campaign Manager. See the docs.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let audienceId = 56; // Number | The ID of the audience.
apiInstance.deleteAudienceV2(audienceId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
audienceId	Number	The ID of the audience.

Return type

null (empty response body)

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteCouponReservation

deleteCouponReservation(couponValue, body)

Delete coupon reservations

Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let couponValue = "couponValue_example"; // String | The code of the coupon.
let body = new TalonOne.CouponReservations(); // CouponReservations | body
apiInstance.deleteCouponReservation(couponValue, body).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
couponValue	String	The code of the coupon.
body	CouponReservations	body

Return type

null (empty response body)

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteCustomerData

deleteCustomerData(integrationId)

Delete customer's personal data

Delete all attributes on the customer profile and on entities that reference this customer profile. Important: To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let integrationId = "integrationId_example"; // String | 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. 
apiInstance.deleteCustomerData(integrationId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
integrationId	String	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 endpoint. - The Management API with the List application's customers endpoint.

Return type

null (empty response body)

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

generateLoyaltyCard

LoyaltyCard generateLoyaltyCard(loyaltyProgramId, body)

Generate loyalty card

Generate a loyalty card in a specified card-based loyalty program. 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 endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let body = new TalonOne.GenerateLoyaltyCard(); // GenerateLoyaltyCard | body
apiInstance.generateLoyaltyCard(loyaltyProgramId, body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
body	GenerateLoyaltyCard	body

Return type

LoyaltyCard

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getCustomerInventory

CustomerInventory getCustomerInventory(integrationId, opts)

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.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let integrationId = "integrationId_example"; // String | 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. 
let opts = {
  'profile': true, // Boolean | Set to `true` to include customer profile information in the response.
  'referrals': true, // Boolean | Set to `true` to include referral information in the response.
  'coupons': true, // Boolean | Set to `true` to include coupon information in the response.
  'loyalty': true, // Boolean | Set to `true` to include loyalty information in the response.
  'giveaways': true, // Boolean | Set to `true` to include giveaways information in the response.
  'achievements': true // Boolean | Set to `true` to include achievement information in the response.
};
apiInstance.getCustomerInventory(integrationId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
integrationId	String	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 endpoint. - The Management API with the List application's customers endpoint.
profile	Boolean	Set to `true` to include customer profile information in the response.	[optional]
referrals	Boolean	Set to `true` to include referral information in the response.	[optional]
coupons	Boolean	Set to `true` to include coupon information in the response.	[optional]
loyalty	Boolean	Set to `true` to include loyalty information in the response.	[optional]
giveaways	Boolean	Set to `true` to include giveaways information in the response.	[optional]
achievements	Boolean	Set to `true` to include achievement information in the response.	[optional]

Return type

CustomerInventory

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getCustomerSession

IntegrationCustomerSessionResponse getCustomerSession(customerSessionId)

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 - Update customer profile

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let customerSessionId = "customerSessionId_example"; // String | 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. 
apiInstance.getCustomerSession(customerSessionId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
customerSessionId	String	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 endpoint.

Return type

IntegrationCustomerSessionResponse

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLoyaltyBalances

LoyaltyBalancesWithTiers getLoyaltyBalances(loyaltyProgramId, integrationId, opts)

Get customer's loyalty points

Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. 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 - Managing profile-based loyalty program data

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let integrationId = "integrationId_example"; // String | 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. 
let opts = {
  'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 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. 
  'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data.
  'includeTiers': false, // Boolean | 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. 
  'includeProjectedTier': false // Boolean | 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. 
};
apiInstance.getLoyaltyBalances(loyaltyProgramId, integrationId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the profile-based loyalty program. You can get the ID with the List loyalty programs endpoint.
integrationId	String	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.
endDate	Date	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]
subledgerId	String	The ID of the subledger by which we filter the data.	[optional]
includeTiers	Boolean	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]
includeProjectedTier	Boolean	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]

Return type

LoyaltyBalancesWithTiers

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLoyaltyCardBalances

LoyaltyCardBalances getLoyaltyCardBalances(loyaltyProgramId, loyaltyCardId, opts)

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.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let loyaltyCardId = "loyaltyCardId_example"; // String | 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. 
let opts = {
  'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 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. 
  'subledgerId': ["null"] // [String] | Filter results by one or more subledger IDs. Must be exact match.
};
apiInstance.getLoyaltyCardBalances(loyaltyProgramId, loyaltyCardId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	String	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
endDate	Date	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]
subledgerId	[String]	Filter results by one or more subledger IDs. Must be exact match.	[optional]

Return type

LoyaltyCardBalances

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLoyaltyCardPoints

InlineResponse2003 getLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, opts)

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.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let loyaltyCardId = "loyaltyCardId_example"; // String | 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. 
let opts = {
  'status': "'active'", // String | Filter points based on their status.
  'subledgerId': ["null"], // [String] | Filter results by one or more subledger IDs. Must be exact match.
  'pageSize': 50, // Number | The number of items in the response.
  'skip': 56 // Number | The number of items to skip when paging through large result sets.
};
apiInstance.getLoyaltyCardPoints(loyaltyProgramId, loyaltyCardId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	String	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
status	String	Filter points based on their status.	[optional] [default to 'active']
subledgerId	[String]	Filter results by one or more subledger IDs. Must be exact match.	[optional]
pageSize	Number	The number of items in the response.	[optional] [default to 50]
skip	Number	The number of items to skip when paging through large result sets.	[optional]

Return type

InlineResponse2003

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLoyaltyCardTransactions

InlineResponse2001 getLoyaltyCardTransactions(loyaltyProgramId, loyaltyCardId, opts)

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.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let loyaltyCardId = "loyaltyCardId_example"; // String | 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. 
let opts = {
  'subledgerId': ["null"], // [String] | Filter results by one or more subledger IDs. Must be exact match.
  'loyaltyTransactionType': "loyaltyTransactionType_example", // String | 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. 
  'startDate': new Date("2013-10-20T19:20:30+01:00"), // 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. 
  'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 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. 
  'pageSize': 1000, // Number | The number of items in the response.
  'skip': 56 // Number | The number of items to skip when paging through large result sets.
};
apiInstance.getLoyaltyCardTransactions(loyaltyProgramId, loyaltyCardId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	String	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
subledgerId	[String]	Filter results by one or more subledger IDs. Must be exact match.	[optional]
loyaltyTransactionType	String	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]
startDate	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.	[optional]
endDate	Date	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]
pageSize	Number	The number of items in the response.	[optional] [default to 1000]
skip	Number	The number of items to skip when paging through large result sets.	[optional]

Return type

InlineResponse2001

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLoyaltyProgramProfilePoints

InlineResponse2004 getLoyaltyProgramProfilePoints(loyaltyProgramId, integrationId, opts)

List customer's unused loyalty points

Get paginated results of loyalty points for a given Integration ID in the specified profile-based loyalty program. This endpoint returns only the balances of unused points linked to a customer profile. 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.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let integrationId = "integrationId_example"; // String | 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. 
let opts = {
  'status': "'active'", // String | Filter points based on their status.
  'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data.
  'pageSize': 50, // Number | The number of items in the response.
  'skip': 56 // Number | The number of items to skip when paging through large result sets.
};
apiInstance.getLoyaltyProgramProfilePoints(loyaltyProgramId, integrationId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the profile-based loyalty program. You can get the ID with the List loyalty programs endpoint.
integrationId	String	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.
status	String	Filter points based on their status.	[optional] [default to 'active']
subledgerId	String	The ID of the subledger by which we filter the data.	[optional]
pageSize	Number	The number of items in the response.	[optional] [default to 50]
skip	Number	The number of items to skip when paging through large result sets.	[optional]

Return type

InlineResponse2004

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLoyaltyProgramProfileTransactions

InlineResponse2002 getLoyaltyProgramProfileTransactions(loyaltyProgramId, integrationId, opts)

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 endpoint.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let integrationId = "integrationId_example"; // String | 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. 
let opts = {
  'subledgerId': "subledgerId_example", // String | The ID of the subledger by which we filter the data.
  'loyaltyTransactionType': "loyaltyTransactionType_example", // String | 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. 
  'startDate': new Date("2013-10-20T19:20:30+01:00"), // 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. 
  'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 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. 
  'pageSize': 50, // Number | The number of items in the response.
  'skip': 56 // Number | The number of items to skip when paging through large result sets.
};
apiInstance.getLoyaltyProgramProfileTransactions(loyaltyProgramId, integrationId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the profile-based loyalty program. You can get the ID with the List loyalty programs endpoint.
integrationId	String	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.
subledgerId	String	The ID of the subledger by which we filter the data.	[optional]
loyaltyTransactionType	String	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]
startDate	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.	[optional]
endDate	Date	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]
pageSize	Number	The number of items in the response.	[optional] [default to 50]
skip	Number	The number of items to skip when paging through large result sets.	[optional]

Return type

InlineResponse2002

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getReservedCustomers

InlineResponse200 getReservedCustomers(couponValue)

List customers that have this coupon reserved

Return all customers that have this coupon marked as reserved. This includes hard and soft reservations.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let couponValue = "couponValue_example"; // String | The code of the coupon.
apiInstance.getReservedCustomers(couponValue).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
couponValue	String	The code of the coupon.

Return type

InlineResponse200

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

linkLoyaltyCardToProfile

LoyaltyCard linkLoyaltyCardToProfile(loyaltyProgramId, loyaltyCardId, body)

Link customer profile to card

Loyalty cards allow customers to collect and spend loyalty points within a card-based loyalty program. 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. Note: You can link as many customer profiles to a given loyalty card as the card user limit allows.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let loyaltyProgramId = 56; // Number | 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. 
let loyaltyCardId = "loyaltyCardId_example"; // String | 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. 
let body = new TalonOne.LoyaltyCardRegistration(); // LoyaltyCardRegistration | body
apiInstance.linkLoyaltyCardToProfile(loyaltyProgramId, loyaltyCardId, body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
loyaltyProgramId	Number	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	String	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
body	LoyaltyCardRegistration	body

Return type

LoyaltyCard

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reopenCustomerSession

ReopenSessionResponse reopenCustomerSession(customerSessionId)

Reopen customer session

Reopen a closed customer session. 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`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets are left the way they were once the session was originally closed:</p> <ul> <li>Add free item effect</li> <li>Any <strong>non-pending</strong> loyalty points</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> <p>To see an example of roll back, see the <a href=&quot;https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\&quot;&gt;Cancelling a session with campaign budgets tutorial</a>.</p> </details> Note: If your order workflow requires you to create a new session instead of reopening a session, use the Update customer session endpoint to cancel a closed session and create a new one.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let customerSessionId = "customerSessionId_example"; // String | 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. 
apiInstance.reopenCustomerSession(customerSessionId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
customerSessionId	String	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 endpoint.

Return type

ReopenSessionResponse

Authorization

api_key_v1

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

returnCartItems

IntegrationStateV2 returnCartItems(customerSessionId, body, opts)

Return cart items

Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. Note: This will roll back any effects associated with these cart items. For more information, see our documentation on session states and this tutorial.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let customerSessionId = "customerSessionId_example"; // String | 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. 
let body = new TalonOne.ReturnIntegrationRequest(); // ReturnIntegrationRequest | body
let opts = {
  'dry': true // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. 
};
apiInstance.returnCartItems(customerSessionId, body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
customerSessionId	String	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 endpoint.
body	ReturnIntegrationRequest	body
dry	Boolean	Indicates whether to persist the changes. Changes are ignored when `dry=true`.	[optional]

Return type

IntegrationStateV2

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

syncCatalog

Catalog syncCatalog(catalogId, body)

Sync cart item catalog

Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. Important: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read managing cart item catalogs. ### Filtering cart items Use cart item attributes to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A cart item attribute connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. Note: `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;attributes&quot;: { &quot;color&quot;: &quot;Navy blue&quot;, &quot;type&quot;: &quot;shoes&quot; }, &quot;replaceIfExists&quot;: true, &quot;sku&quot;: &quot;SKU1241028&quot;, &quot;price&quot;: 100, &quot;product&quot;: { &quot;name&quot;: &quot;sneakers&quot; } }, &quot;type&quot;: &quot;ADD&quot; } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;attributes&quot;: { &quot;color&quot;: &quot;Navy blue&quot;, &quot;type&quot;: &quot;shoes&quot; }, &quot;replaceIfExists&quot;: true, &quot;sku&quot;: &quot;SKU1241027&quot;, &quot;price&quot;: 100, &quot;product&quot;: { &quot;name&quot;: &quot;sneakers&quot; } }, &quot;type&quot;: &quot;ADD&quot; }, { &quot;payload&quot;: { &quot;attributes&quot;: { &quot;color&quot;: &quot;Navy blue&quot;, &quot;type&quot;: &quot;shoes&quot; }, &quot;replaceIfExists&quot;: true, &quot;sku&quot;: &quot;SKU1241028&quot;, &quot;price&quot;: 100, &quot;product&quot;: { &quot;name&quot;: &quot;sneakers&quot; } }, &quot;type&quot;: &quot;ADD&quot; } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;attributes&quot;: { &quot;age&quot;: 11, &quot;origin&quot;: &quot;germany&quot; }, &quot;createIfNotExists&quot;: false, &quot;sku&quot;: &quot;SKU1241028&quot;, &quot;product&quot;: { &quot;name&quot;: &quot;sneakers&quot; } }, &quot;type&quot;: &quot;PATCH&quot; } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;attributes&quot;: { &quot;color&quot;: &quot;red&quot; }, &quot;filters&quot;: [ { &quot;attr&quot;: &quot;color&quot;, &quot;op&quot;: &quot;EQ&quot;, &quot;value&quot;: &quot;blue&quot; } ] }, &quot;type&quot;: &quot;PATCH_MANY&quot; } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;sku&quot;: &quot;SKU1241028&quot; }, &quot;type&quot;: &quot;REMOVE&quot; } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;filters&quot;: [ { &quot;attr&quot;: &quot;color&quot;, &quot;op&quot;: &quot;EQ&quot;, &quot;value&quot;: &quot;blue&quot; } ] }, &quot;type&quot;: &quot;REMOVE_MANY&quot; } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { &quot;actions&quot;: [ { &quot;payload&quot;: { &quot;filters&quot;: [ { &quot;attr&quot;: &quot;size&quot;, &quot;op&quot;: &quot;GT&quot;, &quot;value&quot;: &quot;45&quot; } ] }, &quot;type&quot;: &quot;REMOVE_MANY&quot; } ] } ``` </div> </details>

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let catalogId = 56; // Number | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
let body = new TalonOne.CatalogSyncRequest(); // CatalogSyncRequest | body
apiInstance.syncCatalog(catalogId, body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
catalogId	Number	The ID of the catalog. You can find the ID in the Campaign Manager in Account > Tools > Cart item catalogs.
body	CatalogSyncRequest	body

Return type

Catalog

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

trackEventV2

TrackEventV2Response trackEventV2(body, opts)

Track event

Triggers a custom event. To use this endpoint: 1. Define a custom event in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the Events view in the Campaign Manager. Talon.One also offers a set of built-in events. Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the tutorial. <div class=&quot;redoc-section&quot;> <p class=&quot;title&quot;>Important</p> 1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` built-in event is not triggered. 1. We recommend sending requests sequentially. See Managing parallel requests. </div>

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.IntegrationEventV2Request(); // IntegrationEventV2Request | body
let opts = {
  'silent': "'yes'", // String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
  'dry': true // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. 
};
apiInstance.trackEventV2(body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	IntegrationEventV2Request	body
silent	String	Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.	[optional] [default to 'yes']
dry	Boolean	Indicates whether to persist the changes. Changes are ignored when `dry=true`.	[optional]

Return type

TrackEventV2Response

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateAudienceCustomersAttributes

updateAudienceCustomersAttributes(audienceId, body)

Update profile attributes for all customers in audience

Update the specified profile attributes to the provided values for all customers in the specified audience.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let audienceId = 56; // Number | The ID of the audience.
let body = null; // Object | body
apiInstance.updateAudienceCustomersAttributes(audienceId, body).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
audienceId	Number	The ID of the audience.
body	Object	body

Return type

null (empty response body)

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateAudienceV2

Audience updateAudienceV2(audienceId, body)

Update audience name

Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does not trigger the Rule Engine. To update the audience's members, use the Update customer profile endpoint.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let audienceId = 56; // Number | The ID of the audience.
let body = new TalonOne.UpdateAudience(); // UpdateAudience | body
apiInstance.updateAudienceV2(audienceId, body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
audienceId	Number	The ID of the audience.
body	UpdateAudience	body

Return type

Audience

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateCustomerProfileAudiences

updateCustomerProfileAudiences(body)

Update multiple customer profiles' audiences

Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. Note: You can also do this using the Update audience effect.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.CustomerProfileAudienceRequest(); // CustomerProfileAudienceRequest | body
apiInstance.updateCustomerProfileAudiences(body).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	CustomerProfileAudienceRequest	body

Return type

null (empty response body)

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateCustomerProfileV2

CustomerProfileIntegrationResponseV2 updateCustomerProfileV2(integrationId, body, opts)

Update customer profile

Update or create a Customer Profile. 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. <div class=&quot;redoc-section&quot;> <p class=&quot;title&quot;>Performance tips</p> - 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. </div>

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let integrationId = "integrationId_example"; // String | 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. 
let body = new TalonOne.CustomerProfileIntegrationRequestV2(); // CustomerProfileIntegrationRequestV2 | body
let opts = {
  'runRuleEngine': false, // Boolean | Indicates whether to run the Rule Engine.  If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects.  If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. 
  'dry': true // Boolean | (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`.  When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. 
};
apiInstance.updateCustomerProfileV2(integrationId, body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
integrationId	String	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.
body	CustomerProfileIntegrationRequestV2	body
runRuleEngine	Boolean	Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body.	[optional] [default to false]
dry	Boolean	(Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run.	[optional]

Return type

CustomerProfileIntegrationResponseV2

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateCustomerProfilesV2

MultipleCustomerProfileIntegrationResponseV2 updateCustomerProfilesV2(body, opts)

Update multiple customer profiles

Update (or create) up to 1000 customer profiles in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile can be linked to one or more sessions. Note: This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the Update customer profile endpoint.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.MultipleCustomerProfileIntegrationRequest(); // MultipleCustomerProfileIntegrationRequest | body
let opts = {
  'silent': "'yes'" // String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
};
apiInstance.updateCustomerProfilesV2(body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	MultipleCustomerProfileIntegrationRequest	body
silent	String	Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.	[optional] [default to 'yes']

Return type

MultipleCustomerProfileIntegrationResponseV2

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateCustomerSessionV2

IntegrationStateV2 updateCustomerSessionV2(customerSessionId, body, opts)

Update customer session

Update or create a customer session. The endpoint responds with the potential promotion rule effects that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. Note: The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about customer sessions and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=&quot;&quot;`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. Note: If the specified profile does not exist, an empty profile is created automatically. You can update it with Update customer profile. <div class=&quot;redoc-section&quot;> <p class=&quot;title&quot;>Performance tips</p> - Updating a customer session returns a response with the new integration state. 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. </div> For more information, see: - The introductory video in Getting started. - The integration tutorial.

Example

import TalonOne from 'talon_one';
let defaultClient = TalonOne.ApiClient.instance;
// Configure API key authorization: api_key_v1
let api_key_v1 = defaultClient.authentications['api_key_v1'];
api_key_v1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_v1.apiKeyPrefix = 'Token';

let apiInstance = new TalonOne.IntegrationApi();
let customerSessionId = "customerSessionId_example"; // String | 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. 
let body = new TalonOne.IntegrationRequest(); // IntegrationRequest | body
let opts = {
  'dry': true, // Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.  When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session.   When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run.  [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). 
  'now': new Date("2013-10-20T19:20:30+01:00") // Date | A timestamp value of a future date that acts as a current date when included in the query.  Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)).  **Note:**  - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. 
};
apiInstance.updateCustomerSessionV2(customerSessionId, body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
customerSessionId	String	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 endpoint.
body	IntegrationRequest	body
dry	Boolean	Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers only the payload that you pass when closing the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. See the docs.	[optional]
now	Date	A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, scheduled campaigns). Note: - It must be an RFC3339 timestamp string. - It can only be a date in the future. - It can only be used if the `dry` parameter in the query is set to `true`.	[optional]

Return type

IntegrationStateV2

Authorization

api_key_v1

HTTP request headers

• Content-Type: application/json
• Accept: application/json