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>",
  "brand_name": "<string>",
  "deal_type": "<string>",
  "deal_status": "<string>",
  "deal_categories": [
    "<string>"
  ],
  "coupon_code": "<string>",
  "discount_amount": 123,
  "discount_type": "<string>",
  "discount_currency": "<string>",
  "threshold_amount": 123,
  "threshold_type": "<string>",
  "purchase_limit_amount": 123,
  "purchase_limit_type": "<string>",
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_to": "2023-11-07T05:31:56Z",
  "relationship": {
    "locations": [
      {}
    ],
    "products": [
      {}
    ],
    "resources": [
      {}
    ],
    "trackings": [
      {}
    ]
  }
}

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

OK

​
network_advertiser_deal_id
integer

Unique identifier for the deal.

​
name
string

Deal name.

​
brand_name
string

Brand associated with the deal.

​
deal_type
string

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

​
deal_status
string

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

​
deal_categories
string[]

Categories assigned to the deal.

​
coupon_code
string

Coupon code associated with the deal, if applicable.

​
discount_amount
number

Discount amount (flat amount or percentage based on discount_type).

​
discount_type
string

Type of discount (flat, percentage).

​
discount_currency
string

Currency for the discount amount.

​
threshold_amount
number

Minimum purchase threshold to activate the deal.

​
threshold_type
string

Threshold type (e.g. order_value, quantity).

​
purchase_limit_amount
number

Maximum purchase amount or quantity for the deal.

​
purchase_limit_type
string

Purchase limit type.

​
valid_from
string<date-time>

Start date and time when the deal becomes valid.

​
valid_to
string<date-time>

End date and time when the deal expires.

​
relationship
object