Core resources

Offers and Brands

17min

Brands are products for which offers are promoted by advertisers. Offers determine whether Transactions are eligible for users to redeem rewards from. Often times in the system, brands are synonymous with advertisers. Examples include Nike, Pete’s Coffee, and more. uses brands or advertisers, that are sent in transactions, to find offers and calculate rewards for each transaction. Each brand can be associated with multiple active offers.

The table below outlines the available API call and action for offers and brands.

Action

API call

Description

GET /publishers/brands

Retrieves a list of brands associated with a specific user.

GET /publishers/brands/{brand_uid}

Retrieves the brand details of the requested brand entered in the {brand_uid} path parameter.

GET /publishers/categories

Retrieve a list of offer categories for a Publisher.



GET /publishers/brands

Retrieves a list of brands associated with a specific user. This allows the publisher to track a user's purchases at any of the listed brands that use an affiliate link listed in the tracking_url.

To test the API, see Get brands for a user.

Query parameters



Name

Data type

Description

publisher_user_id REQUIRED

string

Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.

category_id

string

Unique identifier of a Category used to filter brands. Category IDs can be retrieved using the Category API.

offer_type

array of strings

Type of the offer. Possible values with their definitions:

CARD_LINKED - Offers that provide rewards for card linked transactions

AFFILIATE - Offers where the user gets a reward for making a purchase through an affiliate link

GIFT_CARD - Offers that provide rewards for when a user purchases gift cards

VOUCHER_CODE - Offers that provide rewards in the form of voucher codes

location

array of strings

Describes where the offer can be redeemed.

Possible values:

  • IN_STORE_ONLINE - Indicates that the offer is redeemable in store and online
  • IN_STORE_ONLY - Indicates that the offer is only redeemable in store
  • ONLINE_ONLY - Indicates that the offer is only redeemable online

search_text

string

String search field to filter transactions. Currently supports Advertiser name and transaction uuid.

pageable

These list API methods share a common structure and accept a pageable object as a query parameter.



Name

Data type

Description

page

integer

>=0

Requests a specific page and allows the publisher to navigate between page results. If this value is not specified, the first page is the default.

size

integer

>=1 && <=100



This value determines the size of each page. If this value is not entered, the first 30 results are displayed by default.*

sort

string

A list of field names and the order in which the result set would be sorted by. No sorting is guaranteed if this input is not passed in.

Sort options:

  • userOffRank (default): This function sorts offers based on a user’s past transactions. It prioritizes offers that align with the user’s purchasing behavior, enhancing personalization and relevance.
  • offerRank: This sorting option arranges offers based on general brand popularity, prioritizing offers from well-known and widely preferred brands. It helps surface the most popular deals to users.

*Ensure that the value for size does not exceed 100 so that results are returned as expected.



Response



HTTP status 200

Returns an array of Brands objects with a 200 response code, if successful. For more information, see Status and response codes.

Page

See Pageable response for more information on the returned paginated response.



content

Name

Data type

Description

brand_uid

string

Unique identifier for a brand. This can then be used to retrieve details about a specific brand.

category_id

string

Unique identifier of a Category used to filter brands. Category IDs can be retrieved using the Category API.

category

string

Name of the category. For example: AUTOMATIVE, ELECTRONICS

name

string

Recognizable name for a brand. For example, Nike.

website

string

URL for a public-facing website of the brand.

description

string

Description for the brand, generated by the system.

logo_img_url

string

S3 generated URL for a regular sized logo image for the brand.

large_img_url

string

S3 generated URL for a large sized logo image for the brand.

small_img_url

string

S3 generated URL for a compressed logo image for the brand.

offer_description

string

Description of the offer containing details about rewards. A single brand can be linked to multiple offers.

reward_type

string

This is the type of reward made available by the brand. Possible values with their definitions:

DISCOUNT_DOLLAR- Dollar amount that is deducted from the subtotal of a transaction

DISCOUNT_PERCENTAGE- Percentage amount that is deducted from the subtotal of a transaction

CASHBACK_DOLLAR- Dollar amount earned as cashback rewards

CASHBACK_PERCENTAGE- Percentage of a subtotal that is earned as cashback rewards

max_customer_offer

number

For offers with commission group settings, this value represents the highest commission available for the offer for a particular brand. For example, there can be multiple tiers of amounts based on the customer type and various offers for the brand, but none of those exceeds the value for max_customer_offer.

global_terms_and_conditions

string

Global terms and conditions for the brand.

offers

Name

Data type

Description

offer_uid

string

Unique identifier for an offer which can be used to retrieve details about the offer.

name

string

Name of the offer which is used to display the offer on a public-facing portal.

description

string

Description that provides more details about the offer.

formatted_description

string

Formatted description of the offer. This is based on whether a particular brand or publisher want to promote offers with specific language. For example: Unlock this exclusive chance to receive $5

banner_url

string

URL of the offer banner image.

refund_period_days

integer

Refund period in days. Rewards are not available until the refund period has passed. This is the duration during which a transaction can be canceled and refunded.

tracking_url

string

URL that tracks the offer. This is only for affiliate offers.

offer_type

string

Type of the offer. Possible values with their definitions:

CARD_LINKED - Offers that provide rewards for card linked transactions

AFFILIATE - Offers where the user gets a reward for making a purchase through an affiliate link

GIFT_CARD - Offers that provide rewards for when a user purchases gift cards

VOUCHER_CODE - Offers that provide rewards in the form of voucher codes

reward_type

string

This is the type of reward made available by the brand. Possible values with their definitions:

DISCOUNT_DOLLAR- Dollar amount that is deducted from the subtotal of a transaction

DISCOUNT_PERCENTAGE- Percentage amount that is deducted from the subtotal of a transaction

CASHBACK_DOLLAR- Dollar amount earned as cashback rewards

CASHBACK_PERCENTAGE- Percentage of a subtotal that is earned as cashback rewards

voucher_code

string

A code used to redeem voucher code offers.

customer_offer

number

The net amount of rewards linked to the offer. The amount is what remains as a result of the publisher and fees. The amount is based on offer type of either currency or percentage which should be displayed to the user.

location

string

Location of the offer for location-based offers. This helps the system check eligibility of transactions for rewards based on a user's location.

one_time_use

boolean

If true, offer can only be used once.

new_customer_only

boolean

Offers only available for new customers with minimal transaction history.

max_spend

number

Maximum amount for the transaction which is eligible for the offer.

min_spend

number

Minimum amount for the transaction that must be reached to be eligible for the offer.

denominations

array of numbers

Denominations of the offer. Only applicable for gift card offers.

start_date

string

Inclusive start date of the offer in ISO8601 format: yyyy-MM-dd

end_date

string

Inclusive end date of the offer in ISO8601 format: yyyy-MM-dd

terms_and_conditions

string

Terms and conditions of the offer.

store_addresses

array

An array that contains physical addresses of participating store locations that are associated with specific in-store offers. Users must make purchases from the listed addresses to qualify for these rewards. Information from these fields can be displayed to end-users on the Publisher's Platform so that they know which location to shop at.

Possible values with their definitions:

location_name - This field can be a mix of the store name and address fields.

street_address1 - The first line of a store's physical address.

street_address2 - The second line of a store's physical address.

city - The name of the city of the store's physical address.

state - The state of the store's physical address written in a two letter format.

zip_code - The zip code of the store's physical address (5 numbers or more).

latitude - The store location's coordinate that specifies the north and south position from the equator.

longitude - The store location's coordinate that measurement east or west of the prime meridian.

phone - The 10-digit phone number for the store.

complete_address - The street address, city, state, zip code, and country for the store's physical address. For example: 5664 Brecksville Rd, Independence, OH, 44131, US

country - The country of the store's physical address. For example: US



GET /publishers/brands/{brand_uid}

Retrieves the brand details of the requested brand entered in the {brand_uid} path parameter.

The publisher_user_id query parameter is required to generate the offer's affiliate link.

To test the API, see Gets brand detail by brand UID.

Path parameters



Name

Data type

Description

{brand_uid} REQUIRED

string

Unique identifier for a brand. This can then be used to retrieve details about a specific brand.



Query parameters

Name

Data type

Description

publisher_user_id REQUIRED

string

Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.



Response

HTTP status 200

Returns an array of brand objects if found along with any linked offers for each brand. The offers for the brands also contains the affiliated links for the user under tracking_url if successful. For more information, see Status and response codes.

body

Name

Data type

Description

brand_uid

string

Unique identifier for a brand. This can then be used to retrieve details about a specific brand.

category_id

string

Unique identifier of a Category used to filter brands. Category IDs can be retrieved using the Category API.

category

string

Name of the category. For example: AUTOMATIVE, ELECTRONICS

name

string

Recognizable name for a brand. For example, Nike.

website

string

URL for a public-facing website of the brand.

description

string

Description for the brand, generated by the system.

logo_img_url

string

S3 generated URL for a regular sized logo image for the brand.

large_img_url

string

S3 generated URL for a large sized logo image for the brand.

small_img_url

string

S3 generated URL for a compressed logo image for the brand.

offer_description

string

Description of the offer containing details about rewards. A single brand can be linked to multiple offers.

reward_type

string

This is the type of reward made available by the brand. Possible values with their definitions:

DISCOUNT_DOLLAR- Dollar amount that is deducted from the subtotal of a transaction

DISCOUNT_PERCENTAGE- Percentage amount that is deducted from the subtotal of a transaction

CASHBACK_DOLLAR- Dollar amount earned as cashback rewards

CASHBACK_PERCENTAGE- Percentage of a subtotal that is earned as cashback rewards

max_customer_offer

number

For offers with commission group settings, this value represents the highest commission available for the offer for a particular brand. For example, there can be multiple tiers of amounts based on the customer type and various offers for the brand, but none of those exceeds the value for max_customer_offer.

global_terms_and_conditions

string

Global terms and conditions for the brand.

offers

Name

Data type

Description

offer_uid

string

Unique identifier for an offer which can be used to retrieve details about the offer.

name

string

Name of the offer which is used to display the offer on a public-facing portal.

description

string

Description that provides more details about the offer.

formatted_description

string

Formatted description of the offer. This is based on whether a particular brand or publisher want to promote offers with specific language. For example: Unlock this exclusive chance to receive $5

banner_url

string

URL of the offer banner image.

refund_period_days

integer

Refund period in days. Rewards are not available until the refund period has passed. This is the duration during which a transaction can be canceled and refunded.

tracking_url

string

URL that tracks the offer. This is only for affiliate offers.

offer_types

string

Type of the offer. Possible values with their definitions:

CARD_LINKED - Offers that provide rewards for card linked transactions

AFFILIATE - Offers where the user gets a reward for making a purchase through an affiliate link

GIFT_CARD - Offers that provide rewards for when a user purchases gift cards

VOUCHER_CODE - Offers that provide rewards in the form of voucher codes

reward_type

string

This is the type of reward made available by the brand. Possible values with their definitions:

DISCOUNT_DOLLAR- Dollar amount that is deducted from the subtotal of a transaction

DISCOUNT_PERCENTAGE- Percentage amount that is deducted from the subtotal of a transaction

CASHBACK_DOLLAR- Dollar amount earned as cashback rewards

CASHBACK_PERCENTAGE- Percentage of a subtotal that is earned as cashback rewards

voucher_code

string

A code used to redeem voucher code offers.

customer_offer

number

The net amount of rewards linked to the offer. The amount is what remains as a result of the publisher and fees. The amount is based on offer type of either currency or percentage which should be displayed to the user.

location

string

Location of the offer for location-based offers. This helps the system check eligibility of transactions for rewards based on a user's location.

one_time_use

boolean

If true, offer can only be used once.

new_customer_only

boolean

Offers only available for new customers with minimal transaction history.

max_spend

number

Maximum amount for the transaction which is eligible for the offer.

min_spend

number

Minimum amount for the transaction that must be reached to be eligible for the offer.

denominations

Array of numbers

Denominations of the offer. Only applicable for gift card offers.

start_date

string

Inclusive start date of the offer in ISO8601 format: yyyy-MM-dd

end_date

string

Inclusive end date of the offer in ISO8601 format: yyyy-MM-dd

terms_and_conditions

string

Terms and conditions of the offer.

store_addresses

array

An array that contains physical addresses of participating store locations that are associated with specific in-store offers. Users must make purchases from the listed addresses to qualify for these rewards. Information from these fields can be displayed to end-users on the Publisher's Platform so that they know which location to shop at.

Possible values with their definitions:

location_name - This field can be a mix of the store name and address fields.

street_address1 - The first line of a store's physical address.

street_address2 - The second line of a store's physical address.

city - The name of the city of the store's physical address.

state - The state of the store's physical address written in a two letter format.

zip_code - The zip code of the store's physical address (5 numbers or more).

latitude - The store location's coordinate that specifies the north and south position from the equator.

longitude - The store location's coordinate that measurement east or west of the prime meridian.

phone - The 10-digit phone number for the store.

complete_address - The street address, city, state, zip code, and country for the store's physical address. For example: 5664 Brecksville Rd, Independence, OH, 44131, US

country - The country of the store's physical address. For example: US



GET /publishers/categories

Retrieve a list of offer categories for a Publisher. These can then be used to filter brands and offers for the Publisher.

To test the API, see Returns a list of offer categories.



Response



HTTP status 200

Returns an array of categories, if successful. For more information, see Status and response codes.



body

Name

Data type

Description

category_id

integer

Unique identifier of a category used to filter brands for a publisher.

category

string

Name of the category. For example: AUTOMATIVE, ELECTRONICS