Get promotion offers

curl --request GET \
  --url https://api.onsleek.ai/v1/deals/promotions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "ce0839f8-b522-41a4-9c09-5f3e510fb2d9",
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": "2024-12-31T23:59:59.999Z",
      "description": "Free shipping on all orders over $50.",
      "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
      "url": "https://www.bestbuy.com",
      "name": "BestBuy",
      "hostname": "www.bestbuy.com",
      "deepLink": "https://www.bestbuy.com/promotion",
      "updatedAt": "2024-01-01T12:00:00.000Z",
      "logo": "https://www.bestbuy.com/logo.png"
    }
  ],
  "cursor": "<string>"
}

GET

deals

promotions

Get promotion offers

curl --request GET \
  --url https://api.onsleek.ai/v1/deals/promotions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "ce0839f8-b522-41a4-9c09-5f3e510fb2d9",
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": "2024-12-31T23:59:59.999Z",
      "description": "Free shipping on all orders over $50.",
      "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
      "url": "https://www.bestbuy.com",
      "name": "BestBuy",
      "hostname": "www.bestbuy.com",
      "deepLink": "https://www.bestbuy.com/promotion",
      "updatedAt": "2024-01-01T12:00:00.000Z",
      "logo": "https://www.bestbuy.com/logo.png"
    }
  ],
  "cursor": "<string>"
}

Authorizations

Authorization

string

header

required

API key for accessing the Sleek API.

Query Parameters

cursor

string

The ID of the next item that will be fetched. Format: UUID RFC 4122

hostname

string

The hostname of the retailer to search for.

Response

200 - application/json

List of promotion offers.

data

object[]

required

Show child attributes

data.id

string

required

The unique identifier for the promotion. Format: UUID RFC 4122

Example:

"ce0839f8-b522-41a4-9c09-5f3e510fb2d9"

data.startDate

string

required

The date and time when the promotion becomes active. Format: ISO 8601

Example:

"2024-01-01T00:00:00.000Z"

data.endDate

string

required

The date and time when the promotion expires. Format: ISO 8601

Example:

"2024-12-31T23:59:59.999Z"

data.description

string

required

The description of the promotion.

Example:

"Free shipping on all orders over $50."

data.retailerId

string

required

The ID of the retailer associated with the promotion offer. Format: UUID RFC 4122

Example:

"4f9df53d-16dc-4630-8603-8d14ec40fcfe"

data.url

string

required

The URL of the retailer's website where the promotion can be used.

Example:

"https://www.bestbuy.com"

data.name

string

required

The name of the retailer associated with the promotion.

Example:

"BestBuy"

data.hostname

string

required

The hostname of the retailer's website.

Example:

"www.bestbuy.com"

data.deepLink

string

required

The deep link URL for the promotion.

Example:

"https://www.bestbuy.com/promotion"

data.updatedAt

string

required

The date and time when the promotion was last updated. Format: ISO 8601

Example:

"2024-01-01T12:00:00.000Z"

data.logo

string

The URL of the retailer's logo associated with the promotion.

Example:

"https://www.bestbuy.com/logo.png"

cursor

string

The ID of the next item in the list. Defined if there are more items to fetch. Pass this as the cursor query parameter to fetch the next page. Format: UUID RFC 4122

Activate promotion offer Get promotion by ID

⌘I

API Documentation

Endpoints

Get promotion offers

Authorizations

Query Parameters

Response