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 at the row grain selected by params.level: one row per order item (ORDERS_AND_ITEMS, default), per order (ORDERS_COMPACT), per shipment (SHIPMENTS_COMPLETE), per carton line (CARTON_LEVEL), or per order with revenue and cost data (ORDER_REVENUE_AND_COSTS). See OrdersExportLevelEnum for the full set and the level field on OrdersExportInput for per-level details.

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 filters as the orders list query. See OrdersExportInput for available options.

Possible Errors​

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

Arguments​

requestOrdersExport.input ● RequestOrdersExportInput! non-null input common​

Parameters for RequestOrdersExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type