Stock Counts Mutations

See the Queries page for a presentation of this resource.

CreateStockCount

Creates a new stock count / physical inventory.

Parameters:

ParameterTypeDescription
inputStockCountCreateInput!Initialization data.

Example Query:

mutation CreateStockCount($input: StockCountCreateInput!) {
  CreateStockCount(input: $input) {
    id
    label
    status
    location { id }
  }
}

UpdateStockCount

Updates an existing stock count.

Parameters:

ParameterTypeDescription
idInt!ID of the specified stock count.
inputStockCountUpdateInput!Updated data.

StockCountScanBarcode

Add a line item or increment quantity by scanning a barcode in an active stock count. Returns updated line items.

Parameters:

ParameterTypeDescription
idInt!ID of the stock count.
barcodeString!The scanned barcode from a product, SKU, or batch.

StockCountSetQuantity

Directly update the counted quantity of an item within a stock count. Returns the updated line item.

Parameters:

ParameterTypeDescription
idInt!ID of the stock count line item.
quantityFloatThe new quantity to set.

StockCountSetSerialNumbers

Sets the serial numbers recorded for a stock count line item. Returns the updated line item.

Parameters:

ParameterTypeDescription
idInt!ID of the stock count line item.
serial_numbers_textString!The serial numbers (one per line or comma-separated) to record.

GenerateStockCountNumber

Generates the next available stock count label.


Input Data Types

StockCountCreateInput

FieldTypeDescription
locationLocationInput!Location to count stock in (Required).
labelStringLabel.
dated_atDateDocument date.
notesStringNotes.
bin_location_filterStringOptional string to filter bin locations during count.

StockCountUpdateInput

FieldTypeDescription
labelStringLabel.
dated_atDateDocument date.
notesStringNotes.
statusStockCountStatusStatus.

Enums

StockCountStatus

ValueDescription
in_progressCount is currently in progress.
stock_update_in_progressStock is being updated based on the count.
completedStock update finished and count is completed.
cancelledDocument voided.