TAtalon
Applications

Get Application

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Get the Application specified by the ID.

get/v1/applications/{applicationId}

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

modifiedstring date-time required

The time this entity was last modified.

accountIdinteger required

The ID of the account that owns this entity.

namestring required

The name of this application.

descriptionstring

A longer description of the application.

timezonestring required

A string containing an IANA timezone descriptor.

currencystring required

The default currency for new customer sessions.

caseSensitivity'sensitive' | 'insensitive-uppercase' | 'insensitive-lowercase'

The case sensitivity behavior to check coupon codes in the campaigns of this Application.

attributesobject

Arbitrary properties associated with this campaign.

defaultDiscountScope'sessionTotal' | 'cartItems' | 'additionalCosts'

The default scope to apply setDiscount effects on if no scope was provided with the effect.

enableCascadingDiscountsboolean

Indicates if discounts should cascade for this Application.

enableFlattenedCartItemsboolean

Indicates if cart items of quantity larger than one should be separated into different items of quantity one.

sandboxboolean

Indicates if this is a live or sandbox Application.

enablePartialDiscountsboolean

Indicates if this Application supports partial discounts.

defaultDiscountAdditionalCostPerItemScope'price' | 'itemTotal' | 'additionalCosts'

The default scope to apply setDiscountPerItem effects on if no scope was provided with the effect.

defaultEvaluationGroupIdinteger

The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign.

defaultCartItemFilterIdinteger

The ID of the default Cart-Item-Filter for this application.

enableCampaignStateManagementboolean

Indicates whether the campaign staging and revisions feature is enabled for the Application.

Important: After this feature is enabled, it cannot be disabled.

Example response

{
  "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",
  "limits": [
    {
      "action": "createCoupon",
      "limit": 1000,
      "period": "yearly",
      "entities": [
        "Coupon"
      ]
    }
  ],
  "defaultDiscountScope": "sessionTotal",
  "enableCascadingDiscounts": true,
  "enableFlattenedCartItems": true,
  "sandbox": true,
  "defaultDiscountAdditionalCostPerItemScope": "price",
  "defaultEvaluationGroupId": 3,
  "defaultCartItemFilterId": 3,
  "bestPriorPriceSettings": {
    "enableBestPriorPrice": true
  },
  "loyaltyPrograms": [
    {
      "id": 139,
      "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",
      "usersPerCardLimit": 111,
      "sandbox": true,
      "tierCycleStartDate": "2021-09-12T10:12:42Z",
      "tiersExpireIn": "27W_U",
      "cardCodeSettings": {
        "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-####-####"
      },
      "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,
      "canUpdateTierExpirationPolicy": true,
      "canUpgradeToAdvancedTiers": true,
      "canUpdateSubledgers": true
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.