Skip to main content

supplyUpdateShipmentsFinancials

Updates the financial details of multiple supply shipments in bulk.

Authentication​

Requires authentication and the supply:update_shipment_financials permission.

Behavior​

  • Updates financial information for one or more shipments in a single request.
  • For each shipment, you can update origin costs, transportation costs, destination costs, duties, taxes, and/or other fees.
  • You can also update HTS codes via the htsCodes field.
  • You can assign an HTS code to an item via the htsCode field in items.
  • At least one field (financial, items, or htsCodes) must be provided for each shipment update.
  • The mutation is processed asynchronously and returns a process ID for tracking.

Validation Rules​

  • A maximum of 50 shipments can be updated per request.
  • Each shipment must exist and belong to the specified brand.
  • At least one field (originCosts, transportationCosts, destinationCosts, duties, taxes, otherFees, items, or htsCodes) must be provided for each shipment.
  • Each HTS code in htsCodes must already exist for the shipment.

Possible Errors​

  • You can update a maximum of 50 shipments at a time - The request exceeds the batch limit.
  • Shipment with ID {id} not found - The specified shipment does not exist.
  • At least one financial field, item update, or HTS code update must be provided - No data was specified for a shipment update.
  • HTS code '{code}' not found for shipment {id} - The specified HTS code does not exist for the shipment.
supplyUpdateShipmentsFinancials(
  input: UpdateShipmentsFinancialsInput!
): AsynchronousActionResponse!

Arguments​

supplyUpdateShipmentsFinancials.input ● UpdateShipmentsFinancialsInput! non-null input common​

Parameters for UpdateShipmentsFinancials

Type​

AsynchronousActionResponse object common​

Asynchronous action response type