Sign in
Reports

List payouts for a site

Use this endpoint to retrieve a list of payouts for a site.

get/shop/reports/payouts

Query parameters

site_idstring uuid

Filter the list of payouts by site.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

status'not_started' | 'processing' | 'processed' | 'failed'

Filter for payouts with a specific status.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The list of Payout resources was successfully retrieved.

Example response

{
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes