inventory_sync_statuses

Arguments

ArgumentTypeRequiredDefaultDescription
warehouse_idStringNo
customer_account_idStringNo
statusStringNo

Any of the following statuses:

pending: Queued for processing

processing: Being processed

success: Finished successfully

error: Matches all error states below

error_all: All rows failed

error_partial: Some rows failed

error_unknown: Terminated early due to an error

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"

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

InventorySyncBatchesQueryResult

Query

query inventory_sync_statuses(
  $warehouse_id: String,
  $customer_account_id: String,
  $status: String,
  $analyze: Boolean
) {
  inventory_sync_statuses(
    warehouse_id: $warehouse_id,
    customer_account_id: $customer_account_id,
    status: $status,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventorySyncStatusConnectionFragment
    }
  }
}

Variables

{
  "warehouse_id": "abc123",
  "customer_account_id": "abc123",
  "status": "abc123",
  "analyze": true
}

Response

{
  "data": {
    "inventory_sync_statuses": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InventorySyncStatusConnection
    }
  }
}