GET /admin/api/{api_version}/shopify_payments/payouts.json
Retrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-shopify-access-token |
String | No |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
date_min |
String | No |
Filter response to payouts inclusively after the specified date. |
last_id |
String | No |
Filter response to payouts exclusively before the specified ID |
date_max |
String | No |
Filter response to payouts inclusively before the specified date. |
since_id |
String | No |
Filter response to payouts exclusively after the specified ID. |
status |
String | No |
Filter response to payouts with the specified status |
date |
String | No |
Filter response to payouts on the specified date. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.