---
title: "Queue an export of the partner orders report"
method: GET
path: "/shop/reports/partner-orders/queue"
tags: ["Reports"]
---

# Queue an export of the partner orders report

`GET /shop/reports/partner-orders/queue`

Use this endpoint to queue a background job that renders the
partner orders report as a CSV. The job runs asynchronously and the
resulting file is attached to the returned `QueuedJob` once it has
finished. Pass `email=true` to additionally have the file emailed to
the user who queued the job.

This is the recommended variant for partners with large order
volumes, where the synchronous
[export](#operation/listPartnerOrders) endpoint may time out.

Requires the `admin.sites.manage` permission.

## Query parameters

- `partner_id` string, required
- `site_id` string
- `customer_id` string, uuid
- `status` string
- `query` string
- `submitted_at_from` string, date-time
- `submitted_at_to` string, date-time
- `item_date_from` string, date
- `item_date_to` string, date
- `revenue_date_from` string, date
- `revenue_date_to` string, date
- `labels` string
- `external_id` string
- `email` boolean

## Response `200`

The job was successfully queued

- object
  - `data` QueuedJob, required
    - `id` string, uuid, required — The ID of the queued job.
    - `status` 'pending' | 'complete' | 'failed', required — The status of the queued job.
    - `output` object, required — The output of the queued job.
    - `created_at` string, date-time, required — The date and time the queued job was created.
    - `updated_at` string, date-time, required — The date and time the queued job was last updated.

## Other responses

- `403` — The authenticated user does not have permission.
- `422` — The request didn't pass validation

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)