Pull Sheet
Export an Asset Pull Sheet #
|
Exports a Pull Sheet for an Event.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| event_id | Number | Yes |
The ID of the Event whose Pull Sheet you want to create.
|
The Event must belong to your workspace and have a visible Assets tab.
|
| file_format | String | No |
Choose a printable Pull Sheet or an editable Word document. Omit for a PDF. Values are case-insensitive; a supplied blank, null or unsupported value is refused.
|
Allowed values:
pdf (printable Pull Sheet) | docx (editable Word document) |
| title | String | No |
An optional heading for this Pull Sheet.
|
Up to 500 characters as sent. Surrounding spaces are ignored.
|
| instructions | String | No |
Optional special instructions printed at the top.
|
Up to 1,500 characters as sent. Surrounding spaces are ignored.
|
| include_internal_identifier | Boolean | No |
Whether to include the Asset’s internal identifier.
|
Default: true.
|
| include_make_or_model | Boolean | No |
Whether to include the type, make or model.
|
Default: true.
|
| include_weight | Boolean | No |
Whether to include item weight.
|
Default: true.
|
| include_packaged_weight | Boolean | No |
Whether to include packaged weight.
|
Default: true.
|
| include_dimensions | Boolean | No |
Whether to include item dimensions.
|
Default: true.
|
| include_packaged_dimensions | Boolean | No |
Whether to include packaged dimensions.
|
Default: true.
|
| include_storage_location | Boolean | No |
Whether to include the Storage Location.
|
Default: true.
|
| include_storage_area | Boolean | No |
Whether to include the storage area.
|
Default: true.
|
| include_pull_notes | Boolean | No |
Whether to include pull notes.
|
Default: true.
|
| include_shipping_logistics | Boolean | No |
Whether to include Shipping Logistics.
|
Default: true.
|
| include_reservation_date | Boolean | No |
Whether to include reservation and return dates.
|
Default: true.
|
| include_reservation_notes | Boolean | No |
Whether to include reservation notes.
|
Default: true.
|
| include_pulled_checkboxes | Boolean | No |
Whether to print a Pulled checkbox for each reservation and Optional Accessory.
|
Default: false.
|
| include_returned_checkboxes | Boolean | No |
Whether to print a Returned checkbox for each reservation and Optional Accessory.
|
Default: false.
|
| filter_by_asset_type_ids | String | No |
Only include selected Asset types. Send a comma-separated string or a JSON array of the IDs; omit it for both types. A supplied list must be nonempty and contain no duplicates.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| filter_by_shipping_logistics_ids | String | No |
Only include these Shipping Logistics choices.
|
Optional comma-separated ID string or JSON array. Omit for all choices; a supplied list must be nonempty and have no duplicates. Allowed values:
1 (Unspecified) | 2 (Advance Warehouse) | 3 (Direct Shipment) | 4 (Other) |
| filter_by_storage_location_ids | String | No |
Only include selected reservations associated with these Storage Location IDs.
|
Optional comma-separated positive ID string or JSON array. Omit for all locations. The list must be nonempty and have no duplicates. It filters already authorized rows and does not grant access to a location record.
|
| flags | String | No |
Only include reservations matching any selected marker. Send comma-separated choices or a JSON array of them; omit this filter to include all markers. Values are case-insensitive; a supplied list must be nonempty and contain no duplicates.
|
Allowed values:
none (no marker is set) | starred (star marker) | flagged (flag marker) | checked (check marker) |
Good to know
Creates a Pull Sheet for one Event: a list of Assets to prepare, with quantities, reservation dates, storage details, pull notes and Optional Accessories. Download a PDF to print or a Word document to edit. Choose which details and checkboxes to include.
Creating the Pull Sheet
- Provide
event_id. Omitfile_formatfor a PDF, or choosefile_format=docxfor Word. - Optionally add a title or instructions and choose the fields, checkboxes and filters you need.
- Save the returned file. Your choices apply only to this request and do not change a person’s saved preferences.
Filtering the reservations
Selections within one filter group work on an OR basis. Different groups work together on an AND basis. For example, selecting both starred and flagged includes either marker, then a Storage Location filter narrows those matches.
Send comma-separated filter lists in query-string, form or JSON string values, not headers. Omit a group to leave it unfiltered. A supplied list must be nonempty and contain no repeated items.
The layout follows ExhibitDay’s Pull Sheet, preserves original measurement units for shared Assets and includes permitted related-item summaries. If no reservations match, it produces the normal empty-state message.
Access and output options
The Event and its Assets tab must be visible. A locked tab can still be exported. Existing reservations may include shared or subsequently unshared Assets; this does not open the other workspace’s Asset list or ledger.
PDF uses the normal plan watermark. Word output is unavailable on the Lite plan. Related summaries follow current permissions; Tasks, hidden or inaccessible records, attachments and invoice files are not included.
Receiving the download and handling errors
A successful response is the downloadable file, not a JSON object. An unsuccessful request returns the normal JSON API error. The response is private and is not stored by shared caches.
Matching copies of a parameter count once. If the values differ, the API returns a 400 error that names the parameter and where it was sent. Blank or null selectors and lists are refused. Send comma-separated lists or text containing commas in query-string, form or JSON values, not headers.
This download refuses an expected revision because it cannot check one. Undeclared options, including scope, requests for a record revision, paging, JSON response format and changed-since filters, are ignored and reported in the X-API-Warnings response header. The ignore-empty option does not hide an invalid selection.
HTTP 409 with error_code=record_changed means a concurrent change prevented preparation. Retrieve the current information before deciding whether to repeat the export. No business activity entry or email is created by the export.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'asset-pull-sheet.pdf'
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const response = await fetch("https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456", { method: "GET", headers: { Authorization: 'Bearer YOUR_API_KEY' } });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
await writeFile("asset-pull-sheet.pdf", new Uint8Array(await response.arrayBuffer()));
import requests
import json
response = requests.request("GET", "https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456", headers={'Authorization': 'Bearer YOUR_API_KEY'}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
with open("asset-pull-sheet.pdf", 'wb') as destination:
destination.write(response.content)
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456");
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
await File.WriteAllBytesAsync("asset-pull-sheet.pdf", await response.Content.ReadAsByteArrayAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456")).header("Authorization", "Bearer YOUR_API_KEY");
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("GET", HttpRequest.BodyPublishers.noBody()).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
Files.write(Path.of("asset-pull-sheet.pdf"), response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456');
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));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
file_put_contents('asset-pull-sheet.pdf', $response);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456')
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') { |http| http.request(request) }
raise response.body unless response.code == '200'
File.binwrite('asset-pull-sheet.pdf', response.body)
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/pull_sheet/export?file_format=pdf&event_id=23456", 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()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
if err := os.WriteFile("asset-pull-sheet.pdf", data, 0600); err != nil { log.Fatal(err) }
fmt.Println("File saved")
}
Example response
Content type: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document
{
"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": "The expected_revision parameter in the query string cannot be checked by this download. Remove it and try again. Nothing was downloaded.",
"error_code": "invalid_request",
"errors": [
"The expected_revision parameter in the query string cannot be checked by this download. Remove it and try again. Nothing was downloaded."
],
"error_params": [
"expected_revision"
],
"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": "The selected Asset or Event is changing. Read its current information before deciding whether to retry the export.",
"error_code": "record_changed",
"errors": [
"The selected Asset or Event is changing. Read its current information before deciding whether to retry the export."
],
"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"
}