Skip to main content

requestPurchaseOrdersExport

Requests an asynchronous purchase orders export for the current brand.

The export is processed in the background and generates a CSV file at the detail level selected by params.level: import-ready purchase orders with line items (PURCHASE_ORDERS_AND_ITEMS, default), or a verbose reporting export with all available fields (PURCHASE_ORDERS_COMPLETE).

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 used by the purchase orders list, including keyword, supplier, milestone, financial status, archive status, date ranges, and boolean state filters.

  • **level**: Choose import-ready or complete export detail.

Possible Errors​

  • **You must be logged in**: Authentication is required.
  • **Company is required**: Company context must be provided (use X-Company-Id header).
requestPurchaseOrdersExport(
  input: RequestPurchaseOrdersExportInput!
): AsynchronousActionResponse!

Arguments​

requestPurchaseOrdersExport.input ● RequestPurchaseOrdersExportInput! non-null input common​

Parameters for RequestPurchaseOrdersExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type