Returns a list of your deals.

Parameters

`CampaignId` optional

Id of the campaign associated with the deal.

`Scope` optional

To what extent the deal applies to the store.

View possible enum values
`PRODUCT`	Deal only applies to a specific product or a specific group of products.
`CATEGORY`	Deal applies to a category of products.
`ENTIRE_STORE`	Deal applies to the entire store.

`State` optional

State of the deal.

View possible enum values
`ACTIVE`	Deal is currently active.
`Expired`	Deal is not currently active.
`PENDING`	Deal is currently waiting for approval.

`Type` enum

What the deal does.

View possible enum values
`GENERAL_SALE`	Deal applies a general discount to the products identified in `Products`.
`FREE_SHIPPING`	Deal applies free shipping to the order.
`GIFT_WITH_PURCHASE`	A gift will come with the order.
`REBATE`	A rebate will be available to the customer upon purchase.
`BOGO`	Deal will apply a buy-one-get-one deal to the order.

Returns

Returns an array of deal objects up to a limit dictated by @pagesize. Each entry in the array is a separate deal object. If no deal objects meet the criteria, the resulting array will be empty. This request should never return an error.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Deals' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'CampaignId=10000' \
  -d 'Scope=PRODUCT' \
  -d 'State=ACTIVE' \
  -d 'Type=GENERAL_SALE' \
  -G

Example Response

{
  "@page": "1",
  ...
  "Deals": [
    {
      "Id": "00003",
      "Name": "AcmeDeal3",
      "Description": "",
      "CampaignId": "10000",
      "State": "ACTIVE",
      "Type": "GENERAL_SALE",
      "Scope": "PRODUCT",
      "Products": [
        {
          "ProductName": "Gray Anvil",
          "ProductImageUrl": "/images/Gray_Anvil.png",
          "ProductBeforePriceAmount": "50.00",
          "ProductBeforePriceCurrency": "USD",
          "ProductAfterPriceAmount": "45.00",
          "ProductAfterPriceCurrency": "USD"
        } 
      ],
      "Categories": "",
      "DiscountType": "FIXED",
      "DiscountAmount": "5.00",
      "DiscountCurrency": "USD",
      "DiscountPercent": "",
      "DiscountMaximumPercent": "",
      "DiscountPercentRangeStart": "",
      "DiscountPercentRangeEnd": "",
      "Gift": "",
      "RebateAmount": "",
      "RebateCurrency": "",
      "DefaultPromoCode": "APlusAnvils",
      "MinimumPurchaseAmount": "",
      "MinimumPurchaseAmountCurrency": "",
      "MaximumSavingsAmount": "",
      "MaximumSavingsCurrency": "",
      "BogoBuyQuantity": "0",
      "BogoBuyScope": "",
      "BogoBuyName": "",
      "BogoBuyImageUrl": "",
      "BogoGetQuantity": "0",
      "BogoGetScope": "",
      "BogoGetDiscountType": "",
      "BogoGetName": "",
      "BogoGetImageUrl": "",
      "BogoGetDiscountAmount": "",
      "BogoGetDiscountCurrency": "",
      "BogoGetDiscountPercent": "",
      "PurchaseLimitQuantity": "0",
      "StartDate": "",
      "EndDate": "",
      "SynchAdsPromoCodes": "false",
      "RestrictedMediaPartners": [],
      "RestrictedMediaPartnerGroups": [],
      "Uri": "/Advertisers/<AccountSID>/Deals/00003"
    }
    ...
  ] 
}

Parameters

CampaignId optional

Scope optional

State optional