younifyd
Menu

Search Coupons Advanced Application Wide Without Total Count

List Coupons That Match Given Attributes

POST/v1/applications/{applicationId}/coupons_search_advanced/no_total

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Search Coupons Advanced Application Wide Without Total Count action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{searchCouponsAdvancedApplicationWideWithoutTotalCount.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

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

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

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:** You may not be able to use all fields for sorting. This is due to performance limitations.

valuestring

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.

createdBeforestring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

validstring

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.

One ofexpiredvalidNowvalidFuture

usablestring

Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`.

One oftruefalse

referralIdinteger (int64)

Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

recipientIntegrationIdstring

Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.

batchIdstring

Filter results by batches of coupons

exactMatchboolean

Filter results to an exact case-insensitive matching against the coupon code.

Default false

campaignStatestring

Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.

One ofenableddisabledarchivedscheduledrunningexpiredstaged

Response

Returns 200 with an object. Read it in later steps with {{searchCouponsAdvancedApplicationWideWithoutTotalCount.response.data.<field>}}.

hasMoreboolean
dataarray<object>
idinteger (int64)required

The internal ID of the coupon.

createdstring (date-time)required

The time the coupon was created.

campaignIdinteger (int64)required

The ID of the campaign that owns this entity.

valuestringrequired

The coupon code.

usageLimitinteger (int64)required

The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.

discountLimitnumber

The total discount value that the code can give. Typically used to represent a gift card value.

reservationLimitinteger (int64)

The number of reservations that can be made with this coupon code.

startDatestring (date-time)

Timestamp at which point the coupon becomes valid.

expiryDatestring (date-time)

Expiration date of the coupon. Coupon never expires if this is omitted.

limitsarray<object>4 fields

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.

usageCounterinteger (int64)required

The number of times the coupon has been successfully redeemed.

discountCounternumber

The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon.

discountRemaindernumber

The remaining discount this coupon can give.

reservationCounternumber

The number of times this coupon has been reserved.

attributesobject

Custom attributes associated with this coupon.

referralIdinteger (int64)

The integration ID of the referring customer (if any) for whom this coupon was created as an effect.

recipientIntegrationIdstring

The Integration ID of the customer that is allowed to redeem this coupon.

importIdinteger (int64)

The ID of the Import which created this coupon.

reservationboolean

Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code.

Default true

batchIdstring

The id of the batch the coupon belongs to.

isReservationMandatoryboolean

An indication of whether the code can be redeemed only if it has been reserved first.

Default false

implicitlyReservedboolean

An indication of whether the coupon is implicitly reserved for all customers.

json
{
  "hasMore": true,
  "data": [
    {
      "recipientIntegrationId": "URNGV8294NV",
      "implicitlyReserved": false,
      "created": {},
      "campaignId": 211,
      "usageLimit": 100,
      "referralId": 326632952,
      "usageCounter": 10,
      "batchId": "32535-43255",
      "discountCounter": 10,
      "expiryDate": {},
      "importId": 4,
      "reservationLimit": 45,
      "reservationCounter": 1,
      "reservation": false,
      "attributes": "{}",
      "id": 6,
      "value": "XMAS-20-2021",
      "discountLimit": 30,
      "startDate": {},
      "limits": [
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        },
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        }
      ],
      "discountRemainder": 5,
      "isReservationMandatory": false
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.