Skip to main content

Datafeed

Auth: Brand API authentication

datafeed/get_info

Returns datafeed status and fetch configuration.

Request:

{}

Response fields

KeyDescriptionRequiredType
last_updatedProducst Last Updatednumber
last_uploaded_timeFiles Last Uploaded Timenumber
max_upload_num_per_monthMax Upload Num Per Monthnumber
num_productsNum Productsnumber
fetch_urlFetch Urlstring
fetch_periodFetch Period, one of 'NEVER', 'DAILY', 'WEEKLY', 'MONTH'string
last_fetch_timeLast Fetch Timenumber
last_fetch_statusLast Fetch Statusstring
updated_timeInfo Updated Timenumber
parsing_files_numParsing Files Numnumber
uploaded_this_monthUploaded This Monthnumber

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

KeyDescriptionRequiredType
fetch_periodFetch Period, one of 'NEVER', 'DAILY', 'WEEKLY', 'MONTH'Yesstring
fetch_urlFetch UrlYesstring

Request:

{
"fetch_period": "DAILY",
"fetch_url": "https://example.com/datafeed.xml"
}

datafeed/update_product

Add or update a single product.

KeyDescriptionRequiredType
nameProduct NameYesstring
descriptionProduct DescriptionNostring
urlProduct UrlYesstring
imageProduct ImageYesstring
skuProduct SKU, uniqueYesstring
categoryProduct CategoryNostring
priceProduct PriceYesnumber
currencyProduct Currency Code, ISO 4217Yesstring
old_priceProduct Old PriceNonumber
brandProduct BrandNostring
gtinThe global trade identification number for your productNostring
mpnThe manufacturer part number for your productNostring
availabilityProduct AvailabilityNostring
custom1Product Custom1Nostring
custom2Product Custom2Nostring
custom3Product Custom3Nostring

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.