Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Affiliate Deals

Get Deal By ID

get/affiliates/offers/{offerId}/deals/{dealId}

Path parameters

offerIdinteger required

The numeric ID of the offer.

dealIdinteger required

The numeric ID of the deal.

Query parameters

locationsboolean

Include location restrictions for the deal.

productsboolean

Include product associations for the deal.

resourcesboolean

Include deal resources (images, links).

trackingsboolean

Include tracking configurations for the deal.

Response

network_advertiser_deal_idinteger required

Unique identifier for the deal.

network_idinteger

Network ID the deal belongs to.

namestring required

Deal name.

descriptionstring

Deal description.

brand_namestring

Brand associated with the deal.

deal_typestring required

Type of deal (e.g. coupon, promotion, sale).

deal_statusstring required

Current status of the deal (active, paused, expired).

deal_categoriesstring[] required

Categories assigned to the deal.

scopestring

Scope of the deal.

restrictionsstring

Any restrictions that apply to the deal.

coupon_codestring

Coupon code associated with the deal, if applicable.

coupon_code_discount_amountnumber

Flat discount amount for the coupon code.

coupon_code_discount_percentagenumber

Percentage discount for the coupon code.

coupon_code_discount_currency_idstring

Currency ID for the coupon code discount amount.

threshold_amountnumber

Minimum purchase amount threshold to activate the deal.

threshold_amount_currency_idstring

Currency ID for the threshold amount.

threshold_quantityinteger

Minimum quantity threshold to activate the deal.

purchase_limit_amountnumber

Maximum purchase amount for the deal.

purchase_limit_amount_currency_idstring

Currency ID for the purchase limit amount.

purchase_limit_quantityinteger

Maximum quantity limit for the deal.

date_valid_frominteger

Start date and time when the deal becomes valid.

date_valid_tointeger

End date and time when the deal expires.

date_valid_timezone_idinteger

Timezone ID for the deal validity dates.

time_createdinteger

Unix timestamp when the deal was created.

time_savedinteger

Unix timestamp when the deal was last saved.

time_deletedinteger

Unix timestamp when the deal was deleted. 0 if not deleted.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "time_deleted": 1734455015
}