Storage Locations
Retrieve a Single Storage Location by ID #
|
Sample Object
|
Retrieves a single Storage Location by its ID.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Storage Location you want to retrieve.
|
|
| $include_record_revision | Boolean | No |
Set to
true to include a record_revision for checking later updates.
|
Default: false. Use this value with PATCH /v1/assets/storage_locations.
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array |
| $on_error_return_empty_result | Boolean | No |
Set to
true to return an empty result instead of a supported validation or not-found error.
|
Default: false. Authentication, malformed or ambiguous inputs, conflicts and unexpected errors keep their error status.
|
| $include_error_list_in_response_message | Boolean | No |
Set to
true to include individual validation errors in the response message.
|
Default: false. The error list remains available in the normal error response.
|
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves one Storage Location and its saved address and contact details. Set $include_record_revision=true if you plan to update it and want to check for changes before saving.
What the response includes
Each location includes its saved name, address, address display label, contact details and creation time. Assets, inventory transactions, history, followers and notification recipients are not included.
address_display_name is derived from the address lookup. It can be empty when no label was found. Coordinates and separate postal, country, city and state fields are not exposed through the API.
Older locations may have a null, blank or short saved address. GET returns those saved values without inventing an address or hiding the location. Other missing text is returned as an empty string. Sharing an Asset does not share its owner’s Storage Location or contact details.
Getting a revision for an update
- Retrieve this location with
$include_record_revision=true. - Send the returned
record_revisionasexpected_revisionin PATCH /v1/assets/storage_locations.
What $include_record_revision covers
Set $include_record_revision=true to receive record_revision in this GET response. It covers the location name, entered address and contact details. It does not cover the derived map details, creation time, Assets or inventory transactions.
A stale revision makes PATCH return HTTP 409 with error_code=record_changed without saving changes. Retrieve the location again and review its current values before deciding whether to retry.
Handling empty results and errors
Use $on_error_return_empty_result=true only when your application can handle a missing record or supported validation error as an empty result. Current API access is still checked.
Matching copies of a parameter count once. Malformed inputs, conflicting copies, authentication errors, HTTP 409 conflicts and unexpected errors keep their normal error response. If a concurrent change prevents the read, the API returns HTTP 409 with error_code=record_changed; retrieve the data again. This read does not change any data.
Checking whether a response changed
Normal API-key and access checks still apply. This header compares the response; it does not authorize access or protect an update.
- Save the response body and its
ETagheader from an earlier GET. - Repeat the same GET, including the same filters and response options, with that ETag in the
If-None-Matchheader. - If the response is HTTP
304, keep using your saved body. If it is HTTP200, use the new body and ETag.
Open in ExhibitDay
Each record includes exhibitday_url, a link that opens its Storage Location page in ExhibitDay. Sign in to ExhibitDay with an account that can view that workspace and Storage Location.
curl -X GET "https://api.exhibitday.com/v1/assets/storage_locations/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations/info?" + new URLSearchParams({ "id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/storage_locations/info",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/storage_locations/info?id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations/info?id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations/info?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations/info?id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/storage_locations/info?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"id": 12345,
"name": "Main Warehouse",
"address": "100 Main Street, Boston, MA 02110",
"address_display_name": "Boston, MA",
"point_of_contact_name": "Warehouse Contact",
"point_of_contact_phone": "+1 617 555 0100",
"point_of_contact_email": "warehouse@example.test",
"storage_location_created_timestamp": "2030-01-02T12:00:00Z",
"exhibitday_url": "https://www.exhibitday.com/Workspace/StorageLocation/98765?sid=12345"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Storage Location not found. Invalid Storage Location ID: 12345.",
"error_code": "not_found",
"errors": [
"Storage Location not found. Invalid Storage Location ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "Storage Locations could not be read while it changed; read again.",
"error_code": "record_changed",
"errors": [
"No data was changed by this read."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Storage Locations #
|
Retrieves the Storage Locations in your workspace.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| filter_by_storage_location_id | Number | No |
Only return this Storage Location.
|
|
| $result_sort | String | No |
Order locations by name, ID or creation time. Omit for name ascending. Name ties use ID descending; creation-time ties use ID ascending. Unsupported values are refused. Use the values exactly as shown (lowercase).
|
Allowed values:
name_asc | name_desc | create_timestamp_asc | create_timestamp_desc | id_asc | id_desc |
| $limit | Number | No |
The maximum number of locations to return.
|
One positive whole number. Omit to return all matching locations after
$offset; there is no fixed page-size cap. |
| $offset | Number | No |
The number of matching locations to skip.
|
Default: 0. Send a nonnegative whole number.
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| $on_error_return_empty_result | Boolean | No |
Set to
true to return an empty collection for supported validation errors.
|
Default: false. Authentication, malformed or ambiguous inputs, conflicts and unexpected errors keep their error status.
|
| $include_error_list_in_response_message | Boolean | No |
Set to
true to include individual validation errors in the response message.
|
Default: false. The error list remains available in the normal error response.
|
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves Storage Locations and their saved address and contact details. By default, it sorts by name and returns all matching locations. Add a location filter, or use paging when you need a smaller result.
Filtering and paging
The location filter returns only the Storage Location you choose.
records_found is the number of locations in this response; total_records is the number matching the filters before paging. has_more tells you whether matching rows remain after this page. Counts and pages can change if someone edits locations between requests.
This collection does not return edit revisions or support changed-since filtering. Use a location’s Info response when you need a revision for PATCH.
What the response includes
Each location includes its saved name, address, address display label, contact details and creation time. Assets, inventory transactions, history, followers and notification recipients are not included.
address_display_name is derived from the address lookup. It can be empty when no label was found. Coordinates and separate postal, country, city and state fields are not exposed through the API.
Older locations may have a null, blank or short saved address. GET returns those saved values without inventing an address or hiding the location. Other missing text is returned as an empty string. Sharing an Asset does not share its owner’s Storage Location or contact details.
Handling empty results and errors
No matching locations normally returns an empty list. Use $on_error_return_empty_result=true only when your application can also treat a supported validation error as an empty collection. Current API access is still checked.
Matching copies of a parameter count once. Malformed inputs, conflicting copies, authentication errors, HTTP 409 conflicts and unexpected errors keep their normal error response. If a concurrent change prevents the read, the API returns HTTP 409 with error_code=record_changed; retrieve the data again. This read does not change any data.
Checking whether a response changed
Normal API-key and access checks still apply. This header compares the response; it does not authorize access or protect an update.
- Save the response body and its
ETagheader from an earlier GET. - Repeat the same GET, including the same filters and response options, with that ETag in the
If-None-Matchheader. - If the response is HTTP
304, keep using your saved body. If it is HTTP200, use the new body and ETag.
Open in ExhibitDay
Each record includes exhibitday_url, a link that opens its Storage Location page in ExhibitDay. Sign in to ExhibitDay with an account that can view that workspace and Storage Location.
curl -X GET "https://api.exhibitday.com/v1/assets/storage_locations" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations", {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/storage_locations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/storage_locations");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/storage_locations", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "storage_location",
"list_data": [
{
"id": 2345,
"name": "Main Warehouse",
"address": "100 Main Street, Boston, MA 02110",
"address_display_name": "Boston, MA",
"point_of_contact_name": "Warehouse Contact",
"point_of_contact_phone": "+1 617 555 0100",
"point_of_contact_email": "warehouse@example.test",
"storage_location_created_timestamp": "2030-01-02T12:00:00Z",
"exhibitday_url": "https://www.exhibitday.com/Workspace/StorageLocation/98765?sid=2345"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "Storage Locations could not be read while it changed; read again.",
"error_code": "record_changed",
"errors": [
"No data was changed by this read."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Add a Storage Location #
|
Adds a new Storage Location.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| name | String | Yes |
The name of the Storage Location.
|
1–120 characters, excluding surrounding spaces.
|
| address | String | Yes |
The full street address of the Storage Location.
|
10–500 characters, excluding surrounding spaces.
|
| point_of_contact_name | String | No |
The name of the contact for this location.
|
Up to 150 characters, excluding surrounding spaces.
|
| point_of_contact_phone | String | No |
The contact phone number for this location.
|
Up to 100 characters, excluding surrounding spaces.
|
| point_of_contact_email | String | No |
The contact email text for this location.
|
Up to 150 characters, excluding surrounding spaces. This field does not send an email.
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array |
| Idempotency-Key | String | No |
Send a unique key if you may retry this same create request.
|
Optional request header: 1–255 visible ASCII characters without spaces, such as a UUID. Reuse the same key only for the same request. Successful responses can be replayed for 24 hours.
|
Good to know
Adds a Storage Location with a name and full street address. You can also save contact details. The response contains the new location, including its ID.
Adding a location
- Send
nameandaddress. Add any contact fields you want to save. - Read the new location’s
idfrom the response. Use that ID when selecting the location for an Asset or another supported operation.
Address lookup and contact details
Name, address and contact lengths exclude surrounding spaces. A missing, blank or null name or address is refused. Optional contact fields that are blank or null are left empty.
The API attempts an address lookup. Your entered address is saved even if lookup is unavailable or finds no result. The derived address_display_name may therefore be empty. You cannot supply the display label, coordinates or separate postal, country, city and state values.
This method does not add Assets or inventory, move existing items, subscribe followers or send business notifications. A saved location is added to history; failure to write history does not undo the location.
Retrying the same create request
To reduce the chance of duplicates, send Idempotency-Key as a request header and reuse that key with the same request if you retry. A matching completed request returns its earlier result. A key used with a different request is refused.
If the API cannot confirm whether the save succeeded, check the current locations before trying again. The API does not automatically repeat the create. expected_revision is not supported on POST.
Sending text with commas
Use JSON, the query string or a form field for addresses or other text containing commas.
Open in ExhibitDay
The created Storage Location includes exhibitday_url, a link that opens its Storage Location page in ExhibitDay. It is the same link that GET /v1/assets/storage_locations/info returns for this Storage Location. Sign in to ExhibitDay with an account that can view that workspace and Storage Location.
curl -X POST "https://api.exhibitday.com/v1/assets/storage_locations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"name\":\"Main Warehouse\",\"address\":\"100 Main Street, Boston, MA 02110\"}"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "name": "Main Warehouse", "address": "100 Main Street, Boston, MA 02110" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/assets/storage_locations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Main Warehouse", "address": "100 Main Street, Boston, MA 02110"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PostAsync("https://api.exhibitday.com/v1/assets/storage_locations",
JsonContent.Create(new { name = "Main Warehouse", address = "100 Main Street, Boston, MA 02110" }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"Main Warehouse\",\"address\":\"100 Main Street, Boston, MA 02110\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"name":"Main Warehouse","address":"100 Main Street, Boston, MA 02110"}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"name":"Main Warehouse","address":"100 Main Street, Boston, MA 02110"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/assets/storage_locations", strings.NewReader("{\"name\":\"Main Warehouse\",\"address\":\"100 Main Street, Boston, MA 02110\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"id": 2345,
"name": "Main Warehouse",
"address": "100 Main Street, Boston, MA 02110",
"address_display_name": "Boston, MA",
"point_of_contact_name": "Warehouse Contact",
"point_of_contact_phone": "+1 617 555 0100",
"point_of_contact_email": "warehouse@example.test",
"storage_location_created_timestamp": "2030-01-02T12:00:00Z",
"exhibitday_url": "https://www.exhibitday.com/Workspace/StorageLocation/98765?sid=2345"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Storage Location or its inventory changed while the request was being saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The Storage Location or its inventory changed while the request was being saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Update a Storage Location #
|
Updates an existing Storage Location.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Storage Location you want to update.
|
|
| name | String | No |
The name of the Storage Location.
|
1–120 characters, excluding surrounding spaces.
|
| address | String | If the saved address is invalid |
The full street address of the Storage Location.
|
10–500 characters, excluding surrounding spaces.
|
| point_of_contact_name | String | No |
The name of the contact for this location.
|
Up to 150 characters, excluding surrounding spaces.
|
| point_of_contact_phone | String | No |
The contact phone number for this location.
|
Up to 100 characters, excluding surrounding spaces.
|
| point_of_contact_email | String | No |
The contact email text for this location.
|
Up to 150 characters, excluding surrounding spaces. This field does not send an email.
|
| expected_revision | String | No |
The record_revision returned when you retrieved this record. Include it to avoid overwriting someone else's changes. Omit it to skip this check.
|
|
| $ignore_params_with_empty_values | Boolean | No |
Set to
true to ignore contact fields sent as JSON null.
|
Default: false. The text
"null" still clears a contact field. Name and address cannot be blank or null, including when this option is true. |
Good to know
Updates the supplied name, address or contact details of a Storage Location. Omitted fields keep their saved values. This method does not move Assets or inventory.
Choosing what to update
Include id and send only the fields you want to change. Sending unchanged valid values makes no change to the location, revision or history.
Name and address cannot be blank or null. If an older location has a missing, short or overlong address, provide a valid address in the same request before saving any change. If you omit name, a saved name that doesn't meet today's rules is kept unchanged; a name you supply must meet the current limit.
For contact fields, omission or blank text keeps the saved value. JSON null or the text "null" clears a contact field. With $ignore_params_with_empty_values=true, real JSON null is ignored, while the text "null" still clears it.
Changing the address
The API checks the address length after trimming surrounding spaces and attempts an address lookup. If the address actually changes, it clears the old derived map details and saves any lookup results for the new address. If lookup is unavailable or returns no result, the entered address is still saved and the display label may be empty.
Sending the same address does not refresh its derived map details by itself. You cannot set the display label, coordinates or the separate postal, country, city and state values.
Avoiding conflicting updates
- Retrieve the location with GET /v1/assets/storage_locations/info and
$include_record_revision=true. - Send that exact
record_revisionasexpected_revisionin your PATCH request.
Handling revisions and conflicts
The revision covers the name, entered address and contact details. Derived map details, creation time, Assets and inventory are outside its scope.
If a covered value differs from what you read, the API returns HTTP 409 with error_code=record_changed and saves nothing. Retrieve the current location, review the changes and decide whether to retry. A value that changed and later changed back still matches.
A blank, null or malformed revision is refused with HTTP 400 and error_code=invalid_request. A successful PATCH includes the current record_revision only when you supplied expected_revision.
Retrying an update
This method ignores the Idempotency-Key header. If the save outcome cannot be confirmed, retrieve the location before deciding whether to retry. The API does not repeat the action automatically.
A confirmed change is added to history. A history-writing failure does not undo the saved change. Updating a location sends no business notifications.
Sending text with commas
Use JSON, the query string or a form field for addresses or other text containing commas.
curl -X PATCH "https://api.exhibitday.com/v1/assets/storage_locations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"name\":\"Updated location name\"}"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations", {
method: "PATCH",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "id": 12345, "name": "Updated location name" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/assets/storage_locations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"id": 12345, "name": "Updated location name"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PatchAsync("https://api.exhibitday.com/v1/assets/storage_locations",
JsonContent.Create(new { id = 12345, name = "Updated location name" }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"id\":12345,\"name\":\"Updated location name\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"id":12345,"name":"Updated location name"}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"id":12345,"name":"Updated location name"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.exhibitday.com/v1/assets/storage_locations", strings.NewReader("{\"id\":12345,\"name\":\"Updated location name\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"status_code": 200,
"status": "OK",
"message": "Storage Location updated.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Storage Location not found. Invalid Storage Location ID: 12345.",
"error_code": "not_found",
"errors": [
"Storage Location not found. Invalid Storage Location ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This Storage Location changed since you read it. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"This Storage Location changed since you read it. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Storage Location or its inventory changed while the request was being saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The Storage Location or its inventory changed while the request was being saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Delete a Storage Location #
|
Deletes an existing Storage Location.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Storage Location you want to delete.
|
|
| transfer_to_storage_location_id | Number | For an existing destination |
The ID of the Storage Location that will receive the Assets and inventory records. It must be a different location in your workspace.
|
|
| new_storage_location_name | String | For a new destination |
The name of the Storage Location you want to create.
|
1–120 characters, excluding surrounding spaces.
|
| new_storage_location_address | String | For a new destination |
The full street address of the new Storage Location.
|
10–500 characters, excluding surrounding spaces.
|
Good to know
Permanently deletes a Storage Location. You can delete it without a destination if no Asset uses it as its default Storage Location and it has no Collateral inventory transactions. Otherwise, provide a transfer destination in the same request. You can choose another Storage Location in your workspace or create a new one.
Moving inventory before deletion
Use the option that applies to your request.
- Delete an empty location. Omit all three transfer parameters.
- Transfer to an existing location. Send only
transfer_to_storage_location_idas the transfer parameter. - Transfer to a new location. Send both
new_storage_location_nameandnew_storage_location_address. The API creates the new location only if the transfer succeeds. Do not combine them with an existing destination.
What the transfer changes
Assets use the destination as their saved default Storage Location, and Collateral inventory transactions move to that location. Reservation and inventory dates and quantities stay the same. The transfer does not check in Assets or cancel reservations.
For a new destination, the address is saved even if map details cannot be found. An existing destination keeps its address and contact details.
This action sends no business notifications.
Retrying a request
If you cannot confirm whether the deletion succeeded, check the Storage Location and its inventory before retrying. The API does not repeat the deletion automatically. This method ignores the Idempotency-Key header. expected_revision is not supported.
A history-writing failure does not undo a deletion that was saved.
curl -X DELETE "https://api.exhibitday.com/v1/assets/storage_locations?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations?" + new URLSearchParams({ "id": "12345" }), {
method: "DELETE",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.delete(
"https://api.exhibitday.com/v1/assets/storage_locations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.DeleteAsync("https://api.exhibitday.com/v1/assets/storage_locations?id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations?id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations?id=12345')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("DELETE", "https://api.exhibitday.com/v1/assets/storage_locations?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"status_code": 200,
"status": "OK",
"message": "Storage Location deleted.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Storage Location not found. Invalid Storage Location ID: 12345.",
"error_code": "not_found",
"errors": [
"Storage Location not found. Invalid Storage Location ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Storage Location or its inventory changed while the request was being saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The Storage Location or its inventory changed while the request was being saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Capital Assets at a Storage Location #
|
Retrieves the Capital Assets whose default Storage Location is a given location.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| storage_location_id | Number | Yes |
The ID of the Storage Location you want to read.
|
The Storage Location must belong to your workspace.
|
| filter_by_asset_id | Number | No |
The ID of the Asset you want to retrieve. The result is still a list. For a single Asset object, use
GET /v1/assets/info with id.
|
|
| filter_by_asset_status_id | Number | No |
Only include Capital Assets with the selected status. Omit to include both Active and Archived Assets.
|
Allowed values:
1 (Active) | 2 (Archived) |
| filter_by_asset_name_contains_text | String | No |
Text to find anywhere in the Asset name.
%, _ and square brackets are treated as literal characters.
|
Maximum: 300 characters.
|
| filter_by_asset_tag | String | No |
The Asset tag to match. Matching follows the same case and accent rules as Asset search in ExhibitDay.
|
Maximum: 150 characters.
|
| filter_by_integration_metadata_field_1 | String | No |
The value to match in integration metadata field 1.
|
Maximum: 3,000 characters.
|
| filter_by_integration_metadata_field_2 | String | No |
The value to match in integration metadata field 2.
|
Maximum: 3,000 characters.
|
| filter_by_integration_metadata_field_3 | String | No |
The value to match in integration metadata field 3.
|
Maximum: 3,000 characters.
|
| filter_by_integration_metadata_field_4 | String | No |
The value to match in integration metadata field 4.
|
Maximum: 3,000 characters.
|
| filter_by_integration_metadata_field_5 | String | No |
The value to match in integration metadata field 5.
|
Maximum: 3,000 characters.
|
| filter_by_custom_field_value_setting_id | Number | With a custom field value |
The ID of a visible Asset text or dropdown custom field in your workspace.
|
|
| filter_by_custom_field_value_setting_value | String | With a custom field ID |
The value to match in the selected field. An empty string matches Assets whose saved value is empty or missing.
|
|
| filter_by_reservation_date_greater_than_or_equal_to | Date | No |
The earliest checkout date for Capital Assets or the earliest Reservation Date for Collateral.
|
YYYY-MM-DD.
|
| filter_by_reservation_date_smaller_than_or_equal_to | Date | No |
The latest checkout date for Capital Assets or the latest Reservation Date for Collateral.
|
YYYY-MM-DD.
|
| filter_by_reservation_return_date_greater_than_or_equal_to | Date | No |
The earliest reservation return date. Capital Assets only.
|
YYYY-MM-DD.
|
| filter_by_reservation_return_date_smaller_than_or_equal_to | Date | No |
The latest reservation return date. Capital Assets only.
|
YYYY-MM-DD.
|
| filter_by_reservation_overlaps_start_date | Date | When filtering by overlap |
The first day of the period you want to check. Send both overlap dates. Capital Assets only.
|
YYYY-MM-DD.
|
| filter_by_reservation_overlaps_end_date | Date | When filtering by overlap |
The last day of the period you want to check. Send both overlap dates. Capital Assets only.
|
YYYY-MM-DD.
|
| $result_sort | String | No |
Order Assets by name, creation time or ID. Omit for name ascending. Name and creation-time ties use the lower Asset ID first. Unsupported values are refused.
|
Allowed values:
name_asc | name_desc | create_timestamp_asc | create_timestamp_desc | id_asc | id_desc |
| $limit | Number | No |
Maximum number of Assets to return. Omit to return all remaining matches.
|
Whole number of 1 or more; no fixed cap.
|
| $offset | Number | No |
Number of matching Assets to skip.
|
Whole number of 0 or more. Default: 0.
|
| hydrate_reservations | Boolean | No |
Set to
true to include all reservations you can access for each full Asset result.
|
Default: false. Applies to full results only.
|
| $return_asset_lites | Boolean | No |
Set to
true for a shorter result with Asset identification, current status, quantities and storage summaries.
|
Default: false.
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves Capital Assets whose saved default Storage Location is the location you select. A Capital Asset is one item, such as a display stand. Active and Archived Assets are included by default. The saved location is not a guarantee that an item is currently in storage.
Default location and availability
Both the selected location and the Assets must belong to your workspace. Shared-Asset access does not grant access to the owner’s location or full Asset details.
A listed Asset may be checked out for an Event or another purpose. Use Asset Availability to check whether you can reserve it for particular dates.
This method already selects Capital Assets at the required location. It does not accept another Asset-type or default-location filter.
Filtering and optional details
Filters work together before counting and paging. All date and overlap conditions must match the same Capital reservation. An unknown Return Date does not match return-date or overlap predicates.
Full Asset details are returned by default. Set $return_asset_lites=true for a smaller identification and inventory summary. Lite results do not include long text, custom fields, Optional Accessories, files or reservations.
For full results, hydrate_reservations=true loads all readable reservations on each selected Asset, not just the reservations that matched your filters.
Paging the result
records_found is the number of rows in this response; total_records is the filtered count before paging. has_more indicates whether more matching rows remain. Results can change while the data is edited.
Omit $limit for all matches after $offset, or use the two options to read smaller pages. There is no fixed page-size cap. This list does not return edit revisions or support changed-since filtering.
Handling missing records and errors
An invalid Storage Location ID returns HTTP 404 with error_code=not_found, even if no rows would match your filters.
This method has no empty-result-on-error option. Invalid inputs keep their error status. If concurrent changes prevent the read, HTTP 409 with error_code=record_changed means you should retrieve the data again. The read changes no data.
Sending filter values
Use the query string, form data or JSON for a text filter that contains a comma.
Checking whether a response changed
Normal API-key and access checks still apply. This header compares the response; it does not authorize access or protect an update.
- Save the response body and its
ETagheader from an earlier GET. - Repeat the same GET, including the same filters and response options, with that ETag in the
If-None-Matchheader. - If the response is HTTP
304, keep using your saved body. If it is HTTP200, use the new body and ETag.
curl -X GET "https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?storage_location_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?" + new URLSearchParams({ "storage_location_id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/storage_locations/capital_assets",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"storage_location_id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?storage_location_id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?storage_location_id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?storage_location_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?storage_location_id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/storage_locations/capital_assets?storage_location_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "asset",
"list_data": [
{
"workspace_id": 98765,
"id": 12345,
"asset_reservation_policy_id": 1,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=12345",
"internal_identifier": "",
"asset_type_id": 1,
"make_or_model": "",
"asset_status_id": 1,
"asset_status": "Active",
"description": "",
"name": "Display stand",
"default_storage_location_id": 12345,
"current_status": "Available / In Storage",
"storage_location_name": "Main Warehouse",
"returns_to_storage": "",
"storage_location_address_display_name": "Boston, MA",
"storage_area": "",
"pull_notes": "",
"status_message": null,
"in_progress_reservation_count": 0,
"quantity_available_in_storage": 1,
"status_message_expires": null,
"projected_future_balance": 1,
"cost": {
"amount": 0.00
},
"current_storage_footprint": 0.00,
"dimensions_length": null,
"projected_future_footprint": 0.00,
"dimensions_width": null,
"dimensions_unit": "in",
"dimensions_height": null,
"volume_unit": "cu ft",
"dimensions_notes": "",
"has_complete_dimensions": false,
"dimensions_packaged_length": null,
"dimensions_packaged_width": null,
"dimensions_packaged_height": null,
"dimensions_packaged_notes": "",
"weight": null,
"weight_notes": "",
"weight_packaged": null,
"weight_packaged_notes": "",
"integration_metadata_field_1": null,
"integration_metadata_field_2": null,
"integration_metadata_field_3": null,
"integration_metadata_field_4": null,
"integration_metadata_field_5": null,
"asset_created_timestamp": "2030-01-02T17:00:00Z",
"weight_unit": "lb",
"tags": [],
"optional_accessories": [],
"custom_fields": [],
"images": [],
"reservations": null
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Storage Location not found. Use a Storage Location ID from GET /v1/assets/storage_locations.",
"error_code": "not_found",
"errors": [
"Storage Location not found. Use a Storage Location ID from GET /v1/assets/storage_locations."
],
"error_params": [
"storage_location_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The selected contents are being changed. Read them again.",
"error_code": "record_changed",
"errors": [
"The selected contents are being changed. Read them again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Collateral Transactions at a Storage Location #
|
Retrieves the Collateral inventory transactions at a Storage Location.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| storage_location_id | Number | Yes |
The ID of the Storage Location you want to read.
|
The Storage Location must belong to your workspace.
|
| filter_by_asset_id | Number | No |
Only return transactions for this Collateral item.
|
|
| filter_by_asset_status_id | Number | No |
Only return transactions for Assets with the selected status. Omit to include both Active and Archived Assets.
|
Allowed values:
1 (Active) | 2 (Archived) |
| filter_by_asset_name_contains_text | String | No |
Only return transactions for Assets whose names contain this text.
|
Up to 300 characters. Search characters are matched as text, not as wildcards.
|
| filter_by_event_reservations_only | Boolean | No |
Choose Event reservations or manual inventory changes.
|
true returns Event reservations only; false returns manual changes only. Omit to include both. |
| filter_by_effective_date_greater_than_or_equal_to | Date | No |
Only return transactions effective on or after this date.
|
Use
YYYY-MM-DD. |
| filter_by_effective_date_smaller_than_or_equal_to | Date | No |
Only return transactions effective on or before this date.
|
Use
YYYY-MM-DD. It must not be before the lower date when both are supplied. |
| $result_sort | String | No |
Order transactions by effective date or ID. Omit for effective date descending. Date ties use ID in the same direction. Unsupported values are refused. Use the values exactly as shown (lowercase).
|
Allowed values:
effective_date_asc | effective_date_desc | id_asc | id_desc |
| $limit | Number | No |
The maximum number of matching transactions to return.
|
One positive whole number. Omit for all matches after
$offset. |
| $offset | Number | No |
The number of matching transactions to skip.
|
Default: 0. Send a nonnegative whole number.
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves the Collateral inventory transactions recorded at one Storage Location, including manual increases and decreases and Event reservations. Collateral is tracked in quantities, such as brochures. Older and future transactions are included, ordered newest first by default.
Understanding the quantities
quantity_adjustment is signed: increases are positive and decreases are negative. quantity gives the size of the change without its sign. Older zero or unsupported quantities remain readable; is_quantity_editable describes quantity support, not permission to edit.
inventory_balance_on_date is this Asset’s balance at the location after all changes on that calendar date, including scheduled returns. It uses the Asset’s complete history at this location, even when your filters show only some transactions.
A saved return_date reverses the quantity change from that date onward. It is not confirmation of a physical return and does not create another transaction row.
Identifying the source record
is_event_reservation distinguishes Event reservations from manual changes. reservation_id is set for an Event reservation; inventory_adjustment_id is set for a manual adjustment. Use the corresponding method for that record, even if another family has the same numeric ID.
Only transactions for your workspace’s Collateral items are returned. When a shared Asset is reserved for another workspace’s Event, the transaction shows that Event’s name and the reservation notes, as in the Assets area. Because the Event belongs to another workspace, event_id is null and Event methods can’t open it with this key. The inventory effect remains visible. This does not grant additional Event, file or editing access.
Paging the result
records_found is the number of rows in this response; total_records is the filtered count before paging. has_more indicates whether more matching rows remain. Results can change while the data is edited.
Omit $limit for all matches after $offset, or use the two options to read smaller pages. There is no fixed page-size cap. This list does not return edit revisions or support changed-since filtering.
Handling missing records and errors
An invalid Storage Location ID returns HTTP 404 with error_code=not_found, even if no rows would match your filters.
This method has no empty-result-on-error option. Invalid inputs keep their error status. If concurrent changes prevent the read, HTTP 409 with error_code=record_changed means you should retrieve the data again. The read changes no data.
Sending filter values
Use the query string, form data or JSON for a text filter that contains a comma.
Checking whether a response changed
Normal API-key and access checks still apply. This header compares the response; it does not authorize access or protect an update.
- Save the response body and its
ETagheader from an earlier GET. - Repeat the same GET, including the same filters and response options, with that ETag in the
If-None-Matchheader. - If the response is HTTP
304, keep using your saved body. If it is HTTP200, use the new body and ETag.
curl -X GET "https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?storage_location_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?" + new URLSearchParams({ "storage_location_id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"storage_location_id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?storage_location_id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?storage_location_id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?storage_location_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?storage_location_id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/storage_locations/collateral_transactions?storage_location_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "storage_collateral_transaction",
"list_data": [
{
"exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=4567&reservation_id=3456",
"id": 3456,
"asset_id": 4567,
"asset_name": "Printed brochures",
"asset_status_id": 1,
"storage_location_id": 12345,
"storage_location_name": "Main Storage",
"effective_date": "2030-01-02",
"return_date": null,
"quantity_adjustment": 20,
"quantity": 20,
"is_quantity_editable": true,
"inventory_balance_on_date": 120,
"is_event_reservation": false,
"reservation_id": null,
"inventory_adjustment_id": 3456,
"event_id": null,
"event_name": "",
"notes": "Additional printed brochures",
"shipping_logistics_id": 1,
"is_flagged": false,
"is_starred": false,
"is_checked": false,
"collateral_transaction_created_timestamp": "2030-01-02T12:00:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Storage Location not found. Use a Storage Location ID from GET /v1/assets/storage_locations.",
"error_code": "not_found",
"errors": [
"Storage Location not found. Use a Storage Location ID from GET /v1/assets/storage_locations."
],
"error_params": [
"storage_location_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The selected contents are being changed. Read them again.",
"error_code": "record_changed",
"errors": [
"The selected contents are being changed. Read them again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve a Storage Location's Logs #
|
Retrieves the activity history for a Storage Location.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| storage_location_id | Number | Yes |
The ID of the Storage Location whose history you want to read.
|
Use the Storage Location's record ID.
|
| filter_by_actor_user_id | String | No |
Only return entries written by this user.
|
Use the opaque
actor_user_id from a log entry. Up to 128 characters; treat it as text. Historical IDs can match former users. |
| filter_by_log_entry_contains_text | String | No |
Only return entries containing this text.
|
Up to 3,000 characters after trimming surrounding spaces. Text is matched literally; HTML is not converted and search characters are not wildcards.
|
| filter_by_create_timestamp_greater_than_or_equal_to | String | No |
Only return entries at or after this timestamp.
|
Use an ISO 8601 timestamp. A fractional lower bound starts at the next whole second. Include an offset or
Z to state the time zone. |
| filter_by_create_timestamp_smaller_than_or_equal_to | String | No |
Only return entries at or before this timestamp.
|
Includes every entry in the displayed second. It must not precede the lower bound.
|
| filter_by_event_id | Number | No |
Only return entries filed under this Event ID in your workspace’s history.
|
|
| filter_by_event_tab_id | Number | No |
Only return entries filed under this Event tab ID. GET /v1/references/event_tabs lists your workspace's tabs; the Presentations tab is accepted only where your workspace has it.
|
Allowed values:
1 (Info) | 2 (Booth) | 3 (Staff) | 4 (Travel) | 5 (Assets) | 6 (Shipments) | 7 (Sponsorships) | 8 (Tasks) | 9 (Playbook) | 10 (Attachments) | 11 (Misc. Expenses & Credits) | 12 (Budget) | 13 (ROI) | 14 (Event Settings) | 16 (Binder) | 17 (Copy Event) | 19 (Logs) | 20 (Delete Event) | 21 (Giveaways) | 22 (Special Tab, shown under your workspace's name for it) |
| filter_by_context_type | String | No |
Only return entries associated with the selected context. Omit to include all contexts. Workspace means an entry with none of the other associations; an entry can belong to more than one other context. Unsupported values are refused. Values are case-insensitive.
|
Allowed values:
workspace | event | task | asset | storage_location |
| $result_sort | String | No |
Sort entries newest first (the default) or oldest first. The full saved timestamp is used, with the entry ID breaking ties in the same direction. Responses display whole seconds. Unsupported values are refused. Use the values exactly as shown (lowercase).
|
Allowed values:
create_timestamp_desc (newest first) | create_timestamp_asc (oldest first) |
| $limit | Number | No |
The maximum number of matching entries to return.
|
One positive whole number. Omit for all matches after
$offset; there is no fixed page-size cap. |
| $offset | Number | No |
The number of matching entries to skip.
|
Default: 0. Send a nonnegative whole number.
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves the visible business history filed under one Storage Location. Filters work together to narrow its history. Results are ordered newest first by default. This is the selected record’s history, not a combined history of every child record.
Choosing the record
Use the Storage Location ID to choose the history you want to retrieve.
Only entries filed under the selected record are included. Sharing or borrowing an Asset does not grant access to its owner’s history.
Only history visible to workspace users is returned. Hidden or technical entries, impersonation activity, IP addresses, device details and security information are excluded.
Filtering by time and context
Returned timestamps use UTC and display whole seconds. Timestamp filters use that displayed precision: the upper bound includes the entire displayed second, and a fractional lower bound starts at the next whole second.
An input with an offset or Z is converted for comparison. A timestamp without an offset is interpreted as US Eastern time. Include an offset when you want an unambiguous instant.
workspace context selects entries with no Event, Task, Asset or Storage Location association. The other contexts select entries with that association, and an entry can have several associations. Every result must still be filed under this selected Storage Location, so a context filter can legitimately produce no matches.
Paging the result
records_found is the number of rows in this response; total_records is the filtered count before paging. has_more indicates whether more matching rows remain. Results can change while the data is edited.
Omit $limit for all matches after $offset, or use the two options to read smaller pages. There is no fixed page-size cap. This list does not return edit revisions or support changed-since filtering.
Handling errors
This method has no empty-result-on-error option. Invalid inputs retain their error status. If concurrent changes prevent the read, HTTP 409 with error_code=record_changed means you should read again.
Each row has the same fields as an entry from GET /v1/workspace_settings/logs. It does not change the selected record, issue an edit revision or provide a feed of changes and deletions.
Sending filter values
Use the query string, form data or JSON for a text filter that contains a comma.
Checking whether a response changed
Normal API-key and access checks still apply. This header compares the response; it does not authorize access or protect an update.
- Save the response body and its
ETagheader from an earlier GET. - Repeat the same GET, including the same filters and response options, with that ETag in the
If-None-Matchheader. - If the response is HTTP
304, keep using your saved body. If it is HTTP200, use the new body and ETag.
Reading the actor
actor_user_id is the ID of the user who made the change. actor_display_name is the name saved with the entry at that time; it does not change if the user is renamed later.
Entries recorded by the API have a null actor_user_id and show the label saved with them, such as API.
curl -X GET "https://api.exhibitday.com/v1/assets/storage_locations/logs?storage_location_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/storage_locations/logs?" + new URLSearchParams({ "storage_location_id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/storage_locations/logs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"storage_location_id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/storage_locations/logs?storage_location_id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/storage_locations/logs?storage_location_id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/storage_locations/logs?storage_location_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/storage_locations/logs?storage_location_id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/storage_locations/logs?storage_location_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "workspace_log",
"list_data": [
{
"id": 67890,
"log_entry_created_timestamp": "2026-01-02T08:04:05Z",
"actor_user_id": "11111111-2222-4333-8444-555555555555",
"actor_display_name": "Illustrative user",
"log_entry": "Illustrative user updated the selected record.",
"event_id": null,
"event_name": null,
"event_tab_id": 0,
"task_id": null,
"task_name": null,
"asset_id": null,
"asset_name": "",
"storage_location_id": 12345,
"storage_location_name": "Main Storage"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Storage Location not found. Use a Storage Location ID from GET /v1/assets/storage_locations.",
"error_code": "not_found",
"errors": [
"Storage Location not found. Use a Storage Location ID from GET /v1/assets/storage_locations."
],
"error_params": [
"storage_location_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The selected contents are being changed. Read them again.",
"error_code": "record_changed",
"errors": [
"The selected contents are being changed. Read them again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}