Ctrlk
Help CenterContact Support

Deals

Endpoints for retrieving partner deal and promotional offer details.

List Deals

get

Returns a list of all deals associated with a specific campaign.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

CampaignIdstringRequired

Unique identifier for the campaign whose deals are being retrieved.

Query parameters
Scopestring · enumOptional

Filters deals by the scope of products they apply to.

Possible values:
Statestring · enumOptional

Filters deals by their current state.

Possible values:
Typestring · enumOptional

Filters deals by their promotional type.

Possible values:
Responses
200

A list of deal objects.

application/json
get
/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Deals
200

A list of deal objects.

Retrieve a Deal

get

Retrieves the full details of an existing deal using its unique ID.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

CampaignIdstringRequired

Unique identifier for the campaign whose deals are being retrieved.

IdstringRequired

The unique identifier for the deal.

Responses
200

The deal object.

application/json
IdstringOptional

Unique identifier for the deal.

Example: 92812
NamestringOptional

Display name of the deal.

Example: Gotham Supply Crate
DescriptionstringOptional

A short description of the deal shown to partners.

Example: Every mission needs a little extra. Unlock a mystery item with your order.
PublicbooleanOptional

Whether the deal is publicly visible to all partners. If false, the deal is exclusive to specific partners.

Example: true
CampaignIdstringOptional

Unique identifier for the campaign this deal belongs to.

Example: 10306
Statestring · enumOptional

The current state of the deal.

Example: ACTIVEPossible values:
Typestring · enumOptional

The type of promotional offer.

Example: GENERAL_SALEPossible values:
Scopestring · enumOptional

The scope of products the deal applies to. Not returned for BOGO deals.

Example: ENTIRE_STOREPossible values:
Categoriesstring[]Optional

Product categories associated with the deal. Populated when Scope is CATEGORY.

DiscountTypestring · enumOptional

The method used to calculate the discount amount.

Example: PERCENTPossible values:
DiscountAmountstringOptional

The fixed discount amount. Populated when DiscountType is FIXED.

DiscountCurrencystringOptional

ISO 4217 currency code for the fixed discount amount.

DiscountPercentstringOptional

The percentage discount. Populated when DiscountType is PERCENT.

Example: 99
DiscountMaximumPercentstringOptional

The maximum percentage discount. Populated when DiscountType is PERCENT_MAXIMUM.

DiscountPercentRangeStartstringOptional

The lower bound of a percentage discount range. Populated when DiscountType is PERCENT_RANGE.

DiscountPercentRangeEndstringOptional

The upper bound of a percentage discount range. Populated when DiscountType is PERCENT_RANGE.

GiftstringOptional

Description of the gift item. Populated for GIFT_WITH_PURCHASE deals.

RebateAmountstringOptional

The rebate amount. Populated for REBATE deals.

RebateCurrencystringOptional

ISO 4217 currency code for the rebate amount.

DefaultPromoCodestringOptional

The default promo code associated with this deal, if any.

Example: Percent Discount Deal Test
MinimumPurchaseAmountstringOptional

The minimum purchase amount required to qualify for the deal.

MinimumPurchaseAmountCurrencystringOptional

ISO 4217 currency code for the minimum purchase amount.

MaximumSavingsAmountstringOptional

The maximum savings a customer can receive from this deal.

MaximumSavingsCurrencystringOptional

ISO 4217 currency code for the maximum savings amount.

BogoBuyQuantitystringOptional

The quantity the customer must buy to trigger the BOGO offer.

Example: 0
BogoBuyScopestringOptional

The scope of products the customer must buy to qualify for the BOGO offer (e.g., PRODUCT, CATEGORY, ENTIRE_STORE).

BogoBuyNamestringOptional

Display name of the product or category the customer must buy.

BogoBuyImageUrlstringOptional

URL of the image for the buy-side product in a BOGO offer.

BogoGetQuantitystringOptional

The quantity of the free or discounted product the customer receives in a BOGO offer.

Example: 0
BogoGetScopestringOptional

The scope of products the customer receives in a BOGO offer (e.g., PRODUCT, CATEGORY, ENTIRE_STORE).

BogoGetDiscountTypestring · enumOptional

The type of discount applied to the received product in a BOGO offer.

Possible values:
BogoGetNamestringOptional

Display name of the product or category the customer receives in a BOGO offer.

BogoGetImageUrlstringOptional

URL of the image for the get-side product in a BOGO offer.

BogoGetDiscountAmountstringOptional

The discount amount applied to the received product. Populated when BogoGetDiscountType is AMOUNT.

BogoGetDiscountCurrencystringOptional

ISO 4217 currency code for the BogoGetDiscountAmount.

BogoGetDiscountPercentstringOptional

The discount percentage applied to the received product. Populated when BogoGetDiscountType is PERCENT.

PurchaseLimitQuantitystringOptional

The maximum number of times a customer can use this deal. Zero means unlimited.

Example: 0
StartDatestring · date-timeOptional

The date and time the deal becomes active (ISO 8601). Empty if the deal has no start date.

EndDatestring · date-timeOptional

The date and time the deal expires (ISO 8601). Empty if the deal has no end date.

DateCreatedstring · date-timeOptional

Date and time the deal was created (ISO 8601).

Example: 2020-12-11T11:08:42-08:00
DateLastUpdatedstring · date-timeOptional

Date and time the deal was last updated (ISO 8601).

Example: 2025-12-10T16:04:28-08:00
UristringOptional

Unique reference to the deal object in the impact.com API.

Example: /Mediapartners/<AccountSID>/Campaigns/10306/Deals/92812
get
/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Deals/{Id}
200

The deal object.

PreviousDealsNextModels

Last updated