Datafeed
Auth: Brand API authentication
datafeed/get_info
Returns datafeed status and fetch configuration.
Request:
{}
Response fields
| Key | Description | Required | Type |
|---|---|---|---|
last_updated | Producst Last Updated | — | number |
last_uploaded_time | Files Last Uploaded Time | — | number |
max_upload_num_per_month | Max Upload Num Per Month | — | number |
num_products | Num Products | — | number |
fetch_url | Fetch Url | — | string |
fetch_period | Fetch Period, one of 'NEVER', 'DAILY', 'WEEKLY', 'MONTH' | — | string |
last_fetch_time | Last Fetch Time | — | number |
last_fetch_status | Last Fetch Status | — | string |
updated_time | Info Updated Time | — | number |
parsing_files_num | Parsing Files Num | — | number |
uploaded_this_month | Uploaded This Month | — | number |
Response (abbreviated):
{
"code": 0,
"msg": "success",
"data": {
"last_updated": "1653546984",
"last_uploaded_time": "1653466305",
"max_upload_num_per_month": "10",
"num_products": "9",
"fetch_url": "http://www.yousite.com/datafeed.xml",
"fetch_period": "DAILY",
"last_fetch_time": "1653552418",
"last_fetch_status": "XML parse error",
"updated_time": "1653882623",
"parsing_files_num": 0,
"uploaded_this_month": 8
}
}
datafeed/update_setting
| Key | Description | Required | Type |
|---|---|---|---|
fetch_period | Fetch Period, one of 'NEVER', 'DAILY', 'WEEKLY', 'MONTH' | Yes | string |
fetch_url | Fetch Url | Yes | string |
Request:
{
"fetch_period": "DAILY",
"fetch_url": "https://example.com/datafeed.xml"
}
datafeed/update_product
Add or update a single product.
| Key | Description | Required | Type |
|---|---|---|---|
name | Product Name | Yes | string |
description | Product Description | No | string |
url | Product Url | Yes | string |
image | Product Image | Yes | string |
sku | Product SKU, unique | Yes | string |
category | Product Category | No | string |
price | Product Price | Yes | number |
currency | Product Currency Code, ISO 4217 | Yes | string |
old_price | Product Old Price | No | number |
brand | Product Brand | No | string |
gtin | The global trade identification number for your product | No | string |
mpn | The manufacturer part number for your product | No | string |
availability | Product Availability | No | string |
custom1 | Product Custom1 | No | string |
custom2 | Product Custom2 | No | string |
custom3 | Product Custom3 | No | string |
Request:
{
"name": "Example product",
"url": "https://example.com/product/1",
"image": "https://example.com/product/1.jpg",
"sku": "SKU-001",
"price": 99.99,
"currency": "USD",
"availability": "In Stock",
"custom1": "extra-1",
"custom2": "extra-2",
"custom3": "extra-3"
}
Response:
{ "code": 0, "data": "Added", "msg": "success" }
Bulk catalogs
For large catalogs, prefer scheduled fetch via fetch_url over per-SKU API calls.