Skip to main content

Export Orders

GET /v1/order/export

Exports orders to a file format such as CSV or other specified formats for transfer or archival purposes. The endpoint filters orders based on the provided criteria including tenant, status, date range, and search terms. Returns a downloadable file containing the order data in the requested format with options for detailed or summary views.

Query Parameters

  • format - Parameter for format
  • option - Parameter for option
  • ids - Parameter for ids
  • view - Parameter for view
  • filter[tenant] - Parameter for filter[tenant]
  • ~search - Parameter for ~search
  • ~filter[status] - Parameter for ~filter[status]
  • ~filter[from] - Parameter for ~filter[from]
  • ~filter[to] - Parameter for ~filter[to]

Request Example

GET /v1/order/export?format=&option=&ids=67c8371510650a0b62061755.6745df8da7431da9eec63fed&view=detailed&filter[tenant]=!6789ff59908b6ee0f32fef74