inventory_snapshots

Fetch inventory snapshots matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`warehouse_id`	`String`	No	Filter by public API warehouse ID. Use this ID field when selecting a warehouse; warehouse fields are display values or nested objects.
`customer_account_id`	`String`	No	Filter by 3PL child/customer account ID; omit to use the authenticated account.
`status`	`String`	No	Any of the following statuses: pending: Request received enqueued: Queued for processing processing: Being processed success: Finished successfully error: Terminated early due to an exception aborted: Aborted by the user Multiple statuses can be combined using: , e.g. status: "pending,processing" One or more statuses can be excluded using: ! e.g. status: "!error_all,error_partial"
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

InventorySnapshotsQueryResult

Query

query inventory_snapshots(
  $warehouse_id: String,
  $customer_account_id: String,
  $status: String,
  $analyze: Boolean
) {
  inventory_snapshots(
    warehouse_id: $warehouse_id,
    customer_account_id: $customer_account_id,
    status: $status,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventorySnapshotConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...InventorySnapshotEdgeFragment
      
        node {
          ...InventorySnapshotFragment
        
          snapshot_id
          job_user_id
          job_account_id
          warehouse_id
          customer_account_id
          notification_email
          email_error
          post_url
          post_error
          post_url_pre_check
          status
          error
          created_at
          enqueued_at
          updated_at
          snapshot_url
          snapshot_expiration
          new_format
        }
        cursor
      }
    }
    snapshots {
      ...InventorySnapshotConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...InventorySnapshotEdgeFragment
      
        node {
          ...InventorySnapshotFragment
        
          snapshot_id
          job_user_id
          job_account_id
          warehouse_id
          customer_account_id
          notification_email
          email_error
          post_url
          post_error
          post_url_pre_check
          status
          error
          created_at
          enqueued_at
          updated_at
          snapshot_url
          snapshot_expiration
          new_format
        }
        cursor
      }
    }
  }
}

Variables

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "status": "pending",
  "analyze": true
}

Response

{
  "data": {
    "inventory_snapshots": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{id: "SW52ZW50b3J5U25hcHNob3Q6MTIzNA=="}],
      "snapshots": [{id: "SW52ZW50b3J5U25hcHNob3Q6MTIzNA=="}]
    }
  }
}