Sign in
Reports

Queue an export of the charges list

Queues a CSV export of the charges list to be generated asynchronously.

get/shop/reports/charge-list/queue

Query parameters

site_idstring uuid

Restrict the report to charges at the given site.

completed_fromstring date-time

Restrict to charges completed on or after this time.

completed_tostring date-time

Restrict to charges completed on or before this time.

created_fromstring date-time

Restrict to charges created on or after this time.

created_tostring date-time

Restrict to charges created on or before this time.

revenue_date_fromstring date

Restrict to charges with a revenue date on or after this date.

revenue_date_tostring date

Restrict to charges with a revenue date on or before this date.

payout_date_fromstring date

Restrict to charges with a payout date on or after this date.

payout_date_tostring date

Restrict to charges with a payout date on or before this date.

statusstring
Example:complete

The charge status to include. Defaults to complete for the main charge list and to all for the pay-by-link variant.

chargeable_typestring

Filter to charges against a specific chargeable type (e.g. order, membership).

charge_typestring

Filter to a particular charge type (e.g. payment, refund).

processorstring

Filter to charges that went through a specific payment processor (e.g. adyen, stripe, cash).

details_sourcestring

Filter to charges where the payment details came from a specific source (e.g. pay_by_link).

order_statusstring

Filter to charges whose parent order has a specific status.

created_bystring object-id

Filter to charges created by a specific user ID.

emailboolean

If true, email the completed CSV to the authenticated user when the background job finishes. Defaults to false, in which case the queued job's output URL must be polled via the queued-jobs endpoint.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

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