cycle_counts

Arguments

Argument	Type	Required	Description
`warehouse_id`	`String`!	Yes	The warehouse ID to filter cycle counts by.
`customer_account_id`	`String`	No	Filter by customer account ID (for 3PL accounts).
`sku`	`String`	No	Filter by SKU.
`status`	[`String`]	No	Filter by status. Possible values: uncounted, in_progress, closed.
`count_type`	[DSCycleCountBatchCountTypes]	No	Filter by count type.
`date_from`	ISODateTime	No	Filter by created date (from).
`date_to`	ISODateTime	No	Filter by created date (to).
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

CycleCountsQueryResult

Query

query cycle_counts(
  $warehouse_id: String!,
  $customer_account_id: String,
  $sku: String,
  $status: [String],
  $count_type: [DSCycleCountBatchCountTypes],
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $analyze: Boolean
) {
  cycle_counts(
    warehouse_id: $warehouse_id,
    customer_account_id: $customer_account_id,
    sku: $sku,
    status: $status,
    count_type: $count_type,
    date_from: $date_from,
    date_to: $date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...CycleCountBatchConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...CycleCountBatchEdgeFragment
      
        node {
          ...CycleCountBatchFragment
        
          id
          legacy_id
          name
          warehouse_id
          account_id
          count_type
          queue_status
          status
          progress
          counted
          uncounted
          due_date
          started_at
          ended_at
          created_at
          updated_at
          locations {
            ...CycleCountProgressTypeFragment
          
            total
            counted
          }
          skus {
            ...CycleCountProgressTypeFragment
          
            total
            counted
          }
        }
        cursor
      }
    }
  }
}

Variables

{
  "warehouse_id": "abc123",
  "customer_account_id": "abc123",
  "sku": "abc123",
  "status": ["abc123"],
  "count_type": ["PRODUCTS"],
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": true
}

Response

{
  "data": {
    "cycle_counts": {
      "request_id": "abc123",
      "complexity": 987,
      "data": CycleCountBatchConnection
    }
  }
}