AssetsPull Sheet

Pull Sheet

Export an Asset Pull Sheet #

Method
GET
Endpoint

Exports a Pull Sheet for an Event.

Parameters
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

  1. Provide event_id. Omit file_format for a PDF, or choose file_format=docx for Word.
  2. Optionally add a title or instructions and choose the fields, checkboxes and filters you need.
  3. 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.

Code Samples
# 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'

Example response

File: asset-pull-sheet.pdf
Content type: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document
Note: The response body contains file bytes.