object InventorySnapshot

Fields

FieldTypeDescription
snapshot_idString

Public API snapshot ID that identifies the related record.

job_user_idString

Public API job user ID that identifies the related record.

job_account_idString

Public API job account ID that identifies the related record.

warehouse_idString

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

customer_account_idString

3PL child/customer account ID this record belongs to; omit on inputs to use the authenticated account.

notification_emailString

Email address for the notification contact.

email_errorString

Email error for this inventory snapshot.

post_urlString

URL for the post URL resource.

post_errorString

Post error for this inventory snapshot.

post_url_pre_checkBoolean

Whether the post_url is validated before the inventory snapshot starts.

statusString

Current status; use the API status values returned by this field when filtering or updating.

errorString

Error message returned when the operation cannot complete.

created_atISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

enqueued_atISODateTime

Enqueued at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

updated_atISODateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

snapshot_urlString

URL for the snapshot URL resource.

snapshot_expirationISODateTime

Snapshot expiration as an ISO-8601 datetime, returned in UTC unless otherwise noted.

new_formatBoolean

Whether the inventory snapshot uses the newer export format.

Referenced By

Example

{
  "snapshot_id": "SW52ZW50b3J5U25hcHNob3Q6MTIzNA==",
  "job_user_id": "SW52ZW50b3J5U25hcHNob3Q6MTIzNA==",
  "job_account_id": "SW52ZW50b3J5U25hcHNob3Q6MTIzNA==",
  "warehouse_id": "SW52ZW50b3J5U25hcHNob3Q6MTIzNA==",
  "customer_account_id": "SW52ZW50b3J5U25hcHNob3Q6MTIzNA==",
  "notification_email": "customer@example.com",
  "email_error": "customer@example.com",
  "post_url": "https://example.com/resource",
  "post_error": "HTTP 400: invalid payload",
  "post_url_pre_check": true,
  "status": "pending",
  "error": "Customer requested expedited handling.",
  "created_at": "2026-07-09T15:30:00Z",
  "enqueued_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "snapshot_url": "https://example.com/resource",
  "snapshot_expiration": "2026-07-09T15:30:00Z",
  "new_format": true
}