See the Queries page for a presentation of this resource.

Available mutations

Creates a new stock count.

Parameters:

Parameter	Type	Description
`input`	StockCountCreateInput	Initialization data.

Example:

mutation {
  CreateStockCount(input: {
    label: "SC-2026-001",
    location: { id: 100001 }
  }) {
    id
    label
    status
  }
}

Updates an existing stock count.

Parameters:

Parameter	Type	Description
`id`	ID!	ID of the stock count.
`input`	StockCountUpdateInput	Updated data.

Adds a line item or increments its quantity by scanning a barcode.

Parameters:

Parameter	Type	Description
`id`	ID!	ID of the stock count.
`barcode`	String!	The scanned barcode.

Sets the counted quantity of a line item within a stock count.

Parameters:

Parameter	Type	Description
`id`	ID!	ID of the stock count line item.
`quantity`	Float	The new quantity.

Generates the next available stock count label.

mutation {
  GenerateStockCountNumber
}

Input data types

label String
Label of the stock count

dated_at Date
Date of the stock count

location LocationInput
Location to count (required)

notes String
Notes attached to the stock count

bin_location_filter String
Optional filter on bin locations during count

label String
Label of the stock count

dated_at Date
Date of the stock count

notes String
Notes attached to the stock count

status StockCountStatus
Status of the stock count

Value	Description
`in_progress`	Count is in progress.
`stock_update_in_progress`	Stock is being updated.
`completed`	Count completed and stock updated.
`cancelled`	Document voided.