Bulk Upsert Sub-Location Attribute Values
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"values": [
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeExternalId": "ZONE",
"value": {
"type": "single_select",
"selected": "Back"
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeKey": "capacity",
"value": {
"type": "number",
"value": 40
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-2",
"attributeKey": "zone",
"value": null
}
]
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert"
payload = { "values": [
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeExternalId": "ZONE",
"value": {
"type": "single_select",
"selected": "Back"
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeKey": "capacity",
"value": {
"type": "number",
"value": 40
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-2",
"attributeKey": "zone",
"value": None
}
] }
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
values: [
{
subLocationExternalId: 'STORE-001-FRIDGE-1',
attributeExternalId: 'ZONE',
value: {type: 'single_select', selected: 'Back'}
},
{
subLocationExternalId: 'STORE-001-FRIDGE-1',
attributeKey: 'capacity',
value: {type: 'number', value: 40}
},
{subLocationExternalId: 'STORE-001-FRIDGE-2', attributeKey: 'zone', value: null}
]
})
};
fetch('https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert', 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.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert",
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([
'values' => [
[
'subLocationExternalId' => 'STORE-001-FRIDGE-1',
'attributeExternalId' => 'ZONE',
'value' => [
'type' => 'single_select',
'selected' => 'Back'
]
],
[
'subLocationExternalId' => 'STORE-001-FRIDGE-1',
'attributeKey' => 'capacity',
'value' => [
'type' => 'number',
'value' => 40
]
],
[
'subLocationExternalId' => 'STORE-001-FRIDGE-2',
'attributeKey' => 'zone',
'value' => null
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <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.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert"
payload := strings.NewReader("{\n \"values\": [\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeExternalId\": \"ZONE\",\n \"value\": {\n \"type\": \"single_select\",\n \"selected\": \"Back\"\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeKey\": \"capacity\",\n \"value\": {\n \"type\": \"number\",\n \"value\": 40\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-2\",\n \"attributeKey\": \"zone\",\n \"value\": null\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
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.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"values\": [\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeExternalId\": \"ZONE\",\n \"value\": {\n \"type\": \"single_select\",\n \"selected\": \"Back\"\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeKey\": \"capacity\",\n \"value\": {\n \"type\": \"number\",\n \"value\": 40\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-2\",\n \"attributeKey\": \"zone\",\n \"value\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"values\": [\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeExternalId\": \"ZONE\",\n \"value\": {\n \"type\": \"single_select\",\n \"selected\": \"Back\"\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeKey\": \"capacity\",\n \"value\": {\n \"type\": \"number\",\n \"value\": 40\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-2\",\n \"attributeKey\": \"zone\",\n \"value\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"subLocationId": "54fd6d64-4e76-4c9e-8171-f1a4f1c95bf9",
"attributeId": "8b1d2c3e-4f50-4a61-8b72-93a4b5c6d7e8"
},
{
"subLocationId": "54fd6d64-4e76-4c9e-8171-f1a4f1c95bf9",
"attributeId": "9c2e3d4f-5061-4b72-9c83-a4b5c6d7e8f9"
}
],
"extra_meta": {
"message": "Sub-location values upserted"
}
}Enterprise Sub-Locations
Bulk Upsert Sub-Location Attribute Values
Sets or clears attribute values on sub-locations. Safe to re-run: each row replaces that sub-location’s value for that attribute.
Up to 2000 rows per call.
Sub-location: exactly one of subLocationExternalId or subLocationId. Attribute (looked up on the sub-location’s type): attributeExternalId → attributeId → attributeKey → attributeName (case-insensitive); supply at least one.
Value uses the same shape as location attribute values, and its type must match the attribute’s type. For select attributes, selected accepts option ids or option labels (case-insensitive). Send null to clear a value; a required attribute cannot be cleared.
The call is all-or-nothing; the error message names the failing row (e.g. values[2]).
Requires the Public API workspace feature, CAN_MANAGE_LOCATIONS, and Sub-Locations enabled for the workspace (contact Xenia to enable it; until then every sub-location endpoint returns 404).
POST
/
api
/
v1
/
mgt
/
enterprise
/
workspaces
/
{workspaceId}
/
sub-location-attribute-values
/
bulk-upsert
Bulk Upsert Sub-Location Attribute Values
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"values": [
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeExternalId": "ZONE",
"value": {
"type": "single_select",
"selected": "Back"
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeKey": "capacity",
"value": {
"type": "number",
"value": 40
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-2",
"attributeKey": "zone",
"value": null
}
]
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert"
payload = { "values": [
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeExternalId": "ZONE",
"value": {
"type": "single_select",
"selected": "Back"
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-1",
"attributeKey": "capacity",
"value": {
"type": "number",
"value": 40
}
},
{
"subLocationExternalId": "STORE-001-FRIDGE-2",
"attributeKey": "zone",
"value": None
}
] }
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
values: [
{
subLocationExternalId: 'STORE-001-FRIDGE-1',
attributeExternalId: 'ZONE',
value: {type: 'single_select', selected: 'Back'}
},
{
subLocationExternalId: 'STORE-001-FRIDGE-1',
attributeKey: 'capacity',
value: {type: 'number', value: 40}
},
{subLocationExternalId: 'STORE-001-FRIDGE-2', attributeKey: 'zone', value: null}
]
})
};
fetch('https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert', 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.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert",
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([
'values' => [
[
'subLocationExternalId' => 'STORE-001-FRIDGE-1',
'attributeExternalId' => 'ZONE',
'value' => [
'type' => 'single_select',
'selected' => 'Back'
]
],
[
'subLocationExternalId' => 'STORE-001-FRIDGE-1',
'attributeKey' => 'capacity',
'value' => [
'type' => 'number',
'value' => 40
]
],
[
'subLocationExternalId' => 'STORE-001-FRIDGE-2',
'attributeKey' => 'zone',
'value' => null
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <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.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert"
payload := strings.NewReader("{\n \"values\": [\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeExternalId\": \"ZONE\",\n \"value\": {\n \"type\": \"single_select\",\n \"selected\": \"Back\"\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeKey\": \"capacity\",\n \"value\": {\n \"type\": \"number\",\n \"value\": 40\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-2\",\n \"attributeKey\": \"zone\",\n \"value\": null\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
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.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"values\": [\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeExternalId\": \"ZONE\",\n \"value\": {\n \"type\": \"single_select\",\n \"selected\": \"Back\"\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeKey\": \"capacity\",\n \"value\": {\n \"type\": \"number\",\n \"value\": 40\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-2\",\n \"attributeKey\": \"zone\",\n \"value\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-attribute-values/bulk-upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"values\": [\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeExternalId\": \"ZONE\",\n \"value\": {\n \"type\": \"single_select\",\n \"selected\": \"Back\"\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-1\",\n \"attributeKey\": \"capacity\",\n \"value\": {\n \"type\": \"number\",\n \"value\": 40\n }\n },\n {\n \"subLocationExternalId\": \"STORE-001-FRIDGE-2\",\n \"attributeKey\": \"zone\",\n \"value\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"subLocationId": "54fd6d64-4e76-4c9e-8171-f1a4f1c95bf9",
"attributeId": "8b1d2c3e-4f50-4a61-8b72-93a4b5c6d7e8"
},
{
"subLocationId": "54fd6d64-4e76-4c9e-8171-f1a4f1c95bf9",
"attributeId": "9c2e3d4f-5061-4b72-9c83-a4b5c6d7e8f9"
}
],
"extra_meta": {
"message": "Sub-location values upserted"
}
}Path Parameters
UUID of the workspace. Must be the workspace your API key is bound to.
Body
application/json
Required array length:
1 - 2000 elementsShow child attributes
Show child attributes
Response
One result per input row, in request order.