Management API reference docs
Download OpenAPI specification:Download
The Management API allows you to programmatically do what the Campaign Manager does. For example, use it for management purposes and backoffice systems.
For more background information about this API, see Management API overview
Ensure you authenticate to make requests to the API.
Warnings:
- This API is not meant to be used in real-time integrations that directly serve your end users.
- This API supports a maximum of 3 requests per second for each of these endpoints.
Are you looking for a different API?
If you need the API to:
- Integrate with Talon.One directly and send real-time data, see the Integration API reference docs.
- Integrate with Talon.One from a CEP or CDP platform, see the Third-party API reference docs.
manager_auth
This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API.
To create the token:
- Get a bearer token by calling the createSession endpoint.
- Use the
token
property of the response in the HTTP header of your next queries:Authorization: Bearer $TOKEN
.
A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do not regenerate a token for each request.
Note: We recommend that you use a Management API key instead of a bearer token.
Authorization
management_key
The API key authentication gives you access to the endpoints selected by the admin who created the key. Using an API key is the recommended authentication method.
The key must be generated by an admin and given to the developer that requires it:
- Log into the Campaign Manager and click Account > Management API keys.
- Click Create Key and give it a name.
- Set an expiration date.
- Choose the endpoints the key should give access to.
- Click Create Key.
- Share it with your developer.
The developer can now use the API key in the HTTP header, prefixing it with ManagementKey-v1
:
Authorization: ManagementKey-v1 bd9479c59e16f9dbc644d33aa74d58270fe13bf3
Authorization
Operations for updating account information such as billing email addresses, inviting users, etc.
List users in account
Retrieve all users in your account.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
Responses
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "modified": "2021-09-12T10:12:42Z",
- "email": "john.doe@example.com",
- "accountId": 3886,
- "inviteToken": "Gy9b8w1irmQtEPo5RmbMmSPheL5h4",
- "state": "invited",
- "name": "John Doe",
- "policy": {
- "Role": 127,
- "Applications": null
}, - "latestFeedTimestamp": "2020-06-01T00:00:00Z",
- "roles": [
- 71
], - "applicationNotificationSubscriptions": null,
- "authMethod": "basic_auth",
- "isAdmin": false
}
]
}
Get user
Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.
Authorizations:
path Parameters
userId required | integer The ID of the user. |
Responses
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "modified": "2021-09-12T10:12:42Z",
- "email": "john.doe@example.com",
- "accountId": 3886,
- "inviteToken": "Gy9b8w1irmQtEPo5RmbMmSPheL5h4",
- "state": "invited",
- "name": "John Doe",
- "policy": {
- "Role": 127,
- "Applications": null
}, - "latestFeedTimestamp": "2020-06-01T00:00:00Z",
- "roles": [
- 71
], - "applicationNotificationSubscriptions": null,
- "authMethod": "basic_auth",
- "isAdmin": false
}
Request a password reset
Send an email with a password recovery link to the email address of an existing account.
Note: The password recovery link expires 30 minutes after this endpoint is triggered.
Authorizations:
Request Body schema: application/json
body
email required | string <email> non-empty |
Responses
Request samples
- Payload
{- "email": "user@example.com"
}
Response samples
- 204
{- "email": "user@example.com"
}
Reset password
Consumes the supplied password reset token and updates the password for the associated account.
Authorizations:
Request Body schema: application/json
body
password required | string The new password for your account. |
resetToken required | string non-empty |
Responses
Request samples
- Payload
{- "password": "Admin&12943!7",
- "resetToken": "Z2VgacVNkexLKBUIzsRDDZSGxnIkC53y"
}
Response samples
- 204
{- "password": "Admin&12943!7",
- "resetToken": "Z2VgacVNkexLKBUIzsRDDZSGxnIkC53y"
}
Get account details
Return the details of your companies Talon.One account.
Authorizations:
path Parameters
accountId required | integer The identifier of the account. Retrieve it via the
List users in account endpoint in the |
Responses
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "modified": "2021-09-12T10:12:42Z",
- "companyName": "string",
- "domainName": "string",
- "state": "active",
- "billingEmail": "user@example.com",
- "planName": "string",
- "planExpires": "2019-08-24T14:15:22Z",
- "applicationLimit": 0,
- "userLimit": 0,
- "campaignLimit": 0,
- "apiLimit": 0,
- "applicationCount": 0,
- "userCount": 0,
- "campaignsActiveCount": 0,
- "campaignsInactiveCount": 0,
- "attributes": { }
}
Get account analytics
Return the analytics of your Talon.One account.
Authorizations:
path Parameters
accountId required | integer The identifier of the account. Retrieve it via the
List users in account endpoint in the |
Responses
Response samples
- 200
{- "applications": 11,
- "liveApplications": 6,
- "sandboxApplications": 2,
- "campaigns": 35,
- "activeCampaigns": 15,
- "liveActiveCampaigns": 10,
- "coupons": 850,
- "activeCoupons": 650,
- "expiredCoupons": 200,
- "referralCodes": 500,
- "activeReferralCodes": 100,
- "expiredReferralCodes": 400,
- "activeRules": 35,
- "users": 0,
- "roles": 10,
- "customAttributes": 18,
- "webhooks": 2,
- "loyaltyPrograms": 5,
- "liveLoyaltyPrograms": 5
}
An extra fee applied to the cart. For example, shipping fees or processing fees.
See the docs.
Create additional cost
Create an additional cost.
These additional costs are shared across all applications in your account, and are never required.
Authorizations:
Request Body schema: application/json
body
name required | string^[A-Za-z](\w|\s)*$ The internal name used in API requests. |
title required | string^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ The human-readable name for the additional cost that will be shown in the Campaign Manager. Like |
description required | string A description of this additional cost. |
subscribedApplicationsIds | Array of integers A list of the IDs of the applications that are subscribed to this additional cost. |
type | string Default: "session" Enum: "session" "item" "both" The type of additional cost. Possible value:
|
Responses
Request samples
- Payload
{- "name": "shippingFee",
- "title": "Shipping fee",
- "description": "A shipping fee",
- "subscribedApplicationsIds": [
- 3,
- 13
], - "type": "session"
}
Response samples
- 201
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "name": "shippingFee",
- "title": "Shipping fee",
- "description": "A shipping fee",
- "subscribedApplicationsIds": [
- 3,
- 13
], - "type": "session"
}
List additional costs
Returns all the defined additional costs for the account.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
Responses
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "name": "shippingFee",
- "title": "Shipping fee",
- "description": "A shipping fee",
- "subscribedApplicationsIds": [
- 3,
- 13
], - "type": "session"
}
]
}
Get additional cost
Returns the additional cost.
Authorizations:
path Parameters
additionalCostId required | integer The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in Account > Tools > Additional costs. |
Responses
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "name": "shippingFee",
- "title": "Shipping fee",
- "description": "A shipping fee",
- "subscribedApplicationsIds": [
- 3,
- 13
], - "type": "session"
}
Update additional cost
Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
Authorizations:
path Parameters
additionalCostId required | integer The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in Account > Tools > Additional costs. |
Request Body schema: application/json
body
name required | string^[A-Za-z](\w|\s)*$ The internal name used in API requests. |
title required | string^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ The human-readable name for the additional cost that will be shown in the Campaign Manager. Like |
description required | string A description of this additional cost. |
subscribedApplicationsIds | Array of integers A list of the IDs of the applications that are subscribed to this additional cost. |
type | string Default: "session" Enum: "session" "item" "both" The type of additional cost. Possible value:
|
Responses
Request samples
- Payload
{- "name": "shippingFee",
- "title": "Shipping fee",
- "description": "A shipping fee",
- "subscribedApplicationsIds": [
- 3,
- 13
], - "type": "session"
}
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "name": "shippingFee",
- "title": "Shipping fee",
- "description": "A shipping fee",
- "subscribedApplicationsIds": [
- 3,
- 13
], - "type": "session"
}
Analytics are used to retrieve statistical data about the performance of campaigns within an Application.
Export triggered effects
Download a CSV file containing the triggered effects that match the given attributes.
Tip: If the exported CSV file is too large to view, you can split it into multiple files.
The generated file can contain the following columns:
applicationid
: The ID of the Application.campaignid
: The ID of the campaign.couponid
: The ID of the coupon, when applicable to the effect.created
: The timestamp of the effect.event_type
: The name of the event. See the docs.eventid
: The internal ID of the effect.name
: The effect name. See the docs.profileintegrationid
: The ID of the customer profile, when applicable.props
: The properties of the effect.ruleindex
: The index of the rule.rulesetid
: The ID of the rule set.sessionid
: The internal ID of the session that triggered the effect.profileid
: The internal ID of the customer profile.sessionintegrationid
: The integration ID of the session.total_revenue
: The total revenue.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
query Parameters
campaignId | number Filter results by campaign. |
createdBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
createdAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
dateFormat | string Enum: "excel" "ISO8601" Determines the format of dates in the export document. |
Responses
Response samples
- 200
created,name,applicationid,campaignid,rulesetid,ruleindex,sessionintegrationid,profileintegrationid,sessionid,profileid,eventid,event_type,total_revenue,props,couponid 2021-06-02T21:14:16Z,rejectCoupon,270,0,0,0,newsession1,,9168,0,95797,talon_session_created,265.00,"{""value"": ""XMAS20"", ""rejectionReason"": ""CouponNotFound""}", 2021-09-01T13:04:04Z,setDiscountPerItem,270,3882,13599,0,test_flattening_2,integid_4,9707,4800,98806,talon_session_updated,405.00,"{""name"": ""10% off per item#1"", ""value"": 11.0, ""position"": 1}"
Export customer sessions
Download a CSV file containing the customer sessions that match the request.
Important: Archived sessions cannot be exported. See the retention policy.
Tip: If the exported CSV file is too large to view, you can split it into multiple files.
id
: The internal ID of the session.firstsession
: Whether this is a first session.integrationid
: The integration ID of the session.applicationid
: The ID of the Application.profileid
: The internal ID of the customer profile.profileintegrationid
: The integration ID of the customer profile.created
: The timestamp when the session was created.state
: The state of the session.cartitems
: The cart items in the session.discounts
: The discounts in the session.total
: The total value of the session.attributes
: The attributes set in the session.closedat
: Timestamp when the session was closed.cancelledat
: Timestamp when the session was cancelled.referral
: The referral code in the session.identifiers
: The identifiers in the session.additional_costs
: The additional costs in the session.updated
: Timestamp of the last session update.coupons
: Coupon codes in the session.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
query Parameters
createdBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. |
createdAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. |
profileIntegrationId | string Only return sessions for the customer that matches this customer integration ID. |
dateFormat | string Enum: "excel" "ISO8601" Determines the format of dates in the export document. |
customerSessionState | string Enum: "open" "closed" "partially_returned" "cancelled" Filter results by state. |
Responses
Response samples
- 200
id,firstsession,integrationid,applicationid,profileid,profileintegrationid,created,state,cartitems,discounts,total,attributes,closedat,cancelledat,referral,identifiers,additional_costs,updated,coupons 12327,true,62791173fbf323ee5cfd96f3,270,6111,dxclwds,2022-05-09T13:05:31Z,open,"[{""sku"": ""B00004TKVY"", ""name"": ""Gravel bike - \""Aisle of Man\"""", ""price"": 1800, ""weight"": 6, ""category"": ""gravelbikes"", ""position"": 0, ""quantity"": 1, ""attributes"": {""color"": [""black,white""], ""material"": ""titanium""}, ""returnedQuantity"": 0, ""remainingQuantity"": 1}]","{}",1850.00,"{""ShippingCost"": 50, ""PaymentMethod"": ""creditcard"", ""ShippingMethod"": ""Standard""}",0001-01-01T00:00:00Z,0001-01-01T00:00:00Z,,"null","{""ShippingCost"": {""price"": 50}}",2022-05-09T13:13:28Z,"[""SORRY5QMUJRWA""]"
Represents an Application in the Campaign Manager. An Application is the target of every Integration API request to Talon.One.
One Application can hold various API keys used for Integration API requests.
You may have multiple Applications within one account, for example staging and production, or different international markets.
See the docs.
List Applications
List all applications in the current account.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
Responses
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "modified": "2021-09-12T10:12:42Z",
- "accountId": 3886,
- "name": "My Application",
- "description": "A test Application",
- "timezone": "Europe/Berlin",
- "currency": "EUR",
- "caseSensitivity": "sensitive",
- "attributes": { },
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "defaultDiscountScope": "sessionTotal",
- "enableCascadingDiscounts": true,
- "enableFlattenedCartItems": true,
- "attributesSettings": {
- "mandatory": {
- "campaigns": [
- "string"
], - "coupons": [
- "string"
]
}
}, - "sandbox": true,
- "enablePartialDiscounts": false,
- "defaultDiscountAdditionalCostPerItemScope": "price",
- "defaultEvaluationGroupId": 3,
- "loyaltyPrograms": [
- {
- "id": 0,
- "created": "2020-06-10T09:05:27.993483Z",
- "title": "Point collection",
- "description": "Customers collect 10 points per 1$ spent",
- "subscribedApplications": [
- 132,
- 97
], - "defaultValidity": "2W_U",
- "defaultPending": "immediate",
- "allowSubledger": false,
- "usersPerCardLimit": 111,
- "sandbox": true,
- "tiersExpireIn": "27W_U",
- "tiersDowngradePolicy": "one_down",
- "accountID": 1,
- "name": "my_program",
- "tiers": [
- {
- "name": "Gold",
- "minPoints": 300,
- "id": 3,
- "created": "2021-06-10T09:05:27.993483Z",
- "programID": 139
}, - {
- "name": "Silver",
- "minPoints": 200,
- "id": 2,
- "created": "2021-06-10T09:04:59.355258Z",
- "programId": 139
}, - {
- "name": "Bronze",
- "minPoints": 100,
- "id": 1,
- "created": "2021-06-10T09:04:39.355258Z",
- "programId": 139
}
], - "timezone": "Europe/Berlin",
- "cardBased": true,
- "canUpdateTiers": true,
- "canUpgradeToAdvancedTiers": true
}
]
}
]
}
Get Application
Get the application specified by the ID.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
Responses
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "modified": "2021-09-12T10:12:42Z",
- "accountId": 3886,
- "name": "My Application",
- "description": "A test Application",
- "timezone": "Europe/Berlin",
- "currency": "EUR",
- "caseSensitivity": "sensitive",
- "attributes": { },
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "defaultDiscountScope": "sessionTotal",
- "enableCascadingDiscounts": true,
- "enableFlattenedCartItems": true,
- "attributesSettings": {
- "mandatory": {
- "campaigns": [
- "string"
], - "coupons": [
- "string"
]
}
}, - "sandbox": true,
- "enablePartialDiscounts": false,
- "defaultDiscountAdditionalCostPerItemScope": "price",
- "defaultEvaluationGroupId": 3,
- "loyaltyPrograms": [
- {
- "id": 0,
- "created": "2020-06-10T09:05:27.993483Z",
- "title": "Point collection",
- "description": "Customers collect 10 points per 1$ spent",
- "subscribedApplications": [
- 132,
- 97
], - "defaultValidity": "2W_U",
- "defaultPending": "immediate",
- "allowSubledger": false,
- "usersPerCardLimit": 111,
- "sandbox": true,
- "tiersExpireIn": "27W_U",
- "tiersDowngradePolicy": "one_down",
- "accountID": 1,
- "name": "my_program",
- "tiers": [
- {
- "name": "Gold",
- "minPoints": 300,
- "id": 3,
- "created": "2021-06-10T09:05:27.993483Z",
- "programID": 139
}, - {
- "name": "Silver",
- "minPoints": 200,
- "id": 2,
- "created": "2021-06-10T09:04:59.355258Z",
- "programId": 139
}, - {
- "name": "Bronze",
- "minPoints": 100,
- "id": 1,
- "created": "2021-06-10T09:04:39.355258Z",
- "programId": 139
}
], - "timezone": "Europe/Berlin",
- "cardBased": true,
- "canUpdateTiers": true,
- "canUpgradeToAdvancedTiers": true
}
]
}
Get Application health
Display the health of the Application and show the last time the Application was used.
You can also display this information from the Settings of an Application, in the Developer Settings menu. See the docs.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
Responses
Response samples
- 200
{- "summary": "OK",
- "lastUsed": "2021-09-12T10:12:42Z"
}
Represents a piece of information related to one of the entities avaialbe in the Campaign Manager. Use them to create highly customized rules.
See the docs.
Create custom attribute
Create a custom attribute in this account. Custom attributes allow you to add data to Talon.One domain entities like campaigns, coupons, customers and so on.
These attributes can then be given values when creating/updating these entities, and these values can be used in your campaign rules.
For example, you could define a zipCode
field for customer sessions,
and add a rule to your campaign that only allows certain ZIP codes.
These attributes are shared across all Applications in your account and are never required.
Authorizations:
Request Body schema: application/json
body
entity required | string Enum: "Account" "Application" "Campaign" "CustomerProfile" "CustomerSession" "CartItem" "Coupon" "Event" "Giveaway" "Referral" The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an |
name required | string^[A-Za-z]\w*$ The attribute name that will be used in API requests and Talang. E.g. if |
title required | string^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ The human-readable name for the attribute that will be shown in the Campaign Manager. Like |
type required | string Enum: "string" "number" "boolean" "time" "(list string)" "(list number)" "(list time)" "location" "(list location)" The data type of the attribute, a |
description required | string A description of this attribute. |
suggestions required | Array of strings <= 50 items [ items non-empty ] A list of suggestions for the attribute. |
editable required | boolean Whether or not this attribute can be edited. |
eventType | string |
hasAllowedList | boolean Default: false Whether or not this attribute has an allowed list of values associated with it. |
restrictedBySuggestions | boolean Default: false Whether or not this attribute's value is restricted by suggestions ( |
subscribedApplicationsIds | Array of integers A list of the IDs of the applications where this attribute is available. |
subscribedCatalogsIds | Array of integers A list of the IDs of the catalogs where this attribute is available. |
allowedSubscriptions | Array of strings <= 2 items Items Enum: "application" "catalog" A list of allowed subscription types for this attribute. Note: This only applies to attributes associated with the |
Responses
Request samples
- Payload
{- "entity": "Event",
- "eventType": "pageViewed",
- "name": "pageViewed",
- "title": "Page view event",
- "type": "string",
- "description": "Event triggered when a customer displays a page.",
- "suggestions": [
- "string"
], - "hasAllowedList": false,
- "restrictedBySuggestions": false,
- "editable": true,
- "subscribedApplicationsIds": [
- 1,
- 4,
- 9
], - "subscribedCatalogsIds": [
- 2,
- 5
], - "allowedSubscriptions": [
- "application",
- "catalog"
]
}
Response samples
- 201
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "entity": "Event",
- "eventType": "pageViewed",
- "name": "pageViewed",
- "title": "Page view event",
- "type": "string",
- "description": "Event triggered when a customer displays a page.",
- "suggestions": [
- "string"
], - "hasAllowedList": false,
- "restrictedBySuggestions": false,
- "editable": true,
- "subscribedApplicationsIds": [
- 1,
- 4,
- 9
], - "subscribedCatalogsIds": [
- 2,
- 5
], - "allowedSubscriptions": [
- "application",
- "catalog"
], - "eventTypeId": 22
}
List custom attributes
Return all the custom attributes for the account.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
entity | string Returned attributes will be filtered by supplied entity. |
Responses
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "entity": "Event",
- "eventType": "pageViewed",
- "name": "pageViewed",
- "title": "Page view event",
- "type": "string",
- "description": "Event triggered when a customer displays a page.",
- "suggestions": [
- "string"
], - "hasAllowedList": false,
- "restrictedBySuggestions": false,
- "editable": true,
- "subscribedApplicationsIds": [
- 1,
- 4,
- 9
], - "subscribedCatalogsIds": [
- 2,
- 5
], - "allowedSubscriptions": [
- "application",
- "catalog"
], - "eventTypeId": 22
}
]
}
Get custom attribute
Retrieve the specified custom attribute.
Authorizations:
path Parameters
attributeId required | integer The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in Account > Tools > Attributes. |
Responses
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "entity": "Event",
- "eventType": "pageViewed",
- "name": "pageViewed",
- "title": "Page view event",
- "type": "string",
- "description": "Event triggered when a customer displays a page.",
- "suggestions": [
- "string"
], - "hasAllowedList": false,
- "restrictedBySuggestions": false,
- "editable": true,
- "subscribedApplicationsIds": [
- 1,
- 4,
- 9
], - "subscribedCatalogsIds": [
- 2,
- 5
], - "allowedSubscriptions": [
- "application",
- "catalog"
], - "eventTypeId": 22
}
Update custom attribute
Update an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the description.
To change the type
or name
property of a custom attribute, create a new attribute and
update any relevant integrations and rules to use the new attribute.
Authorizations:
path Parameters
attributeId required | integer The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in Account > Tools > Attributes. |
Request Body schema: application/json
body
entity required | string Enum: "Account" "Application" "Campaign" "CustomerProfile" "CustomerSession" "CartItem" "Coupon" "Event" "Giveaway" "Referral" The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an |
name required | string^[A-Za-z]\w*$ The attribute name that will be used in API requests and Talang. E.g. if |
title required | string^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ The human-readable name for the attribute that will be shown in the Campaign Manager. Like |
type required | string Enum: "string" "number" "boolean" "time" "(list string)" "(list number)" "(list time)" "location" "(list location)" The data type of the attribute, a |
description required | string A description of this attribute. |
suggestions required | Array of strings <= 50 items [ items non-empty ] A list of suggestions for the attribute. |
editable required | boolean Whether or not this attribute can be edited. |
eventType | string |
hasAllowedList | boolean Default: false Whether or not this attribute has an allowed list of values associated with it. |
restrictedBySuggestions | boolean Default: false Whether or not this attribute's value is restricted by suggestions ( |
subscribedApplicationsIds | Array of integers A list of the IDs of the applications where this attribute is available. |
subscribedCatalogsIds | Array of integers A list of the IDs of the catalogs where this attribute is available. |
allowedSubscriptions | Array of strings <= 2 items Items Enum: "application" "catalog" A list of allowed subscription types for this attribute. Note: This only applies to attributes associated with the |
Responses
Request samples
- Payload
{- "entity": "Event",
- "eventType": "pageViewed",
- "name": "pageViewed",
- "title": "Page view event",
- "type": "string",
- "description": "Event triggered when a customer displays a page.",
- "suggestions": [
- "string"
], - "hasAllowedList": false,
- "restrictedBySuggestions": false,
- "editable": true,
- "subscribedApplicationsIds": [
- 1,
- 4,
- 9
], - "subscribedCatalogsIds": [
- 2,
- 5
], - "allowedSubscriptions": [
- "application",
- "catalog"
]
}
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "entity": "Event",
- "eventType": "pageViewed",
- "name": "pageViewed",
- "title": "Page view event",
- "type": "string",
- "description": "Event triggered when a customer displays a page.",
- "suggestions": [
- "string"
], - "hasAllowedList": false,
- "restrictedBySuggestions": false,
- "editable": true,
- "subscribedApplicationsIds": [
- 1,
- 4,
- 9
], - "subscribedCatalogsIds": [
- 2,
- 5
], - "allowedSubscriptions": [
- "application",
- "catalog"
], - "eventTypeId": 22
}
Import allowed values for attribute
Upload a CSV file containing a list of picklist values for the specified attribute.
The file should be sent as multipart data.
The import replaces the previous list of allowed values for this attribute, if any.
The CSV file must only contain the following column:
item
(required): the values in your allowed list, for example a list of SKU's.
An allowed list is limited to 500,000 items.
Example:
item
CS-VG-04032021-UP-50D-10
CS-DV-04042021-UP-49D-12
CS-DG-02082021-UP-50G-07
Authorizations:
path Parameters
attributeId required | integer The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in Account > Tools > Attributes. |
Request Body schema: multipart/form-data
upFile | string <csv> The file with the information about the data that should be imported. |
Responses
Response samples
- 200
- 400
- 401
- 404
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "userId": 388,
- "entity": "AttributeAllowedList",
- "amount": 10
}
Represents lists of customer profiles that allow you to target specific groups of customers in your campaigns. Audiences can be synced from customer data platforms or created directly in Talon.One.
See the docs.
List audiences
Get all audiences created in the account. To create an audience, use Create audience.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
withTotalResultSize | boolean When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
|
Responses
Response samples
- 200
{- "hasMore": true,
- "totalResultSize": 1,
- "data": [
- {
- "accountId": 3886,
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "name": "Travel audience",
- "sandbox": true,
- "description": "Travel audience 18-25",
- "integration": "mparticle",
- "integrationId": "382370BKDB946",
- "createdIn3rdParty": false,
- "lastUpdate": "2022-04-26T11:02:38.000Z"
}
]
}
List campaign templates
Retrieve a list of campaign templates.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
state | string Enum: "enabled" "disabled" "draft" Filter results by the state of the campaign template. |
name | string Filter results performing case-insensitive matching against the name of the campaign template. |
tags | string Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values. |
userId | integer Filter results by user ID. |
Responses
Response samples
- 200
{- "hasMore": true,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "userId": 388,
- "name": "Discount campaign",
- "description": "This is a template for a discount campaign.",
- "instructions": "Use this template for discount campaigns. Set the campaign properties according to the campaign goals, and don't forget to set an end date.",
- "campaignAttributes": { },
- "couponAttributes": { },
- "state": "draft",
- "activeRulesetId": 5,
- "tags": [
- "discount"
], - "features": [
- "coupons"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "templateParams": [
- {
- "name": "discount_value",
- "type": "number",
- "description": "This is a template parameter of type `number`.",
- "attributeId": 42
}
], - "applicationsIds": [
- 0
], - "campaignCollections": [
- {
- "name": "My collection",
- "description": "My collection of SKUs"
}
], - "defaultCampaignGroupId": 42,
- "updated": "2022-08-24T14:15:22.000Z",
- "updatedBy": "Jane Doe",
- "validApplicationIds": [
- 1,
- 2,
- 3
]
}
]
}
Create campaign from campaign template
Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications.
If the template was created from a campaign with rules referencing campaign collections, the corresponding collections for the new campaign are created automatically.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
Request Body schema: application/json
body
name required | string non-empty A user-facing name for this campaign. |
templateId required | integer The ID of the Campaign Template which will be used in order to create the Campaign. |
description | string A detailed description of the campaign. |
object Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden. | |
Array of objects Actual values to replace the template placeholder values in the Ruleset bindings. Values for all Template Parameters must be provided. | |
Array of objects Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden. | |
campaignGroups | Array of integers The IDs of the campaign groups this campaign belongs to. |
tags | Array of strings <= 50 items [ items [ 1 .. 50 ] characters ] A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list. |
evaluationGroupId | integer The ID of the campaign evaluation group the campaign belongs to. |
Responses
Request samples
- Payload
{- "name": "Discount campaign",
- "description": "This template is for discount campaigns.",
- "templateId": 4,
- "campaignAttributesOverrides": { },
- "templateParamValues": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "limitOverrides": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "tags": [
- "summer"
], - "evaluationGroupId": 2
}
Response samples
- 201
{- "campaign": {
- "id": 4,
- "created": "2020-06-10T09:05:27.993483Z",
- "applicationId": 322,
- "userId": 388,
- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-09-22T22:00:00Z",
- "attributes": { },
- "state": "enabled",
- "activeRulesetId": 6,
- "tags": [
- "summer"
], - "features": [
- "coupons",
- "referrals"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "couponRedemptionCount": 163,
- "referralRedemptionCount": 3,
- "discountCount": 288,
- "discountEffectCount": 343,
- "couponCreationCount": 16,
- "customEffectCount": 0,
- "referralCreationCount": 8,
- "addFreeItemEffectCount": 0,
- "awardedGiveawaysCount": 9,
- "createdLoyaltyPointsCount": 9,
- "createdLoyaltyPointsEffectCount": 2,
- "redeemedLoyaltyPointsCount": 8,
- "redeemedLoyaltyPointsEffectCount": 9,
- "callApiEffectCount": 0,
- "reservecouponEffectCount": 9,
- "lastActivity": "2022-11-10T23:00:00Z",
- "updated": "2022-10-97T35:00:00Z",
- "createdBy": "John Doe",
- "updatedBy": "Jane Doe",
- "templateId": 3
}, - "ruleset": {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "userId": 388,
- "rules": [
- {
- "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "title": "Give discount via coupon",
- "description": "Creates a discount when a coupon is valid",
- "bindings": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "condition": [
- "and",
- [
- "couponValid"
]
], - "effects": [
- "catch",
- [
- "noop"
], - [
- "setDiscount",
- "10% off",
- [
- "*",
- [
- ".",
- "Session",
- "Total"
], - [
- "/",
- 10,
- 100
]
]
]
]
}
], - "strikethroughRules": [
- {
- "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "title": "Give discount via coupon",
- "description": "Creates a discount when a coupon is valid",
- "bindings": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "condition": [
- "and",
- [
- "couponValid"
]
], - "effects": [
- "catch",
- [
- "noop"
], - [
- "setDiscount",
- "10% off",
- [
- "*",
- [
- ".",
- "Session",
- "Total"
], - [
- "/",
- 10,
- 100
]
]
]
]
}
], - "bindings": [ ],
- "rbVersion": "v2",
- "activate": true,
- "campaignId": 320,
- "templateId": 3,
- "activatedAt": "2019-08-24T14:15:22Z"
}, - "collections": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
]
}
Represents the primary resource used to control the behavior of the Talon.One Rule Engine. They combine rulesets, coupons, and limits into a single unit.
See the docs.
List campaigns
List the campaigns of the specified application that match your filter criteria.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
campaignState | string Enum: "enabled" "disabled" "archived" "draft" "scheduled" "running" "expired" Filter results by the state of the campaign.
|
name | string Filter results performing case-insensitive matching against the name of the campaign. |
tags | string Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values |
createdBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
createdAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
campaignGroupId | integer Filter results to campaigns owned by the specified campaign group ID. |
templateId | integer The ID of the Campaign Template this Campaign was created from. |
Responses
Response samples
- 200
- 400
{- "totalResultSize": 1,
- "data": [
- {
- "id": 4,
- "created": "2020-06-10T09:05:27.993483Z",
- "applicationId": 322,
- "userId": 388,
- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-09-22T22:00:00Z",
- "attributes": { },
- "state": "enabled",
- "activeRulesetId": 6,
- "tags": [
- "summer"
], - "features": [
- "coupons",
- "referrals"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "couponRedemptionCount": 163,
- "referralRedemptionCount": 3,
- "discountCount": 288,
- "discountEffectCount": 343,
- "couponCreationCount": 16,
- "customEffectCount": 0,
- "referralCreationCount": 8,
- "addFreeItemEffectCount": 0,
- "awardedGiveawaysCount": 9,
- "createdLoyaltyPointsCount": 9,
- "createdLoyaltyPointsEffectCount": 2,
- "redeemedLoyaltyPointsCount": 8,
- "redeemedLoyaltyPointsEffectCount": 9,
- "callApiEffectCount": 0,
- "reservecouponEffectCount": 9,
- "lastActivity": "2022-11-10T23:00:00Z",
- "updated": "2022-10-97T35:00:00Z",
- "createdBy": "John Doe",
- "updatedBy": "Jane Doe",
- "templateId": 3
}
]
}
Get campaign
Retrieve the given campaign.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Responses
Response samples
- 200
{- "id": 4,
- "created": "2020-06-10T09:05:27.993483Z",
- "applicationId": 322,
- "userId": 388,
- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-09-22T22:00:00Z",
- "attributes": { },
- "state": "enabled",
- "activeRulesetId": 6,
- "tags": [
- "summer"
], - "features": [
- "coupons",
- "referrals"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "couponRedemptionCount": 163,
- "referralRedemptionCount": 3,
- "discountCount": 288,
- "discountEffectCount": 343,
- "couponCreationCount": 16,
- "customEffectCount": 0,
- "referralCreationCount": 8,
- "addFreeItemEffectCount": 0,
- "awardedGiveawaysCount": 9,
- "createdLoyaltyPointsCount": 9,
- "createdLoyaltyPointsEffectCount": 2,
- "redeemedLoyaltyPointsCount": 8,
- "redeemedLoyaltyPointsEffectCount": 9,
- "callApiEffectCount": 0,
- "reservecouponEffectCount": 9,
- "lastActivity": "2022-11-10T23:00:00Z",
- "updated": "2022-10-97T35:00:00Z",
- "createdBy": "John Doe",
- "updatedBy": "Jane Doe",
- "templateId": 3
}
Update campaign
Update the given campaign.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Request Body schema: application/json
body
name required | string non-empty A user-facing name for this campaign. |
tags required | Array of strings <= 50 items [ items [ 1 .. 50 ] characters ] A list of tags for the campaign. |
required | Array of objects The set of limits that will operate for this campaign. |
features required | Array of strings Items Enum: "coupons" "referrals" "loyalty" "giveaways" "strikethrough" A list of features for the campaign. |
description | string A detailed description of the campaign. |
startTime | string <date-time> Timestamp when the campaign will become active. |
endTime | string <date-time> Timestamp when the campaign will become inactive. |
object Arbitrary properties associated with this campaign. | |
state | string Default: "enabled" Enum: "enabled" "disabled" "archived" A disabled or archived campaign is not evaluated for rules or coupons. |
activeRulesetId | integer ID of Ruleset this campaign applies on customer session evaluation. |
object | |
object | |
campaignGroups | Array of integers The IDs of the campaign groups this campaign belongs to. |
Responses
Request samples
- Payload
{- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-10-01T02:00:00Z",
- "attributes": {
- "myattribute": 20
}, - "state": "disabled",
- "activeRulesetId": 2,
- "tags": [
- "Summer",
- "Shoes"
], - "features": [
- "coupons",
- "loyalty"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
]
}
Response samples
- 200
{- "id": 4,
- "created": "2020-06-10T09:05:27.993483Z",
- "applicationId": 322,
- "userId": 388,
- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-09-22T22:00:00Z",
- "attributes": { },
- "state": "enabled",
- "activeRulesetId": 6,
- "tags": [
- "summer"
], - "features": [
- "coupons",
- "referrals"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "couponRedemptionCount": 163,
- "referralRedemptionCount": 3,
- "discountCount": 288,
- "discountEffectCount": 343,
- "couponCreationCount": 16,
- "customEffectCount": 0,
- "referralCreationCount": 8,
- "addFreeItemEffectCount": 0,
- "awardedGiveawaysCount": 9,
- "createdLoyaltyPointsCount": 9,
- "createdLoyaltyPointsEffectCount": 2,
- "redeemedLoyaltyPointsCount": 8,
- "redeemedLoyaltyPointsEffectCount": 9,
- "callApiEffectCount": 0,
- "reservecouponEffectCount": 9,
- "lastActivity": "2022-11-10T23:00:00Z",
- "updated": "2022-10-97T35:00:00Z",
- "createdBy": "John Doe",
- "updatedBy": "Jane Doe",
- "templateId": 3
}
Delete campaign
Delete the given campaign.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Responses
Copy the campaign into the specified Application
Copy the campaign into all specified Applications.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Request Body schema: application/json
body
applicationIds required | Array of integers Application IDs of the applications to which a campaign should be copied to. |
name | string Name of the copied campaign (Defaults to "Copy of original campaign name"). |
description | string A detailed description of the campaign. |
startTime | string <date-time> Timestamp when the campaign will become active. |
endTime | string <date-time> Timestamp when the campaign will become inactive. |
tags | Array of strings <= 50 items [ items [ 1 .. 50 ] characters ] A list of tags for the campaign. |
evaluationGroupId | integer The ID of the campaign evaluation group the campaign belongs to. |
Responses
Request samples
- Payload
{- "name": "Copy of Summer promotions",
- "applicationIds": [
- 1,
- 2,
- 3
], - "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-06-01T09:00:27.993483Z",
- "endTime": "2021-09-10T01:00:00.993483Z",
- "tags": [
- "Summer",
- "Shoes"
], - "evaluationGroupId": 2
}
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 4,
- "created": "2020-06-10T09:05:27.993483Z",
- "applicationId": 322,
- "userId": 388,
- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-09-22T22:00:00Z",
- "attributes": { },
- "state": "enabled",
- "activeRulesetId": 6,
- "tags": [
- "summer"
], - "features": [
- "coupons",
- "referrals"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "couponRedemptionCount": 163,
- "referralRedemptionCount": 3,
- "discountCount": 288,
- "discountEffectCount": 343,
- "couponCreationCount": 16,
- "customEffectCount": 0,
- "referralCreationCount": 8,
- "addFreeItemEffectCount": 0,
- "awardedGiveawaysCount": 9,
- "createdLoyaltyPointsCount": 9,
- "createdLoyaltyPointsEffectCount": 2,
- "redeemedLoyaltyPointsCount": 8,
- "redeemedLoyaltyPointsEffectCount": 9,
- "callApiEffectCount": 0,
- "reservecouponEffectCount": 9,
- "lastActivity": "2022-11-10T23:00:00Z",
- "updated": "2022-10-97T35:00:00Z",
- "createdBy": "John Doe",
- "updatedBy": "Jane Doe",
- "templateId": 3
}
]
}
List campaigns that match the given attributes
Get a list of all the campaigns that match a set of attributes.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
campaignState | string Enum: "enabled" "disabled" "archived" "draft" "scheduled" "running" "expired" Filter results by the state of the campaign.
|
Request Body schema: application/json
body
required | object Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes. | ||
|
Responses
Request samples
- Payload
{- "attributes": { }
}
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 4,
- "created": "2020-06-10T09:05:27.993483Z",
- "applicationId": 322,
- "userId": 388,
- "name": "Summer promotions",
- "description": "Campaign for all summer 2021 promotions",
- "startTime": "2021-07-20T22:00:00Z",
- "endTime": "2021-09-22T22:00:00Z",
- "attributes": { },
- "state": "enabled",
- "activeRulesetId": 6,
- "tags": [
- "summer"
], - "features": [
- "coupons",
- "referrals"
], - "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "referralSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "campaignGroups": [
- 1,
- 3
], - "couponRedemptionCount": 163,
- "referralRedemptionCount": 3,
- "discountCount": 288,
- "discountEffectCount": 343,
- "couponCreationCount": 16,
- "customEffectCount": 0,
- "referralCreationCount": 8,
- "addFreeItemEffectCount": 0,
- "awardedGiveawaysCount": 9,
- "createdLoyaltyPointsCount": 9,
- "createdLoyaltyPointsEffectCount": 2,
- "redeemedLoyaltyPointsCount": 8,
- "redeemedLoyaltyPointsEffectCount": 9,
- "callApiEffectCount": 0,
- "reservecouponEffectCount": 9,
- "lastActivity": "2022-11-10T23:00:00Z",
- "updated": "2022-10-97T35:00:00Z",
- "createdBy": "John Doe",
- "updatedBy": "Jane Doe",
- "templateId": 3
}
]
}
List campaign rulesets
List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. Important: The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
Responses
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "userId": 388,
- "rules": [
- {
- "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "title": "Give discount via coupon",
- "description": "Creates a discount when a coupon is valid",
- "bindings": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "condition": [
- "and",
- [
- "couponValid"
]
], - "effects": [
- "catch",
- [
- "noop"
], - [
- "setDiscount",
- "10% off",
- [
- "*",
- [
- ".",
- "Session",
- "Total"
], - [
- "/",
- 10,
- 100
]
]
]
]
}
], - "strikethroughRules": [
- {
- "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "title": "Give discount via coupon",
- "description": "Creates a discount when a coupon is valid",
- "bindings": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "condition": [
- "and",
- [
- "couponValid"
]
], - "effects": [
- "catch",
- [
- "noop"
], - [
- "setDiscount",
- "10% off",
- [
- "*",
- [
- ".",
- "Session",
- "Total"
], - [
- "/",
- 10,
- 100
]
]
]
]
}
], - "bindings": [ ],
- "rbVersion": "v2",
- "activate": true,
- "campaignId": 320,
- "templateId": 3,
- "activatedAt": "2019-08-24T14:15:22Z"
}
]
}
Get ruleset
Retrieve the specified ruleset.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
rulesetId required | integer The ID of the ruleset. |
Responses
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "userId": 388,
- "rules": [
- {
- "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "title": "Give discount via coupon",
- "description": "Creates a discount when a coupon is valid",
- "bindings": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "condition": [
- "and",
- [
- "couponValid"
]
], - "effects": [
- "catch",
- [
- "noop"
], - [
- "setDiscount",
- "10% off",
- [
- "*",
- [
- ".",
- "Session",
- "Total"
], - [
- "/",
- 10,
- 100
]
]
]
]
}
], - "strikethroughRules": [
- {
- "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
- "title": "Give discount via coupon",
- "description": "Creates a discount when a coupon is valid",
- "bindings": [
- {
- "name": "my property",
- "type": "templateParameter",
- "expression": [
- { }
], - "valueType": "string"
}
], - "condition": [
- "and",
- [
- "couponValid"
]
], - "effects": [
- "catch",
- [
- "noop"
], - [
- "setDiscount",
- "10% off",
- [
- "*",
- [
- ".",
- "Session",
- "Total"
], - [
- "/",
- 10,
- 100
]
]
]
]
}
], - "bindings": [ ],
- "rbVersion": "v2",
- "activate": true,
- "campaignId": 320,
- "templateId": 3,
- "activatedAt": "2019-08-24T14:15:22Z"
}
Get analytics of campaigns
Retrieve statistical data about the performance of the given campaign.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
rangeStart required | string <date-time> Only return results from after this timestamp. This must be an RFC3339 timestamp string. |
rangeEnd required | string <date-time> Only return results from before this timestamp. This must be an RFC3339 timestamp string. |
granularity | string Enum: "1 hour" "1 day" "1 week" "1 month" "1 year" The time interval between the results in the returned time-series. |
Responses
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "date": "2021-10-12T10:12:42Z",
- "campaignRevenue": 3539.76,
- "totalCampaignRevenue": 5784.63,
- "campaignRefund": 0,
- "totalCampaignRefund": 0,
- "campaignDiscountCosts": 0,
- "totalCampaignDiscountCosts": 0,
- "campaignRefundedDiscounts": 0,
- "totalCampaignRefundedDiscounts": 0,
- "campaignFreeItems": 0,
- "totalCampaignFreeItems": 86,
- "couponRedemptions": 0,
- "totalCouponRedemptions": 0,
- "couponRolledbackRedemptions": 0,
- "totalCouponRolledbackRedemptions": 0,
- "referralRedemptions": 0,
- "totalReferralRedemptions": 0,
- "couponsCreated": 0,
- "totalCouponsCreated": 0,
- "referralsCreated": 0,
- "totalReferralsCreated": 0,
- "addedLoyaltyPoints": 250,
- "totalAddedLoyaltyPoints": 340,
- "deductedLoyaltyPoints": 120,
- "totalDeductedLoyaltyPoints": 220
}
]
}
Represents a catalog of cart items with unique SKUs. Cart item catalogs allow you to synchronize your entire inventory with Talon.One.
See the docs.
List items in a catalog
Return a paginated list of cart items in the given catalog.
Authorizations:
path Parameters
catalogId required | integer The ID of the catalog. You can find the ID in the Campaign Manager in Account > Tools > Cart item catalogs. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
withTotalResultSize | boolean When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
|
sku | string The SKU of the item. |
Responses
Response samples
- 200
{- "hasMore": true,
- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "sku": "SKU1241028",
- "price": 99.99,
- "catalogid": 6,
- "version": 5,
- "attributes": [
- {
- "attributeid": 6,
- "name": "string",
- "value": null
}
]
}
]
}
Represents a collection of arbitrary values that you can use inside rules. For example, a list of SKUs.
See the docs.
List collections in account
List collections in account.
Authorizations:
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
withTotalResultSize | boolean When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
|
name | string Filter by the name of the Collection. |
Responses
Response samples
- 200
- 400
- 401
- 404
{- "hasMore": true,
- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7
}
]
}
Create account-level collection
Create account-level collection.
Authorizations:
Request Body schema: application/json
body
name required | string non-empty ^[^[:cntrl:]\s][^[:cntrl:]]*$ The name of this collection. |
description | string A short description of the purpose of this collection. |
subscribedApplicationsIds | Array of integers A list of the IDs of the Applications where this collection is enabled. |
Responses
Request samples
- Payload
{- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection"
}
Response samples
- 201
- 400
- 401
- 409
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
Get account-level collection
Retrieve a given account-level collection.
Authorizations:
path Parameters
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Responses
Response samples
- 200
- 404
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
Delete account-level collection
Delete the given account-level collection.
Authorizations:
path Parameters
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Responses
Response samples
- 404
{- "message": "string",
- "errors": [
- {
- "title": "string",
- "details": "string",
- "source": {
- "pointer": "string",
- "parameter": "string",
- "line": "string",
- "resource": "string"
}
}
], - "StatusCode": 0
}
Update account-level collection
Edit the description of the account-level collection and enable or disable the collection in the specified Applications.
Authorizations:
path Parameters
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Request Body schema: application/json
body
description | string A short description of the purpose of this collection. |
subscribedApplicationsIds | Array of integers A list of the IDs of the Applications where this collection is enabled. |
Responses
Request samples
- Payload
{- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
]
}
Response samples
- 200
- 400
- 401
- 409
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
Get collection items
Retrieve the items from the given collection.
Authorizations:
path Parameters
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
Responses
Response samples
- 200
- 404
{- "hasMore": true,
- "data": [
- {
- "item": "string"
}
]
}
List collections in application
List collections from all campaigns in the Application.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
withTotalResultSize | boolean When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
|
name | string Filter by the name of the Collection. |
Responses
Response samples
- 200
- 404
{- "hasMore": true,
- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
]
}
List collections
List collections in the campaign.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
withTotalResultSize | boolean When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets.
|
name | string Filter by the name of the Collection. |
Responses
Response samples
- 200
- 404
{- "hasMore": true,
- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
]
}
Create collection
Create a collection.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Request Body schema: application/json
body
name required | string non-empty ^[^[:cntrl:]\s][^[:cntrl:]]*$ The name of this collection. |
description | string A short description of the purpose of this collection. |
Responses
Request samples
- Payload
{- "description": "My collection of SKUs",
- "name": "My collection"
}
Response samples
- 201
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
Get collection
Retrieve a given collection.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Responses
Response samples
- 200
- 404
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
Update collection description
Edit the description of the collection.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Request Body schema: application/json
body
description | string A short description of the purpose of this collection. |
Responses
Request samples
- Payload
{- "description": "My collection of SKUs"
}
Response samples
- 200
- 401
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "modified": "2021-09-12T10:12:42Z",
- "description": "My collection of SKUs",
- "subscribedApplicationsIds": [
- 1,
- 2,
- 3
], - "name": "My collection",
- "modifiedBy": 48,
- "createdBy": 134,
- "applicationId": 1,
- "campaignId": 7,
- "payload": [
- "KTL-WH-ET-1",
- "KTL-BL-ET-1"
]
}
Delete collection
Delete the given collection.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Responses
Response samples
- 401
{- "message": "string",
- "errors": [
- {
- "title": "string",
- "details": "string",
- "source": {
- "pointer": "string",
- "parameter": "string",
- "line": "string",
- "resource": "string"
}
}
], - "StatusCode": 0
}
Import data in existing collection
Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data.
The import replaces the initial content of the collection.
The CSV file must only contain the following column:
item
: the values in your collection.
A collection is limited to 500,000 items.
Example:
item
Addidas
Nike
Asics
Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Request Body schema: multipart/form-data
upFile | string <csv> The file with the information about the data that should be imported. |
Responses
Response samples
- 200
- 401
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "userId": 388,
- "entity": "AttributeAllowedList",
- "amount": 10
}
Import data in existing account-level collection
Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data.
The import replaces the initial content of the collection.
The CSV file must only contain the following column:
item
: the values in your collection.
A collection is limited to 500,000 items.
Example:
item
Addidas
Nike
Asics
Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
Authorizations:
path Parameters
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Request Body schema: multipart/form-data
upFile | string <csv> The file with the information about the data that should be imported. |
Responses
Response samples
- 200
- 400
- 401
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "accountId": 3886,
- "userId": 388,
- "entity": "AttributeAllowedList",
- "amount": 10
}
Export account-level collection's items
Download a CSV file containing items from an account-level collection.
Tip: If the exported CSV file is too large to view, you can split it into multiple files.
Authorizations:
path Parameters
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Responses
Response samples
- 200
item SKU1 SKU2 SKU3
Export a collection's items
Download a CSV file containing a collection's items.
Tip: If the exported CSV file is too large to view, you can split it into multiple files.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
collectionId required | integer The ID of the collection. You can get it with the List collection in account endpoint. |
Responses
Response samples
- 200
item SKU1 SKU2 SKU3
Coupons are unique codes belonging to a particular campaign. They don't define any behavior on their own. Instead the campaign ruleset can include rules that validate coupons and carry out particular effects.
See the docs.
Create coupons
Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
silent | string Default: "yes" Possible values:
|
Request Body schema: application/json
body
numberOfCoupons required | integer The number of new coupon codes to generate for the campaign. Must be at least 1. |
usageLimit required | integer [ 0 .. 999999 ] The number of times the coupon code can be redeemed. |
discountLimit | number [ 0 .. 999999 ] The total discount value that the code can give. Typically used to represent a gift card value. |
reservationLimit | integer [ 0 .. 999999 ] The number of reservations that can be made with this coupon code. |
startDate | string <date-time> >= 0 Timestamp at which point the coupon becomes valid. |
expiryDate | string <date-time> >= 0 Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. |
Array of objects Limits configuration for a coupon. These limits will override the limits set from the campaign. Note: Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | |
uniquePrefix | string DEPRECATED To create more than 20,000 coupons in one request, use Create coupons asynchronously endpoint. |
object Arbitrary properties associated with this item. | |
recipientIntegrationId | string <= 1000 characters The integration ID for this coupon's beneficiary's profile. |
validCharacters | Array of strings List of characters used to generate the random parts of a code. By default,
the list of characters is equivalent to the |
couponPattern | string [ 3 .. 100 ] characters The pattern used to generate coupon codes.
The character |
isReservationMandatory | boolean Default: true Whether the reservation effect actually created a new reservation. |
Responses
Request samples
- Payload
{- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "numberOfCoupons": 1,
- "uniquePrefix": "",
- "attributes": {
- "venueId": 12
}, - "recipientIntegrationId": "URNGV8294NV",
- "validCharacters": [
- "A",
- "B",
- "G",
- "Y"
], - "couponPattern": "SUMMER-#####",
- "isReservationMandatory": false
}
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "campaignId": 211,
- "value": "XMAS-20-2021",
- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "usageCounter": 10,
- "discountCounter": 10,
- "discountRemainder": 5,
- "reservationCounter": 1,
- "attributes": { },
- "referralId": 326632952,
- "recipientIntegrationId": "URNGV8294NV",
- "importId": 4,
- "reservation": false,
- "batchId": "32535-43255",
- "isReservationMandatory": false
}
]
}
Update coupons
Update all coupons, or a specific batch of coupons, in a campaign.
You can find the batchId
in the Coupons view of your Application
in the Campaign Manager, or you can use List coupons.
Important
- Only send sequential requests to this endpoint.
- Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.
To update a specific coupon, use Update coupon.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Request Body schema: application/json
body
usageLimit | integer [ 0 .. 999999 ] The number of times the coupon code can be redeemed. |
discountLimit | number [ 0 .. 999999 ] The total discount value that the code can give. Typically used to represent a gift card value. |
reservationLimit | integer [ 0 .. 999999 ] The number of reservations that can be made with this coupon code. |
startDate | string <date-time> >= 0 Timestamp at which point the coupon becomes valid. |
expiryDate | string <date-time> >= 0 Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. |
object Arbitrary properties associated with this item. | |
batchID | string The id of the batch the coupon belongs to. |
Responses
Request samples
- Payload
{- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "attributes": { },
- "batchID": "string"
}
Delete coupons
Deletes all the coupons matching the specified criteria.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
value | string Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. |
createdBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
createdAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
startsAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
startsBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
expiresAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
expiresBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
valid | string Enum: "expired" "validNow" "validFuture"
|
batchId | string Filter results by batches of coupons |
usable | string Enum: "true" "false"
|
referralId | integer Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. |
recipientIntegrationId | string Filter results by match with a profile id specified in the coupon's |
exactMatch | boolean Default: false Filter results to an exact case-insensitive matching against the coupon code |
Responses
Create coupons for multiple recipients
Create coupons according to some pattern for up to 1000 recipients.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
silent | string Default: "yes" Possible values:
|
Request Body schema: application/json
body
recipientsIntegrationIds required | Array of strings [ 1 .. 1000 ] items The integration IDs for recipients. |
usageLimit required | integer [ 0 .. 999999 ] The number of times the coupon code can be redeemed. |
discountLimit | number [ 0 .. 999999 ] The total discount value that the code can give. Typically used to represent a gift card value. |
reservationLimit | integer [ 0 .. 999999 ] The number of reservations that can be made with this coupon code. |
startDate | string <date-time> >= 0 Timestamp at which point the coupon becomes valid. |
expiryDate | string <date-time> >= 0 Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. |
object Arbitrary properties associated with this item. | |
validCharacters | Array of strings List of characters used to generate the random parts of a code. By default, the list of
characters is equivalent to the |
couponPattern | string [ 3 .. 100 ] characters The pattern used to generate coupon codes. The character |
Responses
Request samples
- Payload
{- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "attributes": {
- "venueId": 12
}, - "recipientsIntegrationIds": [
- "URNGV8294NV",
- "BZGGC2454PA"
], - "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z"
], - "couponPattern": "SUMMER-#####"
}
Response samples
- 200
{- "totalResultSize": 1,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "campaignId": 211,
- "value": "XMAS-20-2021",
- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "usageCounter": 10,
- "discountCounter": 10,
- "discountRemainder": 5,
- "reservationCounter": 1,
- "attributes": { },
- "referralId": 326632952,
- "recipientIntegrationId": "URNGV8294NV",
- "importId": 4,
- "reservation": false,
- "batchId": "32535-43255",
- "isReservationMandatory": false
}
]
}
Create coupons asynchronously
Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete.
If you want to create less than 20,001 coupons, you can use the Create coupons endpoint.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
Request Body schema: application/json
body
numberOfCoupons required | integer [ 1 .. 5000000 ] The number of new coupon codes to generate for the campaign. |
usageLimit required | integer [ 0 .. 999999 ] The number of times the coupon code can be redeemed. |
required | object Arbitrary properties associated with coupons. |
discountLimit | number [ 0 .. 999999 ] The total discount value that the code can give. Typically used to represent a gift card value. |
reservationLimit | integer [ 0 .. 999999 ] The number of reservations that can be made with this coupon code. |
startDate | string <date-time> >= 0 Timestamp at which point the coupon becomes valid. |
expiryDate | string <date-time> >= 0 Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. |
object |
Responses
Request samples
- Payload
{- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "numberOfCoupons": 200000,
- "couponSettings": {
- "validCharacters": [
- "A",
- "B",
- "C",
- "D",
- "E",
- "F",
- "G",
- "H",
- "I",
- "J",
- "K",
- "L",
- "M",
- "N",
- "O",
- "P",
- "Q",
- "R",
- "S",
- "T",
- "U",
- "V",
- "W",
- "X",
- "Y",
- "Z",
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
- "8",
- "9"
], - "couponPattern": "SUMMER-####-####"
}, - "attributes": { }
}
Response samples
- 200
{- "batchId": "tqyrgahe"
}
List coupons
List all the coupons matching the specified criteria.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
value | string Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. |
createdBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
createdAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
valid | string Enum: "expired" "validNow" "validFuture" Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. |
usable | string Enum: "true" "false" Either "true" or "false". If "true", only coupons where |
referralId | integer Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. |
recipientIntegrationId | string Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field |
batchId | string Filter results by batches of coupons |
exactMatch | boolean Default: false Filter results to an exact case-insensitive matching against the coupon code |
Responses
Response samples
- 200
{- "hasMore": true,
- "data": [
- {
- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "campaignId": 211,
- "value": "XMAS-20-2021",
- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "usageCounter": 10,
- "discountCounter": 10,
- "discountRemainder": 5,
- "reservationCounter": 1,
- "attributes": { },
- "referralId": 326632952,
- "recipientIntegrationId": "URNGV8294NV",
- "importId": 4,
- "reservation": false,
- "batchId": "32535-43255",
- "isReservationMandatory": false
}
]
}
Update coupon
Update the specified coupon.
Important
With this PUT endpoint only, any property you do not explicitly set in your request
will be set to null
.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
couponId required | string The internal ID of the coupon code. You can find this value in the |
Request Body schema: application/json
body
usageLimit | integer [ 0 .. 999999 ] The number of times the coupon code can be redeemed. |
discountLimit | number [ 0 .. 999999 ] The total discount value that the code can give. Typically used to represent a gift card value. |
reservationLimit | integer [ 0 .. 999999 ] The number of reservations that can be made with this coupon code. |
startDate | string <date-time> >= 0 Timestamp at which point the coupon becomes valid. |
expiryDate | string <date-time> >= 0 Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. |
Array of objects Limits configuration for a coupon. These limits will override the limits set from the campaign. Note: Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | |
recipientIntegrationId | string <= 1000 characters The integration ID for this coupon's beneficiary's profile. |
object Arbitrary properties associated with this item. | |
isReservationMandatory | boolean Default: true Whether the reservation effect actually created a new reservation. |
Responses
Request samples
- Payload
{- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "recipientIntegrationId": "URNGV8294NV",
- "attributes": { },
- "isReservationMandatory": false
}
Response samples
- 200
{- "id": 6,
- "created": "2020-06-10T09:05:27.993483Z",
- "campaignId": 211,
- "value": "XMAS-20-2021",
- "usageLimit": 100,
- "discountLimit": 30,
- "reservationLimit": 45,
- "startDate": "2020-01-24T14:15:22Z",
- "expiryDate": "2023-08-24T14:15:22Z",
- "limits": [
- {
- "action": "createCoupon",
- "limit": 1000,
- "period": "yearly",
- "entities": [
- "Coupon"
]
}
], - "usageCounter": 10,
- "discountCounter": 10,
- "discountRemainder": 5,
- "reservationCounter": 1,
- "attributes": { },
- "referralId": 326632952,
- "recipientIntegrationId": "URNGV8294NV",
- "importId": 4,
- "reservation": false,
- "batchId": "32535-43255",
- "isReservationMandatory": false
}
Delete coupon
Delete the specified coupon.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
couponId required | string The internal ID of the coupon code. You can find this value in the |
Responses
List coupons that match the given attributes in campaign (without total count)
List the coupons whose attributes match the query criteria in the given campaign.
The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request.
Note: The total count is not included in the response.
Authorizations:
path Parameters
applicationId required | integer The ID of the Application. It is displayed in your Talon.One deployment URL. |
campaignId required | integer The ID of the campaign. It is displayed in your Talon.One deployment URL. |
query Parameters
pageSize | integer [ 1 .. 1000 ] Default: 1000 The number of items in this response. |
skip | integer The number of items to skip when paging through large result sets. |
sort | string The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with Note: This parameter works only with numeric fields. |
value | string Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. |
createdBefore | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
createdAfter | string <date-time> Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
valid | string Enum: "expired" "validNow" "validFuture" Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third m |