AssetsLogistical Records

Logistical Records

Retrieve a Single Reservation Logistical Record by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Logistical Record for an Asset reservation.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Logistical Record you want to retrieve. It must belong to this reservation.
$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 receive an empty result for supported validation or not-found errors. Authentication errors, rate limits, read conflicts and unexpected server errors still return an error response.
Default: false.
$include_error_list_in_response_message Boolean No
Set to true to include individual validation errors in the error message.
Default: false.

Good to know

Retrieves a Logistical Record for an Asset reservation. A Logistical Record tracks an action such as preparing, shipping or receiving an Asset. Its Record Date is the date of that action. Your workspace must have the Logistical Records feature enabled.

Access to borrowed Assets

Supply the Logistical Record's id for your Assets or borrowed Assets. The API finds the reservation’s current Asset and Event and checks access automatically; no extra Asset or Event ID is needed. If the owner stops sharing the Asset, access can continue while the reservation belongs to an Event in your workspace and that Event’s Assets tab is accessible.

Borrowed-Asset access does not provide the owner’s private Asset details or other Event reservations. Logistical Records for an Event in another workspace are unavailable.

Getting the revision for an update

This Logistical Record response does not include a revision. Retrieve the parent reservation’s revision before making a conditional update.

  1. Retrieve the parent reservation with GET /v1/assets/reservations/info, using its asset_type_id and setting id to this response's reservation_id, and set $include_record_revision=true.
  2. Copy record_revision from GET /v1/assets/reservations/info and send it unchanged as expected_revision in PATCH /v1/assets/reservation_logistical_records or DELETE /v1/assets/reservation_logistical_records.

What the reservation revision covers

This Logistical Record response does not include a revision. The parent reservation’s revision covers the reservation fields, Optional Accessory quantities, Logistical Records, note formatting saved in ExhibitDay and related-item links; attachment metadata and file contents are excluded.

Logistical Records on another workspace’s Event can’t be read or changed, even by the Asset’s owner, so this revision is only useful for reservations on Events in your workspace.

If the reservation changes during your read

Reads take no locks. If a save to the same reservation collides with your read (rare), the API can return HTTP 409 with error_code=record_changed. Read the record again. The empty-result option does not replace this conflict response.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/assets/reservation_logistical_records/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": 12345,
  "asset_type_id": 0,
  "reservation_id": 0,
  "asset_id": 0,
  "record_type_id": 0,
  "record_type": null,
  "record_date": null,
  "description": "Sample description",
  "logistical_record_created_by": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "logistical_record_created_timestamp": "2026-11-19T17:00:00Z"
}
Note: IDs are illustrative; use IDs from your workspace.

Retrieve Reservation Logistical Records #

Method
GET
Endpoint

Retrieves the Logistical Records for an Asset reservation.

Parameters
Name Type Required? Description Details
asset_type_id Number Yes
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
Allowed values: 1 (Capital) | 2 (Collateral)
reservation_id Number Yes
The ID of the reservation for the selected Asset type.
The current Asset and Event are determined automatically. No additional Asset or Event ID is needed.
filter_by_logistical_record_id Number No
Only return the record with this ID on the selected reservation.
filter_by_record_type_id Number No
Only return records with this Record Type ID.
Standard choices: 1 (Prepped), 2 (Sent), 3 (Received), 4 (Other).
filter_by_record_date_greater_than_or_equal_to Date No
Only return records dated on or after this date.
Use YYYY-MM-DD. The whole calendar date is compared, including older entries saved with a time of day.
filter_by_record_date_smaller_than_or_equal_to Date No
Only return records dated on or before this date.
Use YYYY-MM-DD. It must not precede the lower date when both are supplied.
$result_sort String No
Order records by record date, creation time or ID. Omit for record date ascending. Date and time ties use ID ascending. Unsupported values are refused.
Allowed values: record_date_asc | record_date_desc | create_timestamp_asc | create_timestamp_desc | id_asc | id_desc
$limit Number No
The maximum number of matching records to return.
One positive whole number. Omit to return all matches after $offset; there is no fixed page-size cap.
$offset Number No
The number of matching records 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 or not-found errors.
Default: false. Malformed inputs, authentication errors, rate limits, read conflicts and unexpected errors keep their error response.
$include_error_list_in_response_message Boolean No
Set to true to include individual validation errors in the response message.
Default: false. The normal error list remains available.
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 milestones such as preparation, shipment and receipt for one Asset reservation. Supply the reservation’s type and ID, then optionally filter or page its records. By default, records are ordered by Record Date.

Using the reservation’s current context

Your workspace needs the Logistical Records feature and access to the selected reservation. The API checks its current Asset and Event automatically. Manual Collateral inventory adjustments use separate methods.

Logistical Records for another workspace’s Event are unavailable. Owning the physical Asset does not grant access to that Event’s information.

Filtering and paging

Filters work together and apply only to the selected reservation. A valid reservation with no matching records returns an empty list. A missing or inaccessible reservation can return HTTP 404; the empty-result option can replace supported not-found or validation errors with an empty collection.

records_found is the number of records in this response; total_records is the filtered count before paging. has_more indicates whether matching records remain. Results can change between requests.

Each row includes its Record Type, Record Date, description, Recorded By name and creation timestamp. Attachments, parent notes and other reservation details are not included.

Getting a revision before an edit

This collection does not issue record_revision. Retrieve the reservation with GET /v1/assets/reservations/info and $include_record_revision=true when you want to check for changes before updating or deleting a Logistical Record.

If concurrent changes prevent the read, HTTP 409 with error_code=record_changed means you should read again. This read changes no 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.

  1. Save the response body and its ETag header from an earlier GET.
  2. Repeat the same GET, including the same filters and response options, with that ETag in the If-None-Match header.
  3. If the response is HTTP 304, keep using your saved body. If it is HTTP 200, use the new body and ETag.
Code Samples
curl -X GET "https://api.exhibitday.com/v1/assets/reservation_logistical_records?asset_type_id=1&reservation_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "asset_reservation_logistical_record",
  "list_data": [
    {
      "id": 12345,
      "asset_type_id": 0,
      "reservation_id": 0,
      "asset_id": 0,
      "record_type_id": 0,
      "record_type": null,
      "record_date": null,
      "description": "Sample description",
      "logistical_record_created_by": {
        "id": "11111111-2222-4333-8444-555555555555",
        "first_name": "Jane",
        "last_name": "Smith",
        "display_name": "Jane Smith",
        "email": "jane@example.invalid",
        "type": "user",
        "workspace_role": "team_member",
        "is_active": true
      },
      "logistical_record_created_timestamp": "2026-11-19T17:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace.

Add a Reservation Logistical Record #

Method
POST
Endpoint

Adds a Logistical Record to an Asset reservation.

Parameters
Name Type Required? Description Details
asset_type_id Number Yes
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
Allowed values: 1 (Capital) | 2 (Collateral)
reservation_id Number Yes
The ID of the reservation for the selected Asset type.
No additional Asset or Event ID is needed.
record_type_id Number Yes
The current Record Type ID for this milestone.
Standard choices are 1 (Prepped), 2 (Sent), 3 (Received) and 4 (Other).
record_date Date Yes
The date when this logistical action took place.
Use YYYY-MM-DD. This is the milestone’s calendar date, not a due date or time of day.
description String No
A short description of the milestone.
Up to 200 characters, excluding surrounding spaces. Use JSON, query-string or form values when the text contains commas.
$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 logistical milestone to an Asset reservation, such as when it was prepared, sent or received. Record Type and Record Date are required; the description is optional.

Before changing a record

Your workspace needs the Logistical Records feature and permission to edit the selected reservation. ExhibitDay checks the reservation, its Asset and its Event automatically. Hidden or locked Event content cannot be changed.

Owning the physical Asset does not grant access to another workspace’s Event information. Manual Collateral inventory adjustments use separate methods.

Adding a milestone

  1. Send asset_type_id and reservation_id to select the reservation.
  2. Send the milestone’s record_type_id and record_date. Add an optional description.
  3. Read the created record, including its ID, from the response. Its Recorded By name is ExhibitDay API.

Retrying the same create

Send the optional Idempotency-Key request header if you may repeat the same create request. Reuse that key only with the same request so a completed response can be replayed without adding another milestone.

expected_revision is not accepted by POST. If the save outcome cannot be confirmed, check the current records before trying again.

Sending descriptions with commas

Put a description containing commas in a JSON body, query string or form field.

What stays unchanged

This action leaves reservation dates, quantities, availability, related-item links and files unchanged. It sends no notifications.

A confirmed change is added to history. A history-writing failure does not undo the saved change. If the save outcome cannot be confirmed, retrieve the current records before deciding whether to retry. The API does not automatically repeat the action.

Hidden or locked Assets tab

If the reservation's Event is in your workspace and its Assets tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/assets/reservation_logistical_records" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"asset_type_id\":1,\"reservation_id\":12345,\"record_type_id\":1,\"record_date\":\"2026-12-19\"}"

Example response

{
  "id": 23456,
  "asset_type_id": 1,
  "reservation_id": 12345,
  "asset_id": 0,
  "record_type_id": 1,
  "record_type": null,
  "record_date": "2026-12-19",
  "description": "Sample description",
  "logistical_record_created_by": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "logistical_record_created_timestamp": "2026-11-19T17:00:00Z"
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Reservation Logistical Record #

Method
PATCH
Endpoint

Updates a Logistical Record on an Asset reservation.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Logistical Record.
record_type_id Number No
The current Record Type ID for this milestone.
Standard choices are 1 (Prepped), 2 (Sent), 3 (Received) and 4 (Other).
record_date Date No
The date when this logistical action took place.
Use YYYY-MM-DD. This is the milestone’s calendar date, not a due date or time of day.
description String No
A short description of the milestone.
Up to 200 characters, excluding surrounding spaces. Use JSON, query-string or form values when the text contains commas.
expected_revision String No
The record_revision from the reservation's Info response. Include it to avoid overwriting changes to that reservation or its Logistical Records. Omit it to skip this check.
$ignore_params_with_empty_values Boolean No
Set to true to ignore editable fields sent as JSON null.
Default: false. The text "null" still requests a clear. Only description can be cleared; Record Type and Record Date cannot.

Good to know

Updates the supplied Record Type, Record Date or description of a Logistical Record. Omitted fields keep their saved values. The record’s original Recorded By name and creation time remain unchanged.

Before changing a record

Your workspace needs the Logistical Records feature and permission to edit the selected reservation. ExhibitDay checks the reservation, its Asset and its Event automatically. Hidden or locked Event content cannot be changed.

Owning the physical Asset does not grant access to another workspace’s Event information. Manual Collateral inventory adjustments use separate methods.

Changing or clearing fields

Include the Logistical Record ID as id. Send only the fields you want to change. Omitted or blank fields keep their saved values.

JSON null or the text "null" clears description. Record Type and Record Date cannot be cleared. With $ignore_params_with_empty_values=true, real JSON null is ignored; the text "null" still requests a clear.

Sending the same displayed Record Date preserves any time saved on an older record. A genuinely changed date is saved as a calendar date. Sending unchanged values makes no change to the record, revision, timestamps or history.

Avoiding conflicting edits

  1. Retrieve the Logistical Record by id to find its current asset_type_id and reservation_id. Retrieve GET /v1/assets/reservations/info with that reservation_id as id, its asset_type_id and $include_record_revision=true.
  2. Send the returned reservation record_revision as expected_revision in this PATCH request.

What expected_revision checks

Use the reservation’s record_revision, retrieved with $include_record_revision=true, as expected_revision in this request. It checks the whole reservation and all its Logistical Records, including siblings, Optional Accessory quantities, note formatting saved in ExhibitDay and related-item links. Attachment metadata and file contents are excluded. Logistical Record Info does not issue this revision.

A covered value that differs from your earlier read returns HTTP 409 with error_code=record_changed and saves nothing. Retrieve the reservation again and review its current values before deciding whether to retry. A value that changed and later changed back still matches.

Blank, null, malformed or conflicting revision values return HTTP 400 with error_code=invalid_request. A successful update includes the reservation’s current revision only if you supplied expected_revision. The revision grants no additional permission.

Retrying an update

This method ignores Idempotency-Key. If the result is uncertain, retrieve the current record before retrying; the API does not automatically repeat the update.

Sending descriptions with commas

Put a description containing commas in a JSON body, query string or form field.

What stays unchanged

This action leaves reservation dates, quantities, availability, related-item links and files unchanged. It sends no notifications.

A confirmed change is added to history. A history-writing failure does not undo the saved change. If the save outcome cannot be confirmed, retrieve the current records before deciding whether to retry. The API does not automatically repeat the action.

Hidden or locked Assets tab

If the reservation's Event is in your workspace and its Assets tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/assets/reservation_logistical_records" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"description\":\"Updated description\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Logistical Record updated.",
  "errors": []
}

Delete a Reservation Logistical Record #

Method
DELETE
Endpoint

Deletes a Logistical Record from an Asset reservation.

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.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Logistical Record.
expected_revision String No
The record_revision from the reservation's Info response. Include it to delete the record only if that reservation and its Logistical Records are unchanged since your read. Omit it to skip this check.

Good to know

Permanently removes one Logistical Record from the selected Asset reservation. It removes only that milestone; the reservation and its other records remain.

Before changing a record

Your workspace needs the Logistical Records feature and permission to edit the selected reservation. ExhibitDay checks the reservation, its Asset and its Event automatically. Hidden or locked Event content cannot be changed.

Owning the physical Asset does not grant access to another workspace’s Event information. Manual Collateral inventory adjustments use separate methods.

Removing the record

  1. Use the Logistical Record ID as id to select the entry.
  2. Send the DELETE request with the API key in the Authorization: Bearer header.

Deleting only if nothing changed

The revision checks the whole reservation and all its Logistical Records, including other records on it. A covered value that differs from your earlier read returns HTTP 409 with error_code=record_changed and deletes nothing. Retrieve the reservation again and review its current values before deciding whether to retry.

Blank, null, malformed or conflicting revision values return HTTP 400 with error_code=invalid_request. Omit expected_revision to delete without this check. A successful deletion includes the reservation’s new record_revision only if you supplied expected_revision.

  1. Retrieve the Logistical Record by id to find its current asset_type_id and reservation_id. Retrieve GET /v1/assets/reservations/info with that reservation_id as id, its asset_type_id and $include_record_revision=true.
  2. Send the returned reservation record_revision as expected_revision in this DELETE request.

Retrying a deletion

This method ignores Idempotency-Key.

If the result is uncertain, retrieve the reservation’s current Logistical Records before deciding whether to retry. A concurrent-change refusal returns HTTP 409 with error_code=record_changed and changes nothing.

What stays unchanged

This action leaves reservation dates, quantities, availability, related-item links and files unchanged. It sends no notifications.

A confirmed change is added to history. A history-writing failure does not undo the saved change. If the save outcome cannot be confirmed, retrieve the current records before deciding whether to retry. The API does not automatically repeat the action.

Hidden or locked Assets tab

If the reservation's Event is in your workspace and its Assets tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/assets/reservation_logistical_records?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Logistical Record removed.",
  "errors": []
}