Multi query items from Auto Indexing source groups
curl --request POST \
--url https://query.enterspeed.com/v1/source \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
[
{
"sourceGroupAlias": "erp",
"sourceEntityType": "price",
"name": "priceData",
"filters": {
"and": [
{
"field": "sku",
"operator": "equals",
"value": "p-1234",
"caseInsensitive": true
}
]
},
"facets": [
{
"name": "Is promotional",
"field": "isPromotional",
"size": 20
}
],
"sort": [
{
"field": "salesPrice",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"sourceGroupAlias": "erp",
"sourceEntityType": "inventory",
"name": "inventoryData",
"filters": {
"and": [
{
"field": "locationId",
"operator": "equals",
"value": "warehouse-01",
"caseInsensitive": true
}
]
},
"facets": [
{
"name": "Location",
"field": "locationId",
"size": 20
}
],
"sort": [
{
"field": "stockAmount",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
}
]
'import requests
url = "https://query.enterspeed.com/v1/source"
payload = [
{
"sourceGroupAlias": "erp",
"sourceEntityType": "price",
"name": "priceData",
"filters": { "and": [
{
"field": "sku",
"operator": "equals",
"value": "p-1234",
"caseInsensitive": True
}
] },
"facets": [
{
"name": "Is promotional",
"field": "isPromotional",
"size": 20
}
],
"sort": [
{
"field": "salesPrice",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"sourceGroupAlias": "erp",
"sourceEntityType": "inventory",
"name": "inventoryData",
"filters": { "and": [
{
"field": "locationId",
"operator": "equals",
"value": "warehouse-01",
"caseInsensitive": True
}
] },
"facets": [
{
"name": "Location",
"field": "locationId",
"size": 20
}
],
"sort": [
{
"field": "stockAmount",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
}
]
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([
{
sourceGroupAlias: 'erp',
sourceEntityType: 'price',
name: 'priceData',
filters: {
and: [{field: 'sku', operator: 'equals', value: 'p-1234', caseInsensitive: true}]
},
facets: [{name: 'Is promotional', field: 'isPromotional', size: 20}],
sort: [{field: 'salesPrice', order: 'desc'}],
pagination: {page: 0, pageSize: 20}
},
{
sourceGroupAlias: 'erp',
sourceEntityType: 'inventory',
name: 'inventoryData',
filters: {
and: [
{
field: 'locationId',
operator: 'equals',
value: 'warehouse-01',
caseInsensitive: true
}
]
},
facets: [{name: 'Location', field: 'locationId', size: 20}],
sort: [{field: 'stockAmount', order: 'desc'}],
pagination: {page: 0, pageSize: 20}
}
])
};
fetch('https://query.enterspeed.com/v1/source', 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://query.enterspeed.com/v1/source",
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([
[
'sourceGroupAlias' => 'erp',
'sourceEntityType' => 'price',
'name' => 'priceData',
'filters' => [
'and' => [
[
'field' => 'sku',
'operator' => 'equals',
'value' => 'p-1234',
'caseInsensitive' => true
]
]
],
'facets' => [
[
'name' => 'Is promotional',
'field' => 'isPromotional',
'size' => 20
]
],
'sort' => [
[
'field' => 'salesPrice',
'order' => 'desc'
]
],
'pagination' => [
'page' => 0,
'pageSize' => 20
]
],
[
'sourceGroupAlias' => 'erp',
'sourceEntityType' => 'inventory',
'name' => 'inventoryData',
'filters' => [
'and' => [
[
'field' => 'locationId',
'operator' => 'equals',
'value' => 'warehouse-01',
'caseInsensitive' => true
]
]
],
'facets' => [
[
'name' => 'Location',
'field' => 'locationId',
'size' => 20
]
],
'sort' => [
[
'field' => 'stockAmount',
'order' => 'desc'
]
],
'pagination' => [
'page' => 0,
'pageSize' => 20
]
]
]),
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://query.enterspeed.com/v1/source"
payload := strings.NewReader("[\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"price\",\n \"name\": \"priceData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"sku\",\n \"operator\": \"equals\",\n \"value\": \"p-1234\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Is promotional\",\n \"field\": \"isPromotional\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"salesPrice\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"inventory\",\n \"name\": \"inventoryData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"locationId\",\n \"operator\": \"equals\",\n \"value\": \"warehouse-01\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Location\",\n \"field\": \"locationId\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"stockAmount\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\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://query.enterspeed.com/v1/source")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Length", "<content-length>")
.header("Content-Type", "application/json")
.body("[\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"price\",\n \"name\": \"priceData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"sku\",\n \"operator\": \"equals\",\n \"value\": \"p-1234\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Is promotional\",\n \"field\": \"isPromotional\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"salesPrice\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"inventory\",\n \"name\": \"inventoryData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"locationId\",\n \"operator\": \"equals\",\n \"value\": \"warehouse-01\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Location\",\n \"field\": \"locationId\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"stockAmount\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://query.enterspeed.com/v1/source")
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 \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"price\",\n \"name\": \"priceData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"sku\",\n \"operator\": \"equals\",\n \"value\": \"p-1234\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Is promotional\",\n \"field\": \"isPromotional\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"salesPrice\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"inventory\",\n \"name\": \"inventoryData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"locationId\",\n \"operator\": \"equals\",\n \"value\": \"warehouse-01\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Location\",\n \"field\": \"locationId\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"stockAmount\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n }\n]"
response = http.request(request)
puts response.read_body{}[
{
"message": "Query is not valid",
"errors": [
"Operator not implemented: equal"
],
"status": 0
}
]{
"error": "Forbidden"
}Note: This endpoint is currently in preview
The Query API is used to query items in an index, this endpoint lets you query items ingested to Auto Indexing source groups with up to 5 queries requested in a single payload, each query defining the source groups alias and source entity type to perform the lookup in.
POST
/
v1
/
source
Multi query items from Auto Indexing source groups
curl --request POST \
--url https://query.enterspeed.com/v1/source \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
[
{
"sourceGroupAlias": "erp",
"sourceEntityType": "price",
"name": "priceData",
"filters": {
"and": [
{
"field": "sku",
"operator": "equals",
"value": "p-1234",
"caseInsensitive": true
}
]
},
"facets": [
{
"name": "Is promotional",
"field": "isPromotional",
"size": 20
}
],
"sort": [
{
"field": "salesPrice",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"sourceGroupAlias": "erp",
"sourceEntityType": "inventory",
"name": "inventoryData",
"filters": {
"and": [
{
"field": "locationId",
"operator": "equals",
"value": "warehouse-01",
"caseInsensitive": true
}
]
},
"facets": [
{
"name": "Location",
"field": "locationId",
"size": 20
}
],
"sort": [
{
"field": "stockAmount",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
}
]
'import requests
url = "https://query.enterspeed.com/v1/source"
payload = [
{
"sourceGroupAlias": "erp",
"sourceEntityType": "price",
"name": "priceData",
"filters": { "and": [
{
"field": "sku",
"operator": "equals",
"value": "p-1234",
"caseInsensitive": True
}
] },
"facets": [
{
"name": "Is promotional",
"field": "isPromotional",
"size": 20
}
],
"sort": [
{
"field": "salesPrice",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"sourceGroupAlias": "erp",
"sourceEntityType": "inventory",
"name": "inventoryData",
"filters": { "and": [
{
"field": "locationId",
"operator": "equals",
"value": "warehouse-01",
"caseInsensitive": True
}
] },
"facets": [
{
"name": "Location",
"field": "locationId",
"size": 20
}
],
"sort": [
{
"field": "stockAmount",
"order": "desc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
}
]
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([
{
sourceGroupAlias: 'erp',
sourceEntityType: 'price',
name: 'priceData',
filters: {
and: [{field: 'sku', operator: 'equals', value: 'p-1234', caseInsensitive: true}]
},
facets: [{name: 'Is promotional', field: 'isPromotional', size: 20}],
sort: [{field: 'salesPrice', order: 'desc'}],
pagination: {page: 0, pageSize: 20}
},
{
sourceGroupAlias: 'erp',
sourceEntityType: 'inventory',
name: 'inventoryData',
filters: {
and: [
{
field: 'locationId',
operator: 'equals',
value: 'warehouse-01',
caseInsensitive: true
}
]
},
facets: [{name: 'Location', field: 'locationId', size: 20}],
sort: [{field: 'stockAmount', order: 'desc'}],
pagination: {page: 0, pageSize: 20}
}
])
};
fetch('https://query.enterspeed.com/v1/source', 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://query.enterspeed.com/v1/source",
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([
[
'sourceGroupAlias' => 'erp',
'sourceEntityType' => 'price',
'name' => 'priceData',
'filters' => [
'and' => [
[
'field' => 'sku',
'operator' => 'equals',
'value' => 'p-1234',
'caseInsensitive' => true
]
]
],
'facets' => [
[
'name' => 'Is promotional',
'field' => 'isPromotional',
'size' => 20
]
],
'sort' => [
[
'field' => 'salesPrice',
'order' => 'desc'
]
],
'pagination' => [
'page' => 0,
'pageSize' => 20
]
],
[
'sourceGroupAlias' => 'erp',
'sourceEntityType' => 'inventory',
'name' => 'inventoryData',
'filters' => [
'and' => [
[
'field' => 'locationId',
'operator' => 'equals',
'value' => 'warehouse-01',
'caseInsensitive' => true
]
]
],
'facets' => [
[
'name' => 'Location',
'field' => 'locationId',
'size' => 20
]
],
'sort' => [
[
'field' => 'stockAmount',
'order' => 'desc'
]
],
'pagination' => [
'page' => 0,
'pageSize' => 20
]
]
]),
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://query.enterspeed.com/v1/source"
payload := strings.NewReader("[\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"price\",\n \"name\": \"priceData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"sku\",\n \"operator\": \"equals\",\n \"value\": \"p-1234\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Is promotional\",\n \"field\": \"isPromotional\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"salesPrice\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"inventory\",\n \"name\": \"inventoryData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"locationId\",\n \"operator\": \"equals\",\n \"value\": \"warehouse-01\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Location\",\n \"field\": \"locationId\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"stockAmount\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\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://query.enterspeed.com/v1/source")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Length", "<content-length>")
.header("Content-Type", "application/json")
.body("[\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"price\",\n \"name\": \"priceData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"sku\",\n \"operator\": \"equals\",\n \"value\": \"p-1234\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Is promotional\",\n \"field\": \"isPromotional\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"salesPrice\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"inventory\",\n \"name\": \"inventoryData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"locationId\",\n \"operator\": \"equals\",\n \"value\": \"warehouse-01\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Location\",\n \"field\": \"locationId\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"stockAmount\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://query.enterspeed.com/v1/source")
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 \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"price\",\n \"name\": \"priceData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"sku\",\n \"operator\": \"equals\",\n \"value\": \"p-1234\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Is promotional\",\n \"field\": \"isPromotional\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"salesPrice\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"sourceGroupAlias\": \"erp\",\n \"sourceEntityType\": \"inventory\",\n \"name\": \"inventoryData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"locationId\",\n \"operator\": \"equals\",\n \"value\": \"warehouse-01\",\n \"caseInsensitive\": true\n }\n ]\n },\n \"facets\": [\n {\n \"name\": \"Location\",\n \"field\": \"locationId\",\n \"size\": 20\n }\n ],\n \"sort\": [\n {\n \"field\": \"stockAmount\",\n \"order\": \"desc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n }\n]"
response = http.request(request)
puts response.read_body{}[
{
"message": "Query is not valid",
"errors": [
"Operator not implemented: equal"
],
"status": 0
}
]{
"error": "Forbidden"
}Headers
Api key to validate your environment.
Example:
"environment-1637c4d0-e878-4738-b866-152106a4f88c"
The length of the message body, in bytes (this header is automatically added by most clients).
Body
application/json
The query consists of a list of query objects, on the format just like when quering items in a single index, so refer to this section when looking into filters, sorting, pagination etc.
The only thing that differs with these query objects, is an addition of an sourceGroupAlias, sourceEntityType and a name fields, so you per query can define which index you want to perform the query against and also name the individual query. This means that this service can perform multiple queries on the same index, or perform queries on multiple indicies in one request, and also give you the ability to name queries for easier identification of the resulting result sets.
Note
The request payload can at most take 5 queries in one request.
Example:
[
{
"sourceGroupAlias": "erp",
"sourceEntityType": "price",
"name": "priceData",
"filters": {
"and": [
{
"field": "sku",
"operator": "equals",
"value": "p-1234",
"caseInsensitive": true
}
]
},
"facets": [
{
"name": "Is promotional",
"field": "isPromotional",
"size": 20
}
],
"sort": [{ "field": "salesPrice", "order": "desc" }],
"pagination": { "page": 0, "pageSize": 20 }
},
{
"sourceGroupAlias": "erp",
"sourceEntityType": "inventory",
"name": "inventoryData",
"filters": {
"and": [
{
"field": "locationId",
"operator": "equals",
"value": "warehouse-01",
"caseInsensitive": true
}
]
},
"facets": [
{
"name": "Location",
"field": "locationId",
"size": 20
}
],
"sort": [{ "field": "stockAmount", "order": "desc" }],
"pagination": { "page": 0, "pageSize": 20 }
}
]
Response
Valid request.
The response is of type object.
Was this page helpful?
⌘I