Skip to main content

requestSuppliersExport

Requests an asynchronous suppliers export for the current brand.

The export is processed in the background and generates a CSV file with the supplier data including contacts, addresses, and performance metrics. Each supplier produces one row.

Use the returned process_id to track the export progress.

Authentication​

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

Filters​

  • **status**: Filter by supplier status (ACTIVE, INACTIVE).
  • **category**: Filter by supplier category.
  • **include_archived**: Include archived suppliers in the export.

Possible Errors​

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

Arguments​

requestSuppliersExport.input ● RequestSuppliersExportInput! non-null input common​

Parameters for RequestSuppliersExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type