AssetsInventory Adjustments

Inventory Adjustments

Retrieve a Single Inventory Adjustment by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single manual Collateral inventory adjustment by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the manual inventory adjustment.
Use an ID from this inventory-adjustment collection. Event and Capital reservation IDs are different records, even if the numbers match.
$include_record_revision Boolean No
Set to true to include a record_revision for checking a later update.
Default: false. Use the returned value with PATCH /v1/assets/inventory_adjustments or DELETE /v1/assets/inventory_adjustments.
$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 for supported validation or not-found errors.
Default: false. Other errors keep their normal status.
$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 response still includes its error list.
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 manual Collateral inventory adjustment. Set $include_record_revision=true if you plan to update it and want to check for changes before saving.

Understanding the quantity and dates

quantity_adjustment is the signed change: positive for an increase and negative for a decrease. quantity is its size without the sign. For example, a decrease of 10 has quantity_adjustment=-10 and quantity=10.

Older zero adjustments remain visible. is_quantity_editable=false marks an inherited quantity outside the editing range; it remains readable.

An older return_date is the date when the adjustment’s quantity effect was scheduled to reverse. It does not confirm that an item was physically returned. GET preserves that historical date; new manual adjustments normally have no return date.

What the response includes

The response contains the adjustment itself, its Collateral item, saved description and formatting, Shipping Logistics choice, flag, star and checked status, and location when it is available to your workspace. It does not include attachments, Logistical Records or related-item links.

The Storage Location ID and name are included only when the location is in your workspace. Shared-Asset access does not grant access to the owner’s manual inventory.

description is returned as text: HTML-encoded, with line breaks as <br/>. Formatting added in ExhibitDay is not returned. Account identifiers and file-storage details are not exposed.

Getting a revision for an update

  1. Retrieve the adjustment with $include_record_revision=true.
  2. Send the returned record_revision as expected_revision in PATCH /v1/assets/inventory_adjustments, or in DELETE /v1/assets/inventory_adjustments to delete it only if it is unchanged.

What $include_record_revision covers

Set $include_record_revision=true to receive record_revision in this GET response. It covers the adjustment fields, formatting saved in ExhibitDay, Logistical Records and related-item links. Attachment metadata and file contents are outside its scope.

A stale revision makes PATCH or DELETE return HTTP 409 with error_code=record_changed and change nothing. Retrieve the adjustment again and review the current values before deciding whether to retry.

Handling a missing adjustment

A missing or inaccessible adjustment returns HTTP 404. Set $on_error_return_empty_result=true for an empty object instead, or an empty array when $result_format=array. Current API access is still checked.

Matching copies of a parameter count once. Malformed inputs, conflicting copies, authentication errors, read conflicts and unexpected errors retain their normal status. A read conflict returns HTTP 409 with error_code=record_changed; retrieve the record again.

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/inventory_adjustments/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=12346&reservation_id=12345",
  "id": 12345,
  "asset_id": 12346,
  "asset_name": "Printed brochures",
  "storage_location_id": 2345,
  "storage_location_name": "Main Warehouse",
  "effective_date": "2030-01-02",
  "return_date": null,
  "quantity_adjustment": 10,
  "quantity": 10,
  "is_increase": true,
  "is_quantity_editable": true,
  "description": "Additional printed brochures arrived",
  "shipping_logistics_id": 1,
  "is_flagged": false,
  "is_starred": false,
  "is_checked": false,
  "inventory_adjustment_created_timestamp": "2030-01-01T17:00:00Z"
}
Note: IDs are illustrative; use IDs from your workspace.

Retrieve Inventory Adjustments #

Method
GET
Endpoint

Retrieves manual Collateral inventory adjustments.

Parameters
Name Type Required? Description Details
filter_by_inventory_adjustment_id Number No
Only return this manual inventory adjustment.
filter_by_asset_id Number No
Only return adjustments for this Collateral item.
filter_by_storage_location_id Number No
Only return adjustments at this Storage Location.
filter_by_effective_date_greater_than_or_equal_to Date No
Only return adjustments effective 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_effective_date_smaller_than_or_equal_to Date No
Only return adjustments 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 adjustments by effective date, creation time or ID. Omit for effective date ascending. Date and time ties use ID ascending. Unsupported values are refused. Use the values exactly as shown (lowercase).
Allowed values: effective_date_asc | effective_date_desc | create_timestamp_asc | create_timestamp_desc | id_asc | id_desc
$limit Number No
The maximum number of matching adjustments to return.
Send 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 adjustments 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. No matching adjustments normally returns an empty collection.
$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 response still includes its error list.
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 manual increases and decreases in Collateral inventory, such as newly received brochures or stock removed from storage. These entries are not assigned to an Event. By default, it returns all matching adjustments in Effective Date order. Add filters or paging to narrow the result.

Filtering and paging

Filters work together. A matching adjustment must satisfy every ID and date filter you provide. Event reservations and Capital Asset reservations are excluded; these manual entries are always for Collateral inventory.

records_found is the number of rows in this response; total_records is the filtered count before paging. has_more indicates whether more matches remain. Counts and pages may change while inventory is edited.

The collection does not issue revisions and does not support changed-since filtering.

Understanding the quantity and dates

quantity_adjustment is the signed change: positive for an increase and negative for a decrease. quantity is its size without the sign. For example, a decrease of 10 has quantity_adjustment=-10 and quantity=10.

Older zero adjustments remain visible. is_quantity_editable=false marks an inherited quantity outside the editing range; it remains readable.

An older return_date is the date when the adjustment’s quantity effect was scheduled to reverse. It does not confirm that an item was physically returned. GET preserves that historical date; new manual adjustments normally have no return date.

What the response includes

The response contains the adjustment itself, its Collateral item, saved description and formatting, Shipping Logistics choice, flag, star and checked status, and location when it is available to your workspace. It does not include attachments, Logistical Records or related-item links.

The Storage Location ID and name are included only when the location is in your workspace. Shared-Asset access does not grant access to the owner’s manual inventory.

description is returned as text: HTML-encoded, with line breaks as <br/>. Formatting added in ExhibitDay is not returned. Account identifiers and file-storage details are not exposed.

Handling errors

Matching copies of a parameter count once. Malformed inputs, conflicting copies, authentication errors, read conflicts and unexpected errors keep their normal error response, even when $on_error_return_empty_result=true.

If concurrent changes prevent the read, HTTP 409 with error_code=record_changed means you should retrieve the data 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/inventory_adjustments" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "inventory_adjustment",
  "list_data": [
    {
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=12346&reservation_id=12345",
      "id": 12345,
      "asset_id": 12346,
      "asset_name": "Printed brochures",
      "storage_location_id": 2345,
      "storage_location_name": "Main Warehouse",
      "effective_date": "2030-01-02",
      "return_date": null,
      "quantity_adjustment": 10,
      "quantity": 10,
      "is_increase": true,
      "is_quantity_editable": true,
      "description": "Additional printed brochures arrived",
      "shipping_logistics_id": 1,
      "is_flagged": false,
      "is_starred": false,
      "is_checked": false,
      "inventory_adjustment_created_timestamp": "2030-01-01T17:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace.

Add an Inventory Adjustment #

Method
POST
Endpoint

Adds a manual Collateral inventory adjustment.

Parameters
Name Type Required? Description Details
asset_id Number Yes
The ID of the Active Collateral/Multi-quantity item whose inventory you want to adjust. Capital Assets are not accepted.
quantity Number Yes
The size of the increase or decrease.
One positive whole number from 1 through 2,147,483,647. Send the direction separately with is_increase.
is_increase Boolean Yes
Set to true to add stock, or false to remove stock.
description String Yes
The description explaining this inventory change.
Plain text, up to 1,000 characters. Line breaks are preserved. GET returns the description as text: HTML-encoded, with line breaks as <br/>. The description cannot be blank.
is_effective_immediately Boolean No
Set to true to use today, or false when choosing an Effective Date.
Uses today in your workspace’s time zone. true overrides a supplied effective_date. If omitted, a supplied date is used; otherwise the date defaults to today.
effective_date Date When is_effective_immediately=false
The date when this inventory change should take effect.
Use YYYY-MM-DD.
storage_location_id Number For an existing location
The Storage Location for this inventory change.
Choose an existing location, or supply both new-location fields for an increase. Do not combine the two choices.
new_storage_location_name String For a new location
The name of a new Storage Location for this increase.
1–120 characters, excluding surrounding spaces. A new location is available only when is_increase=true.
new_storage_location_address String For a new location
The full street address of the new Storage Location.
10–500 characters, excluding surrounding spaces.
shipping_logistics_id Number No
The Shipping Logistics choice to record for this adjustment. Omit for Unspecified.
Allowed values: 1 (Unspecified) | 2 (Advance Warehouse) | 3 (Direct Shipment) | 4 (Other)
is_flagged Boolean No
Whether to flag this inventory entry.
Default: false.
is_starred Boolean No
Whether to star this inventory entry.
Default: false.
is_checked Boolean No
Whether to mark this inventory entry as checked.
Default: false.
$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

Records a manual increase or decrease in Collateral stock without assigning it to an Event. The quantity takes effect on the chosen Effective Date. Use an existing Storage Location, or create a new location when adding stock. The response includes exhibitday_url, the record's page in ExhibitDay.

Recording an inventory change

  1. Send asset_id, a positive quantity, the direction in is_increase, and a description.
  2. Choose the Effective Date and one Storage Location option below.
  3. Read the created adjustment from the response. An increase adds the quantity; a decrease subtracts it.

Choosing the date

  • For today, omit both date options or send is_effective_immediately=true.
  • For another date, send effective_date. You can also send is_effective_immediately=false, which requires the date.
  • If is_effective_immediately=true and a date are both supplied, today is used.

Choosing the Storage Location

  • For an existing location, send its storage_location_id. It must be in your workspace.
  • For a new location, send is_increase=true, new_storage_location_name and new_storage_location_address, and omit storage_location_id.
  • The new location and inventory increase are saved together. A refused adjustment leaves no unused new location. Address lookup is best effort; a failed lookup keeps the entered address.

Inventory limits and side effects

A new adjustment requires an Active Collateral/Multi-quantity item. Shared-Asset access does not grant access to the owner’s manual inventory. Capital Assets cannot be adjusted because they are single-quantity items. Capital Asset and Event reservations use /v1/assets/reservations.

Inventory totals may be negative. The API refuses an adjustment that would put a resulting stored total outside the supported whole-number range. It does not impose a rule that every total must stay nonnegative.

This method does not create an Event reservation, related-item links, attachments or a scheduled return. It sends no follower or business notifications. A confirmed change is recorded in history; a history-writing failure does not undo the saved adjustment.

Retrying the same create

Use the optional Idempotency-Key request header if you may retry the same create request. Reuse that key only with the same request so a completed response can be replayed without creating another adjustment.

If the save outcome cannot be confirmed, check the adjustment and inventory before retrying. The API does not automatically repeat the action. expected_revision is not supported on POST.

Sending text with commas

Use JSON, the query string or a form field for a description or new location that contains a comma.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/assets/inventory_adjustments" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"asset_id\":12345,\"storage_location_id\":12345,\"quantity\":10,\"is_increase\":true,\"description\":\"Additional printed brochures arrived\"}"

Example response

{
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=12345&reservation_id=23456",
  "id": 23456,
  "asset_id": 12345,
  "asset_name": "Printed brochures",
  "storage_location_id": 12345,
  "storage_location_name": "Main Warehouse",
  "effective_date": "2030-01-02",
  "return_date": null,
  "quantity_adjustment": 10,
  "quantity": 10,
  "is_increase": true,
  "is_quantity_editable": true,
  "description": "Additional printed brochures arrived",
  "shipping_logistics_id": 1,
  "is_flagged": false,
  "is_starred": false,
  "is_checked": false,
  "inventory_adjustment_created_timestamp": "2030-01-01T17:00:00Z"
}
Note: IDs are illustrative; use IDs from your workspace.

Update an Inventory Adjustment #

Method
PATCH
Endpoint

Updates a manual Collateral inventory adjustment.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the manual inventory adjustment you want to update.
effective_date Date No
The date the adjustment affects inventory. Omit to keep the saved date and any previously stored time of day.
YYYY-MM-DD.
storage_location_id Number No
The ID of the Storage Location for the adjustment. To move the adjustment, choose another Storage Location in your workspace.
quantity Number No
The corrected number of units for this adjustment. Use is_increase to set the direction.
Whole number from 1 through 2,147,483,647.
is_increase Boolean No
Set to true for an inventory increase or false for a decrease. Omit to keep the saved direction.
description String No
The reason for the adjustment, in plain text. An older description that exceeds a limit can retain its existing length.
Plain text, up to 1,000 characters. Line breaks are preserved. GET returns the description as text: HTML-encoded, with line breaks as <br/>.
shipping_logistics_id Number No
The Shipping Logistics choice. Omit to keep the current choice.
Allowed values: 1 (Unspecified) | 2 (Advance Warehouse) | 3 (Direct Shipment) | 4 (Other)
is_flagged Boolean No
Set to true to flag the adjustment or false to remove the flag.
is_starred Boolean No
Set to true to star the adjustment or false to remove the star.
is_checked Boolean No
Set to true to mark the adjustment as checked or false to uncheck it.
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 editable fields sent as JSON null. The string "null" still requests a clear and is rejected.
Default: false.

Good to know

Updates a manual inventory adjustment for a Collateral/Multi-quantity item. An adjustment increases or decreases the quantity at a Storage Location. Its Effective Date determines when that change affects inventory totals.

Changing adjustment values

Include id in every request. Send only the editable fields you want to change. For example, to correct an increase from 12 units to 10, send quantity=10 and omit is_increase. The adjustment will add 10 units instead of 12.

Omitting an editable field or sending a blank value keeps its saved value. These fields cannot be cleared. If a description contains a comma, send it in a JSON body, query string or form field.

Inventory totals may be negative. A change is rejected if a resulting total falls outside the supported whole-number range. An older adjustment whose saved quantity is outside the editing range cannot be updated. Existing adjustments on an archived item can still be corrected. Shared-Asset access does not grant access to the owner’s manual inventory.

Updating an older adjustment with a return date

GET /v1/assets/inventory_adjustments/info can return a return_date for older adjustments. On that date, the adjustment's effect on inventory is reversed. Editing one of these adjustments removes its scheduled reversal. This also applies if you change only the flag, star or checked status.

If every value you send matches the saved values and there is no other effective change, the API keeps the reversal and makes no change to the saved dates, formatting, revision or history.

Avoiding conflicting updates

  1. Retrieve the adjustment with GET /v1/assets/inventory_adjustments/info and set $include_record_revision=true.
  2. In your PATCH request, set expected_revision to the exact record_revision returned by GET.

Handling revisions and conflicts

The revision covers the adjustment fields, formatting saved in ExhibitDay, Logistical Records and related-item links. Attachment metadata and file contents are outside its scope.

If any covered value differs from what you read, the API returns HTTP 409 with error_code=record_changed and saves nothing. Retrieve the adjustment again, review its current values and decide whether to retry. A value that changed and was later changed back still matches.

When you send expected_revision, a successful response includes the adjustment’s current record_revision. A blank, null or malformed revision, or different revision values sent in the same request, returns HTTP 400 with error_code=invalid_request.

Retrying a request

If you cannot tell whether the update succeeded, retrieve the adjustment and check the item’s inventory before retrying. The API does not retry automatically. This endpoint ignores the Idempotency-Key header. A history-writing failure does not undo an update that was saved.

Updating a manual inventory adjustment sends no follower or business notifications.

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

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Inventory Adjustment updated.",
  "errors": []
}

Delete an Inventory Adjustment #

Method
DELETE
Endpoint

Deletes a manual Collateral inventory adjustment.

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 manual adjustment to remove.
Its Collateral/Multi-quantity item is found automatically. Event and Capital reservation IDs are not accepted.
expected_revision String No
The record_revision returned when you retrieved this adjustment. Include it to delete the adjustment only if it is unchanged since that read. Omit it to skip this check.

Good to know

Permanently removes a manual Collateral inventory adjustment. This removes its quantity effect from inventory totals, together with any older scheduled reversal. Review the entry before deleting it; this action cannot be undone.

What deletion changes

The adjustment and its formatting saved in ExhibitDay, Logistical Records, related-item links and removable attachments are removed. Linked Tasks or other records themselves remain.

Removing an increase removes the stock it added; removing a decrease removes that reduction. Any inherited return date and its scheduled reversal are removed as well. A return date is not confirmation of a physical return.

Existing adjustments on archived items can be removed. Older adjustments outside the editing range can also be removed if the resulting totals stay in range. The API refuses deletion if a resulting stored total would fall outside the supported whole-number range. Negative totals are permitted.

Content that cannot be removed

The key must be allowed to remove the entry’s associated content. If content cannot safely be removed, the action refuses the request without deleting the adjustment. It does not grant access to another workspace’s Event information.

Review any restricted content in ExhibitDay with an authorized account before deciding how to proceed. A stored file still referenced elsewhere is kept; later file-cleanup failure does not undo a confirmed deletion.

Deleting only an unchanged adjustment

If the adjustment, its formatting saved in ExhibitDay, Logistical Records or related-item links changed since your read, the API returns HTTP 409 with error_code=record_changed and deletes nothing. Retrieve the adjustment again and decide whether to delete it. A value that changed and was later changed back still matches.

A blank, null or malformed revision, or different revision values sent in the same request, returns HTTP 400 with error_code=invalid_request. Omit expected_revision to delete without this check. A successful deletion returns no new revision, because the adjustment no longer exists.

  1. Retrieve the adjustment with GET /v1/assets/inventory_adjustments/info and set $include_record_revision=true.
  2. In your DELETE request, set expected_revision to the exact record_revision returned by GET.

Retrying a deletion

This method ignores the Idempotency-Key header. If the save outcome cannot be confirmed, retrieve the adjustment and check inventory before retrying. The API does not automatically repeat the deletion.

A confirmed deletion is added to history. A history-writing failure does not undo it. Deletion sends no follower or business notifications.

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

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Inventory Adjustment removed.",
  "errors": []
}