Skip to main content

supplyUpdateShipmentFinancials

Updates financial details for one supply shipment and returns the updated shipment.

Business Rules​

  • At least one financial field, item update, or HTS code update must be provided.
  • Item updates must belong to the shipment.
  • HTS code updates must reference codes that exist for the shipment; entries without an id create new codes.

Error Scenarios​

  • **NOT_FOUND**: the shipment does not exist or belongs to a different company.
  • **BAD_REQUEST**: no update was provided, an item does not belong to the shipment, a referenced HTS code does not exist, or an HTS entry tries to create and delete in the same operation.

Permissions Required​

  • supply:update_shipment_financials permission
supplyUpdateShipmentFinancials(
  input: UpdateShipmentFinancialsInput!
): SupplyShipment!

Arguments​

supplyUpdateShipmentFinancials.input ● UpdateShipmentFinancialsInput! non-null input common​

Parameters for UpdateShipmentFinancials

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.