Product Catalog API

Overview

Share your product catalog to enable services that requires up to date product information. The product catalog is required for services like product recommendations and product analytics.

Add this source

  1. 1.
    Log into your engage account
  2. 2.
    Click "Add sources" on the home page and select the Product Category API
  3. 3.
    Follow the instructions to get started

Use this source

Once activated, you may start to send products to us. The endpoint accept single products or batches of maximum 250 products at a time. Check the API Reference for specifics and code examples in most languages.
post
https://api-dot-solutionsone-211314.ew.r.appspot.com
/v1/products/catalog
Product Catalog API
Only base products are required to be uploaded as part of the product catalog. Product variants are currently not supported.

Example call

cURL
Javascript - jQuery
Javascript - Fetch
Nodejs - Axios
PHP - cURL
Python
1
curl --location --request POST 'https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog'
2
--header 'Authorization: Bearer [ADD YOUR USER TOKEN HERE]' \
3
--header 'Content-Type: application/json'
4
--data-raw '{
5
"currency": "USD",
6
"image": "https://some-image-url.com",
7
"link": "https://a-link-to-the-product.com",
8
"product_id": 20200101,
9
"name": "My new product",
10
"price": 29.99,
11
}'
Copied!
1
var settings = {
2
"url": "https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog",
3
"method": "POST",
4
"timeout": 0,
5
"headers": {
6
"Authorization": "Bearer [ADD YOUR USER TOKEN HERE]",
7
"Content-Type": "application/json"
8
},
9
"data": JSON.stringify({"currency":"USD","image":"https://some-image-url.com","link":"https://a-link-to-the-product.com","product_id":20200101,"name":"My new product","price":29.99}),
10
};
11
12
$.ajax(settings).done(function (response) {
13
console.log(response);
14
});
Copied!
1
var myHeaders = new Headers();
2
myHeaders.append("Authorization", "Bearer [ADD YOUR USER TOKEN HERE]");
3
myHeaders.append("Content-Type", "application/json");
4
5
var raw = JSON.stringify({"currency":"USD","image":"https://some-image-url.com","link":"https://a-link-to-the-product.com","product_id":20200101,"name":"My new product","price":29.99});
6
7
var requestOptions = {
8
method: 'POST',
9
headers: myHeaders,
10
body: raw,
11
redirect: 'follow'
12
};
13
14
fetch("https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog", requestOptions)
15
.then(response => response.text())
16
.then(result => console.log(result))
17
.catch(error => console.log('error', error));
Copied!
1
var axios = require('axios');
2
var data = JSON.stringify({"currency":"USD","image":"https://some-image-url.com","link":"https://a-link-to-the-product.com","product_id":20200101,"name":"My new product","price":29.99});
3
4
var config = {
5
method: 'post',
6
url: 'https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog',
7
headers: {
8
'Authorization': 'Bearer [ADD YOUR USER TOKEN HERE]',
9
'Content-Type': 'application/json'
10
},
11
data : data
12
};
13
14
axios(config)
15
.then(function (response) {
16
console.log(JSON.stringify(response.data));
17
})
18
.catch(function (error) {
19
console.log(error);
20
});
Copied!
1
<?php
2
3
$curl = curl_init();
4
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => "https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog",
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => "",
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => true,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => "POST",
14
CURLOPT_POSTFIELDS =>"{\n \"currency\": \"USD\",\n \"image\": \"https://some-image-url.com\",\n \"link\": \"https://a-link-to-the-product.com\",\n \"product_id\": 20200101,\n \"name\": \"My new product\",\n \"price\": 29.99\n}",
15
CURLOPT_HTTPHEADER => array(
16
"Authorization: Bearer [ADD YOUR USER TOKEN HERE]",
17
"Content-Type: application/json"
18
),
19
));
20
21
$response = curl_exec($curl);
22
23
curl_close($curl);
24
echo $response;
Copied!
1
import requests
2
import json
3
4
url = "https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog"
5
6
payload = {
7
"currency": "USD",
8
"image": "https://some-image-url.com",
9
"link": "https://a-link-to-the-product.com",
10
"product_id": 20200101,
11
"name": "My new product",
12
"price": 29.99
13
}
14
headers = {
15
'Authorization': 'Bearer [ADD YOUR USER TOKEN HERE]',
16
'Content-Type': 'application/json'
17
}
18
19
response = requests.request("POST", url, headers=headers, data = json.dumps(payload))
20
21
print(response.text.encode('utf8'))
Copied!

Data formats

Dates & Time

Format
Example
YYYY-MM-DD HH:MM:SS+HH:MM
2020-01-01 04:23:01+04:00
YYYY-MM-DD HH:MM:SS.ffffff
2020-01-01 04:23:01.000384
YYYY-MM-DD HH:MM:SS
2020-01-01 04:23:01
YYYY-MM-DDTHH:MM:SS+HH:MM
2020-01-01T04:23:01+04:00
YYYY-MM-DDTHH:MM:SS.ffffff
2020-01-01T04:23:01.000384
YYYY-MM-DDTHH:MM:SS
2020-01-01T04:23:01

Generic format supported

1
YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]]
Copied!
Last modified 8mo ago