Skip to main content

supplyShipmentsStartReceiving

Moves one shipment to In Receiving from Pending, In Transit, or Delivered during the request and returns it.

Business Rules​

  • The statuses between are skipped, and their dates are not recorded
  • expectedStatus is the status the caller saw. The request is refused when the shipment has moved since

Error Scenarios​

  • “Shipment with id … not found.”
  • “Cannot receive shipment SHP-1 in status in_receiving.”
  • “This shipment is now In Transit. Reload it and try again.”
  • “This shipment changed. Reload and try again.”

Permissions Required​

  • supply:receive_shipment
supplyShipmentsStartReceiving(
  input: SupplyShipmentsStartReceivingInput!
): SupplyShipment!

Arguments​

supplyShipmentsStartReceiving.input ● SupplyShipmentsStartReceivingInput! non-null input common​

Parameters for SupplyShipmentsStartReceiving

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.