inventory_sync_statuses
Fetch inventory sync statuses matching the supplied arguments.
Arguments
| Argument | Type | Required | Default | 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: 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" | |
analyze | Boolean | No | 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 {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
node {
id
url
user_id
account_id
warehouse_id
customer_account_id
total_count
status
error
created_at
updated_at
success_count
error_count
finished_count
}
cursor
}
}
}
}Variables
{
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"customer_account_id": "QWNjb3VudDoxMjM0",
"status": "pending",
"analyze": true
}Response
{
"data": {
"inventory_sync_statuses": {
"request_id": "UmVjb3JkOjEyMzQ=",
"complexity": 100,
"data": [{id: "SW52ZW50b3J5U3luY1N0YXR1czoxMjM0"}]
}
}
}