Save entities
curl --request POST \
--url https://api.enterspeed.com/ingest/v2 \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
[
{
"type": "product",
"originId": "p-5427",
"properties": {
"name": "Official Enterspeed T-shirt",
"price": 199.99,
"inStock": true,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice t-shirt",
"long": "Nice t-shirt in cotton"
}
}
},
{
"type": "product",
"originId": "p-6724",
"properties": {
"name": "Official Enterspeed Hoddie",
"price": 249.95,
"inStock": true,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice hoddie",
"long": "Nice hoddie in cotton"
}
}
}
]
'import requests
url = "https://api.enterspeed.com/ingest/v2"
payload = [
{
"type": "product",
"originId": "p-5427",
"properties": {
"name": "Official Enterspeed T-shirt",
"price": 199.99,
"inStock": True,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice t-shirt",
"long": "Nice t-shirt in cotton"
}
}
},
{
"type": "product",
"originId": "p-6724",
"properties": {
"name": "Official Enterspeed Hoddie",
"price": 249.95,
"inStock": True,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice hoddie",
"long": "Nice hoddie in cotton"
}
}
}
]
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Length": "<content-length>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
'Content-Length': '<content-length>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
type: 'product',
originId: 'p-5427',
properties: {
name: 'Official Enterspeed T-shirt',
price: 199.99,
inStock: true,
features: [{name: 'color', value: 'blue'}, {name: 'size', value: 'M'}],
information: {short: 'Nice t-shirt', long: 'Nice t-shirt in cotton'}
}
},
{
type: 'product',
originId: 'p-6724',
properties: {
name: 'Official Enterspeed Hoddie',
price: 249.95,
inStock: true,
features: [{name: 'color', value: 'blue'}, {name: 'size', value: 'M'}],
information: {short: 'Nice hoddie', long: 'Nice hoddie in cotton'}
}
}
])
};
fetch('https://api.enterspeed.com/ingest/v2', 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.enterspeed.com/ingest/v2",
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([
[
'type' => 'product',
'originId' => 'p-5427',
'properties' => [
'name' => 'Official Enterspeed T-shirt',
'price' => 199.99,
'inStock' => true,
'features' => [
[
'name' => 'color',
'value' => 'blue'
],
[
'name' => 'size',
'value' => 'M'
]
],
'information' => [
'short' => 'Nice t-shirt',
'long' => 'Nice t-shirt in cotton'
]
]
],
[
'type' => 'product',
'originId' => 'p-6724',
'properties' => [
'name' => 'Official Enterspeed Hoddie',
'price' => 249.95,
'inStock' => true,
'features' => [
[
'name' => 'color',
'value' => 'blue'
],
[
'name' => 'size',
'value' => 'M'
]
],
'information' => [
'short' => 'Nice hoddie',
'long' => 'Nice hoddie in cotton'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Length: <content-length>",
"Content-Type: application/json",
"X-Api-Key: <x-api-key>"
],
]);
$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.enterspeed.com/ingest/v2"
payload := strings.NewReader("[\n {\n \"type\": \"product\",\n \"originId\": \"p-5427\",\n \"properties\": {\n \"name\": \"Official Enterspeed T-shirt\",\n \"price\": 199.99,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice t-shirt\",\n \"long\": \"Nice t-shirt in cotton\"\n }\n }\n },\n {\n \"type\": \"product\",\n \"originId\": \"p-6724\",\n \"properties\": {\n \"name\": \"Official Enterspeed Hoddie\",\n \"price\": 249.95,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice hoddie\",\n \"long\": \"Nice hoddie in cotton\"\n }\n }\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("Content-Length", "<content-length>")
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.enterspeed.com/ingest/v2")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Length", "<content-length>")
.header("Content-Type", "application/json")
.body("[\n {\n \"type\": \"product\",\n \"originId\": \"p-5427\",\n \"properties\": {\n \"name\": \"Official Enterspeed T-shirt\",\n \"price\": 199.99,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice t-shirt\",\n \"long\": \"Nice t-shirt in cotton\"\n }\n }\n },\n {\n \"type\": \"product\",\n \"originId\": \"p-6724\",\n \"properties\": {\n \"name\": \"Official Enterspeed Hoddie\",\n \"price\": 249.95,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice hoddie\",\n \"long\": \"Nice hoddie in cotton\"\n }\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterspeed.com/ingest/v2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["Content-Length"] = '<content-length>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"type\": \"product\",\n \"originId\": \"p-5427\",\n \"properties\": {\n \"name\": \"Official Enterspeed T-shirt\",\n \"price\": 199.99,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice t-shirt\",\n \"long\": \"Nice t-shirt in cotton\"\n }\n }\n },\n {\n \"type\": \"product\",\n \"originId\": \"p-6724\",\n \"properties\": {\n \"name\": \"Official Enterspeed Hoddie\",\n \"price\": 249.95,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice hoddie\",\n \"long\": \"Nice hoddie in cotton\"\n }\n }\n }\n]"
response = http.request(request)
puts response.read_body{
"status": 200,
"changedSourceEntities": [
"p-5427"
],
"unchangedSourceEntities": [
"p-6724"
],
"errors": {
"1234": [
"Validation failed"
]
},
"ingestMetadata": {
"ingestVersion": "1.0",
"ingestFormat": "Raw",
"systemInfo": null,
"forceTypeOverwrite": false
}
}{
"status": 200,
"changedSourceEntities": [
"p-5427"
],
"unchangedSourceEntities": [
"p-6724"
],
"errors": {
"1234": [
"Validation failed"
]
},
"ingestMetadata": {
"ingestVersion": "1.0",
"ingestFormat": "Raw",
"systemInfo": null,
"forceTypeOverwrite": false
}
}Save entities
Starting the process for saving entities.
Note: The bulk endpoint can take up to 50 entities in a single request.
Note: The total size of the request body must not exceed 200 MB.
POST
/
ingest
/
v2
Save entities
curl --request POST \
--url https://api.enterspeed.com/ingest/v2 \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
[
{
"type": "product",
"originId": "p-5427",
"properties": {
"name": "Official Enterspeed T-shirt",
"price": 199.99,
"inStock": true,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice t-shirt",
"long": "Nice t-shirt in cotton"
}
}
},
{
"type": "product",
"originId": "p-6724",
"properties": {
"name": "Official Enterspeed Hoddie",
"price": 249.95,
"inStock": true,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice hoddie",
"long": "Nice hoddie in cotton"
}
}
}
]
'import requests
url = "https://api.enterspeed.com/ingest/v2"
payload = [
{
"type": "product",
"originId": "p-5427",
"properties": {
"name": "Official Enterspeed T-shirt",
"price": 199.99,
"inStock": True,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice t-shirt",
"long": "Nice t-shirt in cotton"
}
}
},
{
"type": "product",
"originId": "p-6724",
"properties": {
"name": "Official Enterspeed Hoddie",
"price": 249.95,
"inStock": True,
"features": [
{
"name": "color",
"value": "blue"
},
{
"name": "size",
"value": "M"
}
],
"information": {
"short": "Nice hoddie",
"long": "Nice hoddie in cotton"
}
}
}
]
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Length": "<content-length>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
'Content-Length': '<content-length>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
type: 'product',
originId: 'p-5427',
properties: {
name: 'Official Enterspeed T-shirt',
price: 199.99,
inStock: true,
features: [{name: 'color', value: 'blue'}, {name: 'size', value: 'M'}],
information: {short: 'Nice t-shirt', long: 'Nice t-shirt in cotton'}
}
},
{
type: 'product',
originId: 'p-6724',
properties: {
name: 'Official Enterspeed Hoddie',
price: 249.95,
inStock: true,
features: [{name: 'color', value: 'blue'}, {name: 'size', value: 'M'}],
information: {short: 'Nice hoddie', long: 'Nice hoddie in cotton'}
}
}
])
};
fetch('https://api.enterspeed.com/ingest/v2', 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.enterspeed.com/ingest/v2",
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([
[
'type' => 'product',
'originId' => 'p-5427',
'properties' => [
'name' => 'Official Enterspeed T-shirt',
'price' => 199.99,
'inStock' => true,
'features' => [
[
'name' => 'color',
'value' => 'blue'
],
[
'name' => 'size',
'value' => 'M'
]
],
'information' => [
'short' => 'Nice t-shirt',
'long' => 'Nice t-shirt in cotton'
]
]
],
[
'type' => 'product',
'originId' => 'p-6724',
'properties' => [
'name' => 'Official Enterspeed Hoddie',
'price' => 249.95,
'inStock' => true,
'features' => [
[
'name' => 'color',
'value' => 'blue'
],
[
'name' => 'size',
'value' => 'M'
]
],
'information' => [
'short' => 'Nice hoddie',
'long' => 'Nice hoddie in cotton'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Length: <content-length>",
"Content-Type: application/json",
"X-Api-Key: <x-api-key>"
],
]);
$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.enterspeed.com/ingest/v2"
payload := strings.NewReader("[\n {\n \"type\": \"product\",\n \"originId\": \"p-5427\",\n \"properties\": {\n \"name\": \"Official Enterspeed T-shirt\",\n \"price\": 199.99,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice t-shirt\",\n \"long\": \"Nice t-shirt in cotton\"\n }\n }\n },\n {\n \"type\": \"product\",\n \"originId\": \"p-6724\",\n \"properties\": {\n \"name\": \"Official Enterspeed Hoddie\",\n \"price\": 249.95,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice hoddie\",\n \"long\": \"Nice hoddie in cotton\"\n }\n }\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("Content-Length", "<content-length>")
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.enterspeed.com/ingest/v2")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Length", "<content-length>")
.header("Content-Type", "application/json")
.body("[\n {\n \"type\": \"product\",\n \"originId\": \"p-5427\",\n \"properties\": {\n \"name\": \"Official Enterspeed T-shirt\",\n \"price\": 199.99,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice t-shirt\",\n \"long\": \"Nice t-shirt in cotton\"\n }\n }\n },\n {\n \"type\": \"product\",\n \"originId\": \"p-6724\",\n \"properties\": {\n \"name\": \"Official Enterspeed Hoddie\",\n \"price\": 249.95,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice hoddie\",\n \"long\": \"Nice hoddie in cotton\"\n }\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterspeed.com/ingest/v2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["Content-Length"] = '<content-length>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"type\": \"product\",\n \"originId\": \"p-5427\",\n \"properties\": {\n \"name\": \"Official Enterspeed T-shirt\",\n \"price\": 199.99,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice t-shirt\",\n \"long\": \"Nice t-shirt in cotton\"\n }\n }\n },\n {\n \"type\": \"product\",\n \"originId\": \"p-6724\",\n \"properties\": {\n \"name\": \"Official Enterspeed Hoddie\",\n \"price\": 249.95,\n \"inStock\": true,\n \"features\": [\n {\n \"name\": \"color\",\n \"value\": \"blue\"\n },\n {\n \"name\": \"size\",\n \"value\": \"M\"\n }\n ],\n \"information\": {\n \"short\": \"Nice hoddie\",\n \"long\": \"Nice hoddie in cotton\"\n }\n }\n }\n]"
response = http.request(request)
puts response.read_body{
"status": 200,
"changedSourceEntities": [
"p-5427"
],
"unchangedSourceEntities": [
"p-6724"
],
"errors": {
"1234": [
"Validation failed"
]
},
"ingestMetadata": {
"ingestVersion": "1.0",
"ingestFormat": "Raw",
"systemInfo": null,
"forceTypeOverwrite": false
}
}{
"status": 200,
"changedSourceEntities": [
"p-5427"
],
"unchangedSourceEntities": [
"p-6724"
],
"errors": {
"1234": [
"Validation failed"
]
},
"ingestMetadata": {
"ingestVersion": "1.0",
"ingestFormat": "Raw",
"systemInfo": null,
"forceTypeOverwrite": false
}
}Headers
Api key to validate your source.
Example:
"source-90880177-e9a1-47b3-9a40-7b728a6bafd8"
The length of the message body, in bytes (this header is automatically added by most clients).
Note: The endpoint does not support Transfer-Encoding: chunked. JsonContent and PostAsJsonAsync in .NET will by default set the Transfer-Encoding: chunked header. Use types like e.g. StringContent or ByteArrayContent instead.
Body
application/json
Array of entities to process
Id of the entity. Must be same format for all entities within the same source. Eg. integers, guids, etc.
The type or alias of the type of entity being send to process. Eg. blogList, blogPage, frontPage, etc. Only used for raw body
If the entity is routable send the URL. Otherwise leave as null.
Allowed as null if entity is not routable.
Note: The URL needs to begin with a leading slash.
Allowed as null if no hierarchy exists.
Example:
"123"
URLs that redirects to the current page. Eg. https://enterspeed.com/product-enterspeed-tshirt-old/ redirecting to https://enterspeed.com/product-enterspeed-tshirt/.
Property names:
- cannot start with a digit
- cannot consist only of underscores
- can contain A-Z, a-z letters, digits and underscores
Example:
[
{
"type": "product",
"originId": "p-5427",
"properties": {
"name": "Official Enterspeed T-shirt",
"price": 199.99,
"inStock": true,
"features": [
{ "name": "color", "value": "blue" },
{ "name": "size", "value": "M" }
],
"information": {
"short": "Nice t-shirt",
"long": "Nice t-shirt in cotton"
}
}
},
{
"type": "product",
"originId": "p-6724",
"properties": {
"name": "Official Enterspeed Hoddie",
"price": 249.95,
"inStock": true,
"features": [
{ "name": "color", "value": "blue" },
{ "name": "size", "value": "M" }
],
"information": {
"short": "Nice hoddie",
"long": "Nice hoddie in cotton"
}
}
}
]
Response
Valid request. Processing of posted entities has begun.
A successful response is returned if one or more entities were valid. Only if all entities are invalid a 422 response is returned.
Response for bulk ingest operations, containing lists of changed, unchanged, and errored entities.
Note: This schema applies to bulk operations only. For single entity ingest responses, see the /ingest/v2/{originId} endpoint documentation.
HTTP status code (200 for partial/full success, 422 for all entities failed)
Example:
200
List of originIds for entities that were changed
Example:
["p-5427"]
List of originIds for entities that were unchanged
Example:
["p-6724"]
Dictionary of originId to list of error messages
Show child attributes
Show child attributes
Example:
{ "1234": ["Validation failed"] }
Metadata about the ingest operation
Show child attributes
Show child attributes
Was this page helpful?