API Reference

Create a deal

Creates a new deal.

Parameters

CampaignId required

Id of the campaign to be associated with the deal.

Name required

Name of the deal.

Scope required

To what extent the deal applies to the store.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.

Type required

What the deal does.

View possible enum values
BOGODeal will apply a buy-one-get-one deal to the order. The following parameters are required: BogoBuyQuantity,
BogoBuyName,
BogoBuyScope,
BogoGetQuantity,
BogoGetName,
BogoGetScope,
BogoGetDiscountType.
GENERAL_SALEDeal applies a general discount to the products identified in DealScope. One of the following parameter sets is required:
DiscountPercent,
DiscountAmount together with DiscountCurrency,
DiscountMaximumPercent, or
DiscountPercentRangeStart together with DiscountPercentRangeEnd.
FREE_SHIPPINGDeal applies free shipping to the order.
GIFT_WITH_PURCHASEA gift will come with the order. Gift parameter is required.
REBATEA rebate will be available to the customer upon purchase. RebateAmount and RebateCurrency are required.

ProductName optional

Products the deal applies to. Cannot use if Scope≠PRODUCT.

Categories optional

Categories to which this deal belongs. Cannot use if Scope≠"CATEGORY".

RestrictedMediaPartners optional

Comma-separated list of Partner Id values.

RestrictedMediaPartnerGroups optional

Comma-separated list of Media Partner Group Id values.

BOGO parameters

View BOGO parameters

BogoBuyImageFileName optional

URL to the "buy" product's image. Cannot use if Type≠"BOGO".

BogoBuyName optional

Name of the "buy" product. Cannot use if Type≠"BOGO".

BogoBuyQuantity optional

"Buy" product quantity available. Cannot use if Type≠"BOGO".

BogoBuyScope optional

"Buy" product scope. Cannot use if Type≠"BOGO".

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoGetDiscountAmount optional

"Get" product discount amount. Cannot use if Type≠"BOGO" and BogoGetDiscountType≠"AMOUNT".

BogoGetDiscountType optional

"Get" product discount type. Cannot use if Type≠"BOGO".

View possible enum values
FREECustomer will receive the "Get" item for free.
AMOUNTCustomer will receive a specific amount of money off of the GET item's cost. BogoGetDiscountAmount is required.
PERCENTCustomer will receive a percent off of the `GET` item's cost. BogoGetDiscountPercent is required.

BogoGetDiscountPercent optional

"Get" product discount percentage. Cannot use if Type≠"BOGO" and BogoGetDiscountType≠"PERCENT".

BogoGetImageFileName optional

URL to the "get" product's image. Cannot use if Type≠"BOGO".

BogoGetName optional

"Get" product name. Cannot use if Type≠"BOGO".

BogoGetQuantity optional

"Get" product quantity available. Cannot use if Type≠"BOGO".

BogoGetScope optional

"Get" product scope. Cannot use if Type≠"BOGO".

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

General Sale parameters

View General Sale parameters

DiscountType optional

What kind of discount a consumer will get. Use only if Type="GENERAL_SALE".

View possible enum values
FIXEDDeal gives a fixed amount off.
PERCENTDeal gives a percentage off.
PERCENT_RANGEDeal gives a percentage range off.
PERCENT_MAXIMUMDeal gives up to a certain percentage off.

DiscountAmount optional

Deal's discount amount. Cannot use if DiscountType≠"FIXED".

DiscountCurrency optional

Deal's discount amount currency code. Cannot use if DiscountType≠"FIXED". See impact.com's supported currencies.

DiscountMaximumPercent optional

Maximum discount percent. Cannot use if DiscountType≠"PERCENT_MAXIMUM".

DiscountPercent optional

Deal's discount percent. Cannot use if DiscountType≠"PERCENT".

DiscountPercentRangeStart optional

Beginning of the discount range. Cannot use if DiscountType≠"PERCENT_RANGE".

DiscountPercentRangeEnd optional

End of the discount range. Cannot use if DiscountType≠"PERCENT_RANGE".

Gift parameters

View Gift parameters

Gift optional

Name of the gift that comes with a purchase. Cannot use if Type≠"GIFT_WITH_PURCHASE".

Rebate parameters

View Rebate parameters

RebateAmount optional

Purchase rebate amount. Cannot use if Type≠"REBATE".

RebateCurrency optional

Purchase rebate currency code. Cannot use if Type≠"REBATE". See impact.com's supported currencies.

DefaultPromoCode optional

A promo code partners that have access to this deal can use. This promo code can always be used to activate the deal.

StartDate optional

Date and time the deal begins. See ISO 8601.

EndDate optional

Date and time the deal ends. See ISO 8601.

MinimumSavingsAmount optional

Minimum savings a consumer will get when this deal is applied.

MinimumSavingsCurrency optional

Currency of the deal's minimum purchase savings. See impact.com's supported currencies.

MaximumSavingsAmount optional

Maximum savings a consumer will get when this deal is applied.

MaximumSavingsCurrency optional

Currency of the deal's maximum purchase savings. See impact.com's supported currencies.

More parameters

View more parameters

Description optional

Description of the deal.

ProductBeforePriceAmount optional

Product's price before the deal applies.

ProductBeforePriceCurrency optional

Product's price's currency code before the deal applies. See impact.com's supported currencies.

ProductAfterPriceAmount optional

Product's price after the deal applies.

ProductAfterPriceCurrency optional

Product's price's currency code after the deal applies. See impact.com's supported currencies.

ProductFileName optional

Name of the file uploaded that contains the product's image.

PurchaseLimitQuantity optional

Maximum quantity of "buy" product purchasable in one transaction. Enter 0 to have no purchase limit.

SynchAdsPromoCodes optional

Use true if the deal should align the state and date range of all related ads and promo codes to the deal's. Use false to prevent the deal does not have this. Defaults to false.

Returns

Returns the status of the request and the URI of the newly created deal. Returns an error if create parameters are invalid or if a required parameter is missing.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Deals' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -d 'CampaignId=1000' \
  -d 'Name=ACME Hammer Bogo' \
  -d 'Scope=PRODUCT' \
  -d 'Type=BOGO' \
  -d 'BogoBuyName=Hammer' \
  -d 'BogoBuyQuantity=200' \
  -d 'BogoBuyScope=PRODUCT' \
  -d 'BogoGetDiscountAmount=20' \
  -d 'BogoGetDiscountCurrency=USD' \
  -d 'BogoGetDiscountType=AMOUNT' \
  -d 'BogoGetName=Anvil' \
  -d 'BogoGetQuantity=150' \
  -d 'BogoGetScope=PRODUCT' \
  -d 'Description=This is a description.' \
  -d 'DefaultPromoCode=Get20Off' \
  -d 'EndDate=2021-01-31T16:27:04+00:00' \
  -d 'PurchaseLimitQuantity=0' \
  -d 'StartDate=2021-01-21T16:27:04+00:00' \
  -d 'SynchAdsPromoCodes=false'

curl 'https://api.impact.com/Advertisers/<AccountSID>/Deals' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -d 'CampaignId=1000' \
  -d 'Name=ACME Sale' \
  -d 'Scope=ENTIRE_STORE' \
  -d 'Type=GENERAL_SALE' \
  -d 'DiscountType=FIXED' \
  -d 'DiscountAmount=25' \
  -d 'DiscountCurrency=USD'

curl 'https://api.impact.com/Advertisers/<AccountSID>/Deals' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -d 'CampaignId=1000' \
  -d 'Name=ACME Hammer Rebate' \
  -d 'Scope=PRODUCT' \
  -d 'Type=REBATE' \
  -d 'RebateAmount=30' \
  -d 'RebateCurrency=USD'

Example Response

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Deals/00004"
}