Skip to main content

supplyShipmentsStepBack

Moves one shipment back to its previous status during the request and returns it.

Business Rules​

  • expectedStatus is the status the caller saw. The request is refused when the shipment has moved since, so a repeated or stale request cannot move it back one more step
  • A Pending or Canceled shipment cannot step back
  • Stepping back from Received puts each lowered line back to its original quantity when its purchase order line still has the units unshipped. A line whose units are on another shipment now stays lowered, and the activity says why
  • Use supplyStepBackShipments to step back several shipments in the background

Error Scenarios​

  • “Shipment not found”
  • “Shipment is in initial state and cannot be stepped back”
  • “Cannot step back a canceled shipment”
  • “Un-receive every line before stepping back to Delivered.”
  • “This shipment is now Delivered. Reload it and try again.”
  • “This shipment changed. Reload and try again.”

Permissions Required​

  • supply:change_shipment_status
supplyShipmentsStepBack(
  input: SupplyShipmentsStepBackInput!
): SupplyShipment!

Arguments​

supplyShipmentsStepBack.input ● SupplyShipmentsStepBackInput! non-null input common​

Parameters for SupplyShipmentsStepBack

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.