Skip to main content

requestSupplyShipmentsExport

Requests an asynchronous supply shipments export for the current company.

The export is processed in the background and generates a CSV file with one row per shipment line item. Header values appear on the first row of each shipment; the shipment number repeats on every row.

The file can be edited and uploaded back, with two groups of exceptions. Shipment Number and Item ID identify the records to update and must remain unchanged. Changing either is unsupported: depending on the row it either fails validation or creates a new record. Item Received Quantity is a reporting column the import ignores.

Status only moves forward. The import walks the shipment through each step to the status named, so it cannot move one backwards or cancel it.

Use the returned process_id to track the export progress.

Authentication​

Requires a logged-in user with access to the company.

Filters​

Supports the same filter fields as the supply shipments list, including keyword, status, shipment type, payment status, destination building, purchase order, lot number and date ranges.

  • **includeArchived**: Include archived shipments in the export.

Possible Errors​

  • **You must be logged in**: Authentication is required.
  • **Supply shipment export is not enabled for this company**: The batch_po_shipment_import feature flag is off for this company.
  • **Company is required**: Company context must be provided (use X-Company-Id header).
requestSupplyShipmentsExport(
  input: RequestSupplyShipmentsExportInput!
): AsynchronousActionResponse!

Arguments​

requestSupplyShipmentsExport.input ● RequestSupplyShipmentsExportInput! non-null input common​

Parameters for RequestSupplyShipmentsExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type