Skip to main content
GET
/
affiliates
/
offers
/
{offerId}
/
deals
/
{dealId}
Get Deal By ID
curl --request GET \
  --url https://api.eflow.team/v1/affiliates/offers/{offerId}/deals/{dealId} \
  --header 'X-Eflow-Api-Key: <api-key>'
{
  "network_advertiser_deal_id": 123,
  "name": "<string>",
  "deal_type": "<string>",
  "deal_status": "<string>",
  "deal_categories": [
    "<string>"
  ],
  "network_id": 123,
  "description": "<string>",
  "brand_name": "<string>",
  "scope": "<string>",
  "restrictions": "<string>",
  "coupon_code": "<string>",
  "coupon_code_discount_amount": 123,
  "coupon_code_discount_percentage": 123,
  "coupon_code_discount_currency_id": "<string>",
  "threshold_amount": 123,
  "threshold_amount_currency_id": "<string>",
  "threshold_quantity": 123,
  "purchase_limit_amount": 123,
  "purchase_limit_amount_currency_id": "<string>",
  "purchase_limit_quantity": 123,
  "date_valid_from": "2023-11-07T05:31:56Z",
  "date_valid_to": "2023-11-07T05:31:56Z",
  "date_valid_timezone_id": 123,
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "time_deleted": 1734455015,
  "relationship": {
    "locations": [
      {}
    ],
    "products": [
      {}
    ],
    "resources": [
      {}
    ],
    "trackings": [
      {}
    ]
  }
}
Returns a single deal by its ID for a specific offer. Optionally includes related data such as locations, products, resources, and tracking information via query parameters. Note that the relationship object may be empty if the deal has no data for the requested relationship types.

Authorizations

​
X-Eflow-Api-Key
string
header
required

The affiliate's API key generated from the Affiliate Portal. Uses the X-Eflow-Api-Key header.

Path Parameters

​
offerId
integer
required

The numeric ID of the offer.

​
dealId
integer
required

The numeric ID of the deal.

Query Parameters

​
locations
boolean
default:false

Include location restrictions for the deal.

​
products
boolean
default:false

Include product associations for the deal.

​
resources
boolean
default:false

Include deal resources (images, links).

​
trackings
boolean
default:false

Include tracking configurations for the deal.

Response

​
network_advertiser_deal_id
integer
required

Unique identifier for the deal.

​
name
string
required

Deal name.

​
deal_type
string
required

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

​
deal_status
string
required

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

​
deal_categories
string[]
required

Categories assigned to the deal.

​
network_id
integer

Network ID the deal belongs to.

​
description
string

Deal description.

​
brand_name
string

Brand associated with the deal.

​
scope
string

Scope of the deal.

​
restrictions
string

Any restrictions that apply to the deal.

​
coupon_code
string

Coupon code associated with the deal, if applicable.

​
coupon_code_discount_amount
number

Flat discount amount for the coupon code.

​
coupon_code_discount_percentage
number

Percentage discount for the coupon code.

​
coupon_code_discount_currency_id
string

Currency ID for the coupon code discount amount.

​
threshold_amount
number

Minimum purchase amount threshold to activate the deal.

​
threshold_amount_currency_id
string

Currency ID for the threshold amount.

​
threshold_quantity
integer

Minimum quantity threshold to activate the deal.

​
purchase_limit_amount
number

Maximum purchase amount for the deal.

​
purchase_limit_amount_currency_id
string

Currency ID for the purchase limit amount.

​
purchase_limit_quantity
integer

Maximum quantity limit for the deal.

​
date_valid_from
string<date-time>

Start date and time when the deal becomes valid.

​
date_valid_to
string<date-time>

End date and time when the deal expires.

​
date_valid_timezone_id
integer

Timezone ID for the deal validity dates.

​
time_created
integer

Unix timestamp when the deal was created.

Example:

1734455015

​
time_saved
integer

Unix timestamp when the deal was last saved.

Example:

1734455015

​
time_deleted
integer

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

Example:

1734455015

​
relationship
object

Related entities for this deal. May be empty if no data exists for the requested relationship types.