Skip to main content

splitGoodsReceiptLineItem

Splits a line item in two: a new line item is created with newLineItemQuantity units and the original keeps the remainder, so the received total stays the same. Use it to stock parts of one receipt line separately. The quantity must be lower than the line item's current quantity, and the goods receipt must not be completed yet. Returns the updated goods receipt.

Required scopes​

The token needs the goods_receipts:write access scope.

splitGoodsReceiptLineItem(
  id: ID!
  newLineItemQuantity: Int!
): GoodsReceipt!

Arguments​

splitGoodsReceiptLineItem.id ● ID! non-null scalar​

ID of the line item to split.

splitGoodsReceiptLineItem.newLineItemQuantity ● Int! non-null scalar​

Number of units to move onto the newly created line item. Must be positive and lower than the current quantity of the line item.

Type​

GoodsReceipt object​

An incoming or outgoing goods movement booked against a warehouse — supplier receipt, return-from-customer, manual stock correction. Carries the per-line quantities and prices that are posted to stock once the receipt is completed.