Skip to main content

supplyUpdateShipmentCategoryCosts

Distributes a total duties amount to all items in a shipment that belong to a specific HTS category.

Authentication​

Requires authentication and the supply:update_shipment_financials permission.

Behavior​

  • Accepts a shipment ID, an HTS category ID, and a duties cost amount.
  • Distributes the duties cost proportionally by each item's total units cost within the category.
  • Persists the per-item duties_cost and updates the HTS code record's duties_cost to match the sum of distributed items.
  • Returns the full shipment for Apollo cache update.

Possible Errors​

  • Shipment not found - The specified shipment does not exist or belongs to a different company.
  • HTS category not found - The specified HTS category does not exist in this shipment.
  • No active items found - No line items match the HTS code with valid unit cost for distribution.
supplyUpdateShipmentCategoryCosts(
  input: UpdateShipmentCategoryCostsInput!
): SupplyShipment!

Arguments​

supplyUpdateShipmentCategoryCosts.input ● UpdateShipmentCategoryCostsInput! non-null input​

Parameters for UpdateShipmentCategoryCosts

Type​

SupplyShipment object​

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, at_destination, delivered, 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.