Skip to main content

supplyShipmentsMarkReceived

Marks one shipment Received from any earlier status during the request and returns it.

Business Rules​

  • The statuses between are skipped, and their dates are not recorded
  • statusDate is recorded as the received date. It defaults to now when the shipment has no received date, and other dates are kept
  • The received date cannot be earlier than the delivery date or the ship date. The same day is allowed
  • expectedStatus is the status the caller saw. The request is refused when the shipment has moved since
  • The shipment needs at least one item, a destination, and a received quantity on at least one line
  • Each line received short is lowered to what arrived. Its original quantity is kept, and the rest goes back to the purchase order as unshipped

Error Scenarios​

  • “Shipment not found”
  • “A Received shipment cannot be marked received.”
  • “This shipment is now Received. Reload it and try again.”
  • “This shipment changed. Reload and try again.”
  • “The received date can’t be earlier than the delivery date (Oct 20, 2026).”
  • “Enter received quantities before marking the shipment Received. Otherwise, cancel the shipment if this inventory is no longer expected to arrive.”

Permissions Required​

  • supply:change_shipment_status
supplyShipmentsMarkReceived(
  input: SupplyShipmentsMarkReceivedInput!
): SupplyShipment!

Arguments​

supplyShipmentsMarkReceived.input ● SupplyShipmentsMarkReceivedInput! non-null input common​

Parameters for SupplyShipmentsMarkReceived

Type​

SupplyShipment object shipments​

Represents a shipment in the supply chain system.

Shipments are physical movements of goods through the supply chain. They can be linked to purchase orders and track the movement of materials from origin to destination. Each shipment maintains its status, payment information, and relationship to other shipments (hierarchical parent-child structure).

Shipment Types​

  • **Shipment**: Direct shipment to a final destination (building/warehouse)
  • **ASN**: Advanced Shipment Notice, typically an intermediate shipment to a port or hub

Status Lifecycle​

Shipments progress through various statuses: pending, in_transit, delivered, in_receiving, received, closed, or canceled

Each shipment includes associated items, status history, brand information, purchase order reference, and destination facility information. Shipments can have parent-child relationships for consolidated/split shipment scenarios.