Queues a batch of products for ingestion/upsert
curl --request POST \
--url https://api.example.com/products/ingestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"external_id": "ext-123",
"name": "Sofa X",
"description": "3-seat sofa",
"style": "Modern",
"type": "Sofa",
"sub_type": "Sleeper Sofa",
"variants": [
{
"sku": "SOFA-X-001",
"name": "Sofa X Blue",
"item_url": "https://shop.example.com/sofa-x-blue",
"depth": 90,
"height": 80,
"width": 210,
"weight": 30000,
"color": "Blue",
"price": 1499.9,
"brand": "BrandCo",
"images": [
{
"url": "https://cdn.example.com/img/sofax/blue/front.jpg",
"angle": 0
},
{
"url": "https://cdn.example.com/img/sofax/blue/side.jpg"
}
]
}
]
}
]
}
'import requests
url = "https://api.example.com/products/ingestions"
payload = { "items": [
{
"external_id": "ext-123",
"name": "Sofa X",
"description": "3-seat sofa",
"style": "Modern",
"type": "Sofa",
"sub_type": "Sleeper Sofa",
"variants": [
{
"sku": "SOFA-X-001",
"name": "Sofa X Blue",
"item_url": "https://shop.example.com/sofa-x-blue",
"depth": 90,
"height": 80,
"width": 210,
"weight": 30000,
"color": "Blue",
"price": 1499.9,
"brand": "BrandCo",
"images": [{
"url": "https://cdn.example.com/img/sofax/blue/front.jpg",
"angle": 0
}, { "url": "https://cdn.example.com/img/sofax/blue/side.jpg" }]
}
]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
external_id: 'ext-123',
name: 'Sofa X',
description: '3-seat sofa',
style: 'Modern',
type: 'Sofa',
sub_type: 'Sleeper Sofa',
variants: [
{
sku: 'SOFA-X-001',
name: 'Sofa X Blue',
item_url: 'https://shop.example.com/sofa-x-blue',
depth: 90,
height: 80,
width: 210,
weight: 30000,
color: 'Blue',
price: 1499.9,
brand: 'BrandCo',
images: [
{url: 'https://cdn.example.com/img/sofax/blue/front.jpg', angle: 0},
{url: 'https://cdn.example.com/img/sofax/blue/side.jpg'}
]
}
]
}
]
})
};
fetch('https://api.example.com/products/ingestions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/products/ingestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'external_id' => 'ext-123',
'name' => 'Sofa X',
'description' => '3-seat sofa',
'style' => 'Modern',
'type' => 'Sofa',
'sub_type' => 'Sleeper Sofa',
'variants' => [
[
'sku' => 'SOFA-X-001',
'name' => 'Sofa X Blue',
'item_url' => 'https://shop.example.com/sofa-x-blue',
'depth' => 90,
'height' => 80,
'width' => 210,
'weight' => 30000,
'color' => 'Blue',
'price' => 1499.9,
'brand' => 'BrandCo',
'images' => [
[
'url' => 'https://cdn.example.com/img/sofax/blue/front.jpg',
'angle' => 0
],
[
'url' => 'https://cdn.example.com/img/sofax/blue/side.jpg'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/products/ingestions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"external_id\": \"ext-123\",\n \"name\": \"Sofa X\",\n \"description\": \"3-seat sofa\",\n \"style\": \"Modern\",\n \"type\": \"Sofa\",\n \"sub_type\": \"Sleeper Sofa\",\n \"variants\": [\n {\n \"sku\": \"SOFA-X-001\",\n \"name\": \"Sofa X Blue\",\n \"item_url\": \"https://shop.example.com/sofa-x-blue\",\n \"depth\": 90,\n \"height\": 80,\n \"width\": 210,\n \"weight\": 30000,\n \"color\": \"Blue\",\n \"price\": 1499.9,\n \"brand\": \"BrandCo\",\n \"images\": [\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/front.jpg\",\n \"angle\": 0\n },\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/side.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/products/ingestions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"external_id\": \"ext-123\",\n \"name\": \"Sofa X\",\n \"description\": \"3-seat sofa\",\n \"style\": \"Modern\",\n \"type\": \"Sofa\",\n \"sub_type\": \"Sleeper Sofa\",\n \"variants\": [\n {\n \"sku\": \"SOFA-X-001\",\n \"name\": \"Sofa X Blue\",\n \"item_url\": \"https://shop.example.com/sofa-x-blue\",\n \"depth\": 90,\n \"height\": 80,\n \"width\": 210,\n \"weight\": 30000,\n \"color\": \"Blue\",\n \"price\": 1499.9,\n \"brand\": \"BrandCo\",\n \"images\": [\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/front.jpg\",\n \"angle\": 0\n },\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/side.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/products/ingestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"external_id\": \"ext-123\",\n \"name\": \"Sofa X\",\n \"description\": \"3-seat sofa\",\n \"style\": \"Modern\",\n \"type\": \"Sofa\",\n \"sub_type\": \"Sleeper Sofa\",\n \"variants\": [\n {\n \"sku\": \"SOFA-X-001\",\n \"name\": \"Sofa X Blue\",\n \"item_url\": \"https://shop.example.com/sofa-x-blue\",\n \"depth\": 90,\n \"height\": 80,\n \"width\": 210,\n \"weight\": 30000,\n \"color\": \"Blue\",\n \"price\": 1499.9,\n \"brand\": \"BrandCo\",\n \"images\": [\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/front.jpg\",\n \"angle\": 0\n },\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/side.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"received_count": 123
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Product Ingestion
Enqueue product batch for ingestion
POST
/
products
/
ingestions
Queues a batch of products for ingestion/upsert
curl --request POST \
--url https://api.example.com/products/ingestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"external_id": "ext-123",
"name": "Sofa X",
"description": "3-seat sofa",
"style": "Modern",
"type": "Sofa",
"sub_type": "Sleeper Sofa",
"variants": [
{
"sku": "SOFA-X-001",
"name": "Sofa X Blue",
"item_url": "https://shop.example.com/sofa-x-blue",
"depth": 90,
"height": 80,
"width": 210,
"weight": 30000,
"color": "Blue",
"price": 1499.9,
"brand": "BrandCo",
"images": [
{
"url": "https://cdn.example.com/img/sofax/blue/front.jpg",
"angle": 0
},
{
"url": "https://cdn.example.com/img/sofax/blue/side.jpg"
}
]
}
]
}
]
}
'import requests
url = "https://api.example.com/products/ingestions"
payload = { "items": [
{
"external_id": "ext-123",
"name": "Sofa X",
"description": "3-seat sofa",
"style": "Modern",
"type": "Sofa",
"sub_type": "Sleeper Sofa",
"variants": [
{
"sku": "SOFA-X-001",
"name": "Sofa X Blue",
"item_url": "https://shop.example.com/sofa-x-blue",
"depth": 90,
"height": 80,
"width": 210,
"weight": 30000,
"color": "Blue",
"price": 1499.9,
"brand": "BrandCo",
"images": [{
"url": "https://cdn.example.com/img/sofax/blue/front.jpg",
"angle": 0
}, { "url": "https://cdn.example.com/img/sofax/blue/side.jpg" }]
}
]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
external_id: 'ext-123',
name: 'Sofa X',
description: '3-seat sofa',
style: 'Modern',
type: 'Sofa',
sub_type: 'Sleeper Sofa',
variants: [
{
sku: 'SOFA-X-001',
name: 'Sofa X Blue',
item_url: 'https://shop.example.com/sofa-x-blue',
depth: 90,
height: 80,
width: 210,
weight: 30000,
color: 'Blue',
price: 1499.9,
brand: 'BrandCo',
images: [
{url: 'https://cdn.example.com/img/sofax/blue/front.jpg', angle: 0},
{url: 'https://cdn.example.com/img/sofax/blue/side.jpg'}
]
}
]
}
]
})
};
fetch('https://api.example.com/products/ingestions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/products/ingestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'external_id' => 'ext-123',
'name' => 'Sofa X',
'description' => '3-seat sofa',
'style' => 'Modern',
'type' => 'Sofa',
'sub_type' => 'Sleeper Sofa',
'variants' => [
[
'sku' => 'SOFA-X-001',
'name' => 'Sofa X Blue',
'item_url' => 'https://shop.example.com/sofa-x-blue',
'depth' => 90,
'height' => 80,
'width' => 210,
'weight' => 30000,
'color' => 'Blue',
'price' => 1499.9,
'brand' => 'BrandCo',
'images' => [
[
'url' => 'https://cdn.example.com/img/sofax/blue/front.jpg',
'angle' => 0
],
[
'url' => 'https://cdn.example.com/img/sofax/blue/side.jpg'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/products/ingestions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"external_id\": \"ext-123\",\n \"name\": \"Sofa X\",\n \"description\": \"3-seat sofa\",\n \"style\": \"Modern\",\n \"type\": \"Sofa\",\n \"sub_type\": \"Sleeper Sofa\",\n \"variants\": [\n {\n \"sku\": \"SOFA-X-001\",\n \"name\": \"Sofa X Blue\",\n \"item_url\": \"https://shop.example.com/sofa-x-blue\",\n \"depth\": 90,\n \"height\": 80,\n \"width\": 210,\n \"weight\": 30000,\n \"color\": \"Blue\",\n \"price\": 1499.9,\n \"brand\": \"BrandCo\",\n \"images\": [\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/front.jpg\",\n \"angle\": 0\n },\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/side.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/products/ingestions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"external_id\": \"ext-123\",\n \"name\": \"Sofa X\",\n \"description\": \"3-seat sofa\",\n \"style\": \"Modern\",\n \"type\": \"Sofa\",\n \"sub_type\": \"Sleeper Sofa\",\n \"variants\": [\n {\n \"sku\": \"SOFA-X-001\",\n \"name\": \"Sofa X Blue\",\n \"item_url\": \"https://shop.example.com/sofa-x-blue\",\n \"depth\": 90,\n \"height\": 80,\n \"width\": 210,\n \"weight\": 30000,\n \"color\": \"Blue\",\n \"price\": 1499.9,\n \"brand\": \"BrandCo\",\n \"images\": [\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/front.jpg\",\n \"angle\": 0\n },\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/side.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/products/ingestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"external_id\": \"ext-123\",\n \"name\": \"Sofa X\",\n \"description\": \"3-seat sofa\",\n \"style\": \"Modern\",\n \"type\": \"Sofa\",\n \"sub_type\": \"Sleeper Sofa\",\n \"variants\": [\n {\n \"sku\": \"SOFA-X-001\",\n \"name\": \"Sofa X Blue\",\n \"item_url\": \"https://shop.example.com/sofa-x-blue\",\n \"depth\": 90,\n \"height\": 80,\n \"width\": 210,\n \"weight\": 30000,\n \"color\": \"Blue\",\n \"price\": 1499.9,\n \"brand\": \"BrandCo\",\n \"images\": [\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/front.jpg\",\n \"angle\": 0\n },\n {\n \"url\": \"https://cdn.example.com/img/sofax/blue/side.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"received_count": 123
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Up to 1000 items per batch. Each item is a complete product with variants.
Maximum array length:
1000Show child attributes
Show child attributes
⌘I