Skip to main content

Datafeed

Auth: Partner API authentication

list

Endpoint: https://app.partnerboost.com/api.php?mod=datafeed&op=list

Required parameters

KeyDescription
tokenChannel API token

Optional parameters

KeyDescription
typeReturn format: json (default) or xml
brand_typeBrand types: TikTok, DTC, Walmart
brand_idBrand ID, a series of numbers, like 66303
mcidUnique identifier for the brand, a series of characters, like ulike0
pageCurrent Page Index
limitNumber of products shown per page - max 100 products per page
keywordsKeywords
price_rangeOne of 0-75, 75-150, 150-300, 300-500, 500-1000, 1000
min_discountOne of 75, 50, 25, 10

Return fields

KeyDescription
nameProduct name
descriptionProduct description
brand_idBrand ID, a series of numbers, like 66303
mcidUnique identifier for the brand, a series of characters, like ulike0
merchant_nameThe name of the merchant selling product
urlThe original product url
imageThe link to the image of the product
skuSKU of the product
categoryProduct category
priceCurrent price of the product
currencyCurrency of the product
old_priceOld price of the product
brandThe brand associated with the product
availabilityProduct availability
gtinThe global trade identification number of the product
mpnThe manufacturer part number of the product
custom1Custom information of the product
custom2Custom information of the product
custom3Custom information of the product
creative_idCreative ID
tracking_urlTracking link of the product
tracking_url_shortShort tracking link of the product
tracking_url_smartSmart tracking link of the product
updated_atThe last time (as a Unix timestamp) the product was updated

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"brand_type": "DTC",
"limit": 50,
"page": 1
}

Response (abbreviated):

{
"status": { "code": 0, "msg": "Success" },
"data": [
{
"name": "Example T-Shirt",
"sku": "SKU12345",
"price": "29.99",
"currency": "USD",
"custom1": "",
"tracking_url_smart": "https://partnerboost.com/smart/example"
}
]
}

Endpoint: https://app.partnerboost.com/api.php?mod=datafeed&op=get_amazon_link

Required parameters

KeyDescription
tokenChannel API token
brand_idBrand ID

Optional parameters

KeyDescription
typeReturn format: json (default) or xml
asinASIN. Multiple ASIN should be separated by commas.
UID1Unique tag1
UID2Unique tag2
UID3Unique tag3
UID4Unique tag4
UID5Unique tag5

Return fields

KeyDescription
nameAmazon product name
linkAmazon product landing page link after opening with short link or smart link
short_linkAmazon product short link
smart_linkAmazon product smart link
imageAmazon product logo image
asinASIN
categoryAmazon product category
priceAmazon product price

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"brand_id": "66303",
"asin": "B0EXAMPLE1,B0EXAMPLE2",
"UID1": "tag1"
}

request_download

Request an asynchronous datafeed file download. Returns an id used by get_download_url.

Endpoint: https://app.partnerboost.com/api.php?mod=datafeed&op=request_download

Required parameters

KeyDescription
tokenChannel API token
brand_idBrand ID, a series of numbers, like 66303

Optional parameters

KeyDescription
typeReturn format: json (default) or xml

Return fields

KeyDescription
idDownload job id (pass to get_download_url)

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"brand_id": "66303"
}

Response:

{
"status": { "code": 0, "msg": "success" },
"data": { "id": 371 }
}

get_download_url

Poll download status and retrieve the file URL.

Endpoint: https://app.partnerboost.com/api.php?mod=datafeed&op=get_download_url

Required parameters

KeyDescription
tokenChannel API token
idId from Request Download

Optional parameters

KeyDescription
typeReturn format: json (default) or xml

Return fields

KeyDescription
urlFile URL
statusOne of OK, FAIL, PENDING

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"id": 371
}

Response:

{
"status": { "code": 0, "msg": "success" },
"data": {
"url": "https://cdn.partnerboost.com/data/xxxx.csv",
"status": "PENDING"
}
}