Skip to main content

supplyUpdateReceivingItems

Updates receiving information for shipment items that are in the IN_RECEIVING status.

Authentication​

Requires authentication and the supply_chain:update_receiving_items permission.

Behavior​

  • Updates one or more shipment items with receiving details during the receiving process.
  • For each item, you can update the received quantity, verification status, destination location, and/or unit cost.
  • At least one field (received_quantity, verified, destination_location_id, or unit_cost) must be provided for each item.
  • When verified is set to true, the item is marked as verified at the current timestamp. When set to false, verification is removed.
  • When unitCost is provided, it updates the cost information for the item in the shipment's currency (defaults to USD).
  • The mutation is processed asynchronously and returns a process ID for tracking.

Validation Rules​

  • The shipment must exist and belong to the specified brand.
  • The shipment must be in IN_RECEIVING status.
  • All items must belong to the specified shipment.
  • At least one of receivedQuantity, verified, destinationLocationId, or unitCost must be provided for each item.
  • receivedQuantity must be a positive number if provided.
  • unitCost must be a positive number if provided.
  • If destinationLocationId is provided, the location must exist, be active, and belong to the shipment's destination warehouse.

Possible Errors​

  • Supply shipment not found - The specified shipment does not exist.
  • You cannot use this action unless the shipment is in 'in_receiving' status - The shipment is not in the correct status for receiving.
  • Items list cannot be empty - No items were provided.
  • Item ID is required for each item - An item in the list is missing the item_id field.
  • Shipment item with ID {id} not found or does not belong to this shipment - The item does not exist or belongs to a different shipment.
  • At least one of received_quantity, verified, destination_location_id, or unit_cost must be provided - No fields to update were specified.
  • Received quantity must be a positive number - A negative quantity was provided.
  • Unit cost must be a positive number - A negative unit cost was provided.
  • Destination location not found or is not active - The specified location does not exist or is inactive.
  • Location does not belong to the shipment's destination warehouse - The location is not in the correct warehouse.
supplyUpdateReceivingItems(
  input: UpdateReceivingItemsInput!
): AsynchronousActionResponse!

Arguments​

supplyUpdateReceivingItems.input ● UpdateReceivingItemsInput! non-null input​

Parameters for UpdateReceivingItems

Type​

AsynchronousActionResponse object​

Asynchronous action response type