IntegrationApi.md

TalonOne\Client\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

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TalonOne\Client\Model\NewAudience(); // \TalonOne\Client\Model\NewAudience | body

try {
    $result = $apiInstance->createAudienceV2($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->createAudienceV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\TalonOne\Client\Model\NewAudience	body

Return type

\TalonOne\Client\Model\Audience

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createCouponReservation

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$couponValue = 'couponValue_example'; // string | The code of the coupon.
$body = new \TalonOne\Client\Model\CouponReservations(); // \TalonOne\Client\Model\CouponReservations | body

try {
    $result = $apiInstance->createCouponReservation($couponValue, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->createCouponReservation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
couponValue	string	The code of the coupon.
body	\TalonOne\Client\Model\CouponReservations	body

Return type

\TalonOne\Client\Model\Coupon

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createReferral

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TalonOne\Client\Model\NewReferral(); // \TalonOne\Client\Model\NewReferral | body

try {
    $result = $apiInstance->createReferral($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->createReferral: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\TalonOne\Client\Model\NewReferral	body

Return type

\TalonOne\Client\Model\Referral

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createReferralsForMultipleAdvocates

\TalonOne\Client\Model\InlineResponse201 createReferralsForMultipleAdvocates($body, $silent)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TalonOne\Client\Model\NewReferralsForMultipleAdvocates(); // \TalonOne\Client\Model\NewReferralsForMultipleAdvocates | body
$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.

try {
    $result = $apiInstance->createReferralsForMultipleAdvocates($body, $silent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->createReferralsForMultipleAdvocates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\TalonOne\Client\Model\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

\TalonOne\Client\Model\InlineResponse201

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAudienceMembershipsV2

deleteAudienceMembershipsV2($audienceId)

Delete audience memberships

Remove all members from this audience.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$audienceId = 56; // int | The ID of the audience.

try {
    $apiInstance->deleteAudienceMembershipsV2($audienceId);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->deleteAudienceMembershipsV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$audienceId = 56; // int | The ID of the audience.

try {
    $apiInstance->deleteAudienceV2($audienceId);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->deleteAudienceV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$couponValue = 'couponValue_example'; // string | The code of the coupon.
$body = new \TalonOne\Client\Model\CouponReservations(); // \TalonOne\Client\Model\CouponReservations | body

try {
    $apiInstance->deleteCouponReservation($couponValue, $body);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->deleteCouponReservation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
couponValue	string	The code of the coupon.
body	\TalonOne\Client\Model\CouponReservations	body

Return type

void (empty response body)

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.

try {
    $apiInstance->deleteCustomerData($integrationId);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->deleteCustomerData: ', $e->getMessage(), PHP_EOL;
}
?>

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

void (empty response body)

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generateLoyaltyCard

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$body = new \TalonOne\Client\Model\GenerateLoyaltyCard(); // \TalonOne\Client\Model\GenerateLoyaltyCard | body

try {
    $result = $apiInstance->generateLoyaltyCard($loyaltyProgramId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->generateLoyaltyCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TalonOne\Client\Model\LoyaltyCard

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCustomerInventory

\TalonOne\Client\Model\CustomerInventory getCustomerInventory($integrationId, $profile, $referrals, $coupons, $loyalty, $giveaways, $achievements)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.
$profile = True; // bool | Set to `true` to include customer profile information in the response.
$referrals = True; // bool | Set to `true` to include referral information in the response.
$coupons = True; // bool | Set to `true` to include coupon information in the response.
$loyalty = True; // bool | Set to `true` to include loyalty information in the response.
$giveaways = True; // bool | Set to `true` to include giveaways information in the response.
$achievements = True; // bool | Set to `true` to include achievement information in the response.

try {
    $result = $apiInstance->getCustomerInventory($integrationId, $profile, $referrals, $coupons, $loyalty, $giveaways, $achievements);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getCustomerInventory: ', $e->getMessage(), PHP_EOL;
}
?>

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	bool	Set to `true` to include customer profile information in the response.	[optional]
referrals	bool	Set to `true` to include referral information in the response.	[optional]
coupons	bool	Set to `true` to include coupon information in the response.	[optional]
loyalty	bool	Set to `true` to include loyalty information in the response.	[optional]
giveaways	bool	Set to `true` to include giveaways information in the response.	[optional]
achievements	bool	Set to `true` to include achievement information in the response.	[optional]

Return type

\TalonOne\Client\Model\CustomerInventory

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCustomerSession

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.

try {
    $result = $apiInstance->getCustomerSession($customerSessionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getCustomerSession: ', $e->getMessage(), PHP_EOL;
}
?>

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

\TalonOne\Client\Model\IntegrationCustomerSessionResponse

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoyaltyBalances

\TalonOne\Client\Model\LoyaltyBalancesWithTiers getLoyaltyBalances($loyaltyProgramId, $integrationId, $endDate, $subledgerId, $includeTiers, $includeProjectedTier)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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; // bool | 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; // bool | 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.

try {
    $result = $apiInstance->getLoyaltyBalances($loyaltyProgramId, $integrationId, $endDate, $subledgerId, $includeTiers, $includeProjectedTier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getLoyaltyBalances: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	\DateTime	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	bool	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	bool	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

\TalonOne\Client\Model\LoyaltyBalancesWithTiers

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoyaltyCardBalances

\TalonOne\Client\Model\LoyaltyCardBalances getLoyaltyCardBalances($loyaltyProgramId, $loyaltyCardId, $endDate, $subledgerId)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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 = array('subledgerId_example'); // string[] | Filter results by one or more subledger IDs. Must be exact match.

try {
    $result = $apiInstance->getLoyaltyCardBalances($loyaltyProgramId, $loyaltyCardId, $endDate, $subledgerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getLoyaltyCardBalances: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	\DateTime	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

\TalonOne\Client\Model\LoyaltyCardBalances

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoyaltyCardPoints

\TalonOne\Client\Model\InlineResponse2003 getLoyaltyCardPoints($loyaltyProgramId, $loyaltyCardId, $status, $subledgerId, $pageSize, $skip)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$status = 'active'; // string | Filter points based on their status.
$subledgerId = array('subledgerId_example'); // string[] | Filter results by one or more subledger IDs. Must be exact match.
$pageSize = 50; // int | The number of items in the response.
$skip = 56; // int | The number of items to skip when paging through large result sets.

try {
    $result = $apiInstance->getLoyaltyCardPoints($loyaltyProgramId, $loyaltyCardId, $status, $subledgerId, $pageSize, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getLoyaltyCardPoints: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	int	The number of items in the response.	[optional] [default to 50]
skip	int	The number of items to skip when paging through large result sets.	[optional]

Return type

\TalonOne\Client\Model\InlineResponse2003

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoyaltyCardTransactions

\TalonOne\Client\Model\InlineResponse2001 getLoyaltyCardTransactions($loyaltyProgramId, $loyaltyCardId, $subledgerId, $loyaltyTransactionType, $startDate, $endDate, $pageSize, $skip)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$subledgerId = array('subledgerId_example'); // 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 \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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 \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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; // int | The number of items in the response.
$skip = 56; // int | The number of items to skip when paging through large result sets.

try {
    $result = $apiInstance->getLoyaltyCardTransactions($loyaltyProgramId, $loyaltyCardId, $subledgerId, $loyaltyTransactionType, $startDate, $endDate, $pageSize, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getLoyaltyCardTransactions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	\DateTime	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	\DateTime	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	int	The number of items in the response.	[optional] [default to 1000]
skip	int	The number of items to skip when paging through large result sets.	[optional]

Return type

\TalonOne\Client\Model\InlineResponse2001

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoyaltyProgramProfilePoints

\TalonOne\Client\Model\InlineResponse2004 getLoyaltyProgramProfilePoints($loyaltyProgramId, $integrationId, $status, $subledgerId, $pageSize, $skip)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$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; // int | The number of items in the response.
$skip = 56; // int | The number of items to skip when paging through large result sets.

try {
    $result = $apiInstance->getLoyaltyProgramProfilePoints($loyaltyProgramId, $integrationId, $status, $subledgerId, $pageSize, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getLoyaltyProgramProfilePoints: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	int	The number of items in the response.	[optional] [default to 50]
skip	int	The number of items to skip when paging through large result sets.	[optional]

Return type

\TalonOne\Client\Model\InlineResponse2004

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoyaltyProgramProfileTransactions

\TalonOne\Client\Model\InlineResponse2002 getLoyaltyProgramProfileTransactions($loyaltyProgramId, $integrationId, $subledgerId, $loyaltyTransactionType, $startDate, $endDate, $pageSize, $skip)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$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 \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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 \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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; // int | The number of items in the response.
$skip = 56; // int | The number of items to skip when paging through large result sets.

try {
    $result = $apiInstance->getLoyaltyProgramProfileTransactions($loyaltyProgramId, $integrationId, $subledgerId, $loyaltyTransactionType, $startDate, $endDate, $pageSize, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getLoyaltyProgramProfileTransactions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	\DateTime	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	\DateTime	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	int	The number of items in the response.	[optional] [default to 50]
skip	int	The number of items to skip when paging through large result sets.	[optional]

Return type

\TalonOne\Client\Model\InlineResponse2002

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReservedCustomers

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$couponValue = 'couponValue_example'; // string | The code of the coupon.

try {
    $result = $apiInstance->getReservedCustomers($couponValue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->getReservedCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TalonOne\Client\Model\InlineResponse200

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

linkLoyaltyCardToProfile

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$loyaltyProgramId = 56; // int | 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.
$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.
$body = new \TalonOne\Client\Model\LoyaltyCardRegistration(); // \TalonOne\Client\Model\LoyaltyCardRegistration | body

try {
    $result = $apiInstance->linkLoyaltyCardToProfile($loyaltyProgramId, $loyaltyCardId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->linkLoyaltyCardToProfile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
loyaltyProgramId	int	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	\TalonOne\Client\Model\LoyaltyCardRegistration	body

Return type

\TalonOne\Client\Model\LoyaltyCard

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reopenCustomerSession

\TalonOne\Client\Model\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.

Effects and budgets unimpacted by a session reopening

The following effects and budgets are left the way they were once the session was originally closed:

• Add free item effect
• Any non-pending loyalty points
• Award giveaway
• Coupon and referral creation
• Coupon reservation
• Custom effect
• Update attribute value
• Update cart item attribute value

To see an example of roll back, see the <a href="https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets tutorial.

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.

try {
    $result = $apiInstance->reopenCustomerSession($customerSessionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->reopenCustomerSession: ', $e->getMessage(), PHP_EOL;
}
?>

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

\TalonOne\Client\Model\ReopenSessionResponse

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

returnCartItems

\TalonOne\Client\Model\IntegrationStateV2 returnCartItems($customerSessionId, $body, $dry)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.
$body = new \TalonOne\Client\Model\ReturnIntegrationRequest(); // \TalonOne\Client\Model\ReturnIntegrationRequest | body
$dry = True; // bool | Indicates whether to persist the changes. Changes are ignored when `dry=true`.

try {
    $result = $apiInstance->returnCartItems($customerSessionId, $body, $dry);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->returnCartItems: ', $e->getMessage(), PHP_EOL;
}
?>

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	\TalonOne\Client\Model\ReturnIntegrationRequest	body
dry	bool	Indicates whether to persist the changes. Changes are ignored when `dry=true`.	[optional]

Return type

\TalonOne\Client\Model\IntegrationStateV2

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

syncCatalog

\TalonOne\Client\Model\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:

Adding an item to the catalog

json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] }

Adding multiple items to the catalog

json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] }

Updating the attributes of an item in the catalog

json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] }

Updating the attributes of multiple items in the catalog

json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] }

Removing an item from the catalog

json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] }

Removing multiple items from the catalog

json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] }

Removing shoes of sizes above 45 from the catalog

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:

json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] }

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$catalogId = 56; // int | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
$body = new \TalonOne\Client\Model\CatalogSyncRequest(); // \TalonOne\Client\Model\CatalogSyncRequest | body

try {
    $result = $apiInstance->syncCatalog($catalogId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->syncCatalog: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TalonOne\Client\Model\Catalog

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

trackEventV2

\TalonOne\Client\Model\TrackEventV2Response trackEventV2($body, $silent, $dry)

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="redoc-section"> <p class="title">Important

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TalonOne\Client\Model\IntegrationEventV2Request(); // \TalonOne\Client\Model\IntegrationEventV2Request | body
$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; // bool | Indicates whether to persist the changes. Changes are ignored when `dry=true`.

try {
    $result = $apiInstance->trackEventV2($body, $silent, $dry);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->trackEventV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\TalonOne\Client\Model\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	bool	Indicates whether to persist the changes. Changes are ignored when `dry=true`.	[optional]

Return type

\TalonOne\Client\Model\TrackEventV2Response

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$audienceId = 56; // int | The ID of the audience.
$body = new \stdClass; // object | body

try {
    $apiInstance->updateAudienceCustomersAttributes($audienceId, $body);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateAudienceCustomersAttributes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
audienceId	int	The ID of the audience.
body	object	body

Return type

void (empty response body)

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAudienceV2

\TalonOne\Client\Model\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$audienceId = 56; // int | The ID of the audience.
$body = new \TalonOne\Client\Model\UpdateAudience(); // \TalonOne\Client\Model\UpdateAudience | body

try {
    $result = $apiInstance->updateAudienceV2($audienceId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateAudienceV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
audienceId	int	The ID of the audience.
body	\TalonOne\Client\Model\UpdateAudience	body

Return type

\TalonOne\Client\Model\Audience

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TalonOne\Client\Model\CustomerProfileAudienceRequest(); // \TalonOne\Client\Model\CustomerProfileAudienceRequest | body

try {
    $apiInstance->updateCustomerProfileAudiences($body);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateCustomerProfileAudiences: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\TalonOne\Client\Model\CustomerProfileAudienceRequest	body

Return type

void (empty response body)

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCustomerProfileV2

\TalonOne\Client\Model\CustomerProfileIntegrationResponseV2 updateCustomerProfileV2($integrationId, $body, $runRuleEngine, $dry)

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="redoc-section"> <p class="title">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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.
$body = new \TalonOne\Client\Model\CustomerProfileIntegrationRequestV2(); // \TalonOne\Client\Model\CustomerProfileIntegrationRequestV2 | body
$runRuleEngine = false; // bool | 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; // bool | (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.

try {
    $result = $apiInstance->updateCustomerProfileV2($integrationId, $body, $runRuleEngine, $dry);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateCustomerProfileV2: ', $e->getMessage(), PHP_EOL;
}
?>

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	\TalonOne\Client\Model\CustomerProfileIntegrationRequestV2	body
runRuleEngine	bool	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	bool	(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

\TalonOne\Client\Model\CustomerProfileIntegrationResponseV2

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCustomerProfilesV2

\TalonOne\Client\Model\MultipleCustomerProfileIntegrationResponseV2 updateCustomerProfilesV2($body, $silent)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TalonOne\Client\Model\MultipleCustomerProfileIntegrationRequest(); // \TalonOne\Client\Model\MultipleCustomerProfileIntegrationRequest | body
$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.

try {
    $result = $apiInstance->updateCustomerProfilesV2($body, $silent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateCustomerProfilesV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\TalonOne\Client\Model\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

\TalonOne\Client\Model\MultipleCustomerProfileIntegrationResponseV2

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCustomerSessionV2

\TalonOne\Client\Model\IntegrationStateV2 updateCustomerSessionV2($customerSessionId, $body, $dry, $now)

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=\"\", 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="redoc-section"> <p class="title">Performance tips

- 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. For more information, see: - The introductory video in Getting started. - The integration tutorial.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key_v1
$config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TalonOne\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TalonOne\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.
$body = new \TalonOne\Client\Model\IntegrationRequest(); // \TalonOne\Client\Model\IntegrationRequest | body
$dry = True; // bool | 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 \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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`.

try {
    $result = $apiInstance->updateCustomerSessionV2($customerSessionId, $body, $dry, $now);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateCustomerSessionV2: ', $e->getMessage(), PHP_EOL;
}
?>

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	\TalonOne\Client\Model\IntegrationRequest	body
dry	bool	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	\DateTime	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

\TalonOne\Client\Model\IntegrationStateV2

Authorization

api_key_v1

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]