Skip to main content

requestOrdersExport

Requests an asynchronous orders export for the current brand.

The export is processed in the background and generates a CSV file with the orders and their line items. Each order produces one row per order item, with order-level data repeated. Orders without items are included with empty item fields.

Use the returned process_id to track the export progress.

Authentication​

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

Filters​

  • **status**: Filter by order status (DRAFT, ORDERED, SHIPPED, etc.).
  • **order_type**: Filter by order type (B2B, DTC).
  • **include_archived**: Include archived orders in the export.

Possible Errors​

  • **You must be logged in**: Authentication is required.
  • **Brand is required**: The X-Brand-Id header must be provided.
requestOrdersExport(
  input: RequestOrdersExportInput!
): AsynchronousActionResponse!

Arguments​

requestOrdersExport.input ● RequestOrdersExportInput! non-null input​

Parameters for RequestOrdersExport

Type​

AsynchronousActionResponse object​

Asynchronous action response type