Reports

Export the partner orders report

Use this endpoint to download a CSV export of every order placed through a specific partner. Each row corresponds to one order in the partner's pipeline, sorted by submission date (most recent first); when a query is supplied the rows are ordered by search relevance instead.

Generating the file is synchronous, so for partners with very large order volumes prefer the queue variant of this endpoint, which renders the report on a background worker and notifies you when it is ready.

Requires the admin.sites.manage permission.

get/shop/reports/partner-orders

Query parameters

partner_idstring required

Example:ota

Scope the export to the named partner. Accepts a partner key from the platform partner catalogue (or ota for the generic OTA bucket). Only baskets attributed to this partner are included — direct bookings are excluded. Required because the report is partner-attribution-driven and would otherwise return an empty file.

site_idstring

Filter the export to one or more Site IDs. Accepts a single ID or a comma-separated list. When omitted, orders across every site the authenticated user has access to are included.

customer_idstring uuid

Filter the export to a single customer.

statusstring

Example:submitted,settled

Filter the export by basket status. Accepts a single value or a comma-separated list. Defaults to new, submitted and settled.

querystring

A free-text search across the order reference, external reference, customer name and email, and the names of items in the order. When set, results are ordered by relevance.

submitted_at_fromstring date-time

The earliest submitted_at date and time to include in the export (inclusive).

submitted_at_tostring date-time

The latest submitted_at date and time to include in the export (inclusive).

item_date_fromstring date

Include orders that contain at least one item dated on or after this date.

item_date_tostring date

Include orders that contain at least one item dated on or before this date.

revenue_date_fromstring date

The earliest revenue_date to include in the export (inclusive).

revenue_date_tostring date

The latest revenue_date to include in the export (inclusive).

labelsstring

Filter by basket labels. Accepts a comma-separated list of label IDs; prefix an ID with - to exclude orders with that label, or pass none to match only orders with no labels at all.

external_idstring

Filter by an external ID in the form key:value (for example, pms:RES-12345).

Response

The partner orders report was successfully generated.

Changes

No recorded changes to this endpoint across all 1 revision of this API.