Datafeed
Auth: Partner API authentication
list
Endpoint: https://app.partnerboost.com/api.php?mod=datafeed&op=list
Required parameters
| Key | Description |
|---|---|
token | Channel API token |
Optional parameters
| Key | Description |
|---|---|
type | Return format: json (default) or xml |
brand_type | Brand types: TikTok, DTC, Walmart |
brand_id | Brand ID, a series of numbers, like 66303 |
mcid | Unique identifier for the brand, a series of characters, like ulike0 |
page | Current Page Index |
limit | Number of products shown per page - max 100 products per page |
keywords | Keywords |
price_range | One of 0-75, 75-150, 150-300, 300-500, 500-1000, 1000 |
min_discount | One of 75, 50, 25, 10 |
Return fields
| Key | Description |
|---|---|
name | Product name |
description | Product description |
brand_id | Brand ID, a series of numbers, like 66303 |
mcid | Unique identifier for the brand, a series of characters, like ulike0 |
merchant_name | The name of the merchant selling product |
url | The original product url |
image | The link to the image of the product |
sku | SKU of the product |
category | Product category |
price | Current price of the product |
currency | Currency of the product |
old_price | Old price of the product |
brand | The brand associated with the product |
availability | Product availability |
gtin | The global trade identification number of the product |
mpn | The manufacturer part number of the product |
custom1 | Custom information of the product |
custom2 | Custom information of the product |
custom3 | Custom information of the product |
creative_id | Creative ID |
tracking_url | Tracking link of the product |
tracking_url_short | Short tracking link of the product |
tracking_url_smart | Smart tracking link of the product |
updated_at | The 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"
}
]
}
get_amazon_link
Endpoint: https://app.partnerboost.com/api.php?mod=datafeed&op=get_amazon_link
Required parameters
| Key | Description |
|---|---|
token | Channel API token |
brand_id | Brand ID |
Optional parameters
| Key | Description |
|---|---|
type | Return format: json (default) or xml |
asin | ASIN. Multiple ASIN should be separated by commas. |
UID1 | Unique tag1 |
UID2 | Unique tag2 |
UID3 | Unique tag3 |
UID4 | Unique tag4 |
UID5 | Unique tag5 |
Return fields
| Key | Description |
|---|---|
name | Amazon product name |
link | Amazon product landing page link after opening with short link or smart link |
short_link | Amazon product short link |
smart_link | Amazon product smart link |
image | Amazon product logo image |
asin | ASIN |
category | Amazon product category |
price | Amazon 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
| Key | Description |
|---|---|
token | Channel API token |
brand_id | Brand ID, a series of numbers, like 66303 |
Optional parameters
| Key | Description |
|---|---|
type | Return format: json (default) or xml |
Return fields
| Key | Description |
|---|---|
id | Download 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
| Key | Description |
|---|---|
token | Channel API token |
id | Id from Request Download |
Optional parameters
| Key | Description |
|---|---|
type | Return format: json (default) or xml |
Return fields
| Key | Description |
|---|---|
url | File URL |
status | One 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"
}
}