Reference

Endpoint Get Payouts

Name

get_payouts

Description

Retrieves a list of all payouts ordered by payout date, with the most recent being first. Requires following permissions shopify_payments_payouts, shopify_payments for API Token. [API reference]

Related Tables

Payouts

Parameters

Parameter Required Options
Name: date

Label: Date (format: yyyy-MM-ddd)

Filter the response to payouts made on the specified date.
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Name: date_max

Label: Date maximum (format: yyyy-MM-ddd)

Filter the response to payouts made inclusively before the specified date.
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Name: date_min

Label: Date minimum(format: yyyy-MM-ddd)

Filter the response to payouts made inclusively after the specified date.
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Name: last_id

Label: Payouts before this Id

Filter the response to payouts made before the specified ID.
Name: since_id

Label: Payouts after this Id

Filter the response to payouts made after the specified ID.
Name: status

Label: Status

Filter the response to payouts made with the specified status.
Option Value
scheduled scheduled
in_transit in_transit
paid paid
failed failed
canceled canceled
Name: limit

Label: Page Size

The maximum number of records to show.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_I8 bigint
Status DT_WSTR nvarchar(4000) 4000
Date DT_DBTIMESTAMP datetime
Currency DT_WSTR nvarchar(4000) 4000
Amount DT_WSTR nvarchar(4000) 4000
If the column you are looking for is missing, consider customizing Shopify Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Shopify Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Payouts table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Shopify
Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.
Shopify
Payouts
Optional Parameters
Date (format: yyyy-MM-ddd)
Date maximum (format: yyyy-MM-ddd)
Date minimum(format: yyyy-MM-ddd)
Payouts before this Id
Payouts after this Id
Status
ContineOn404Error True
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Payouts table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get payouts:

API Destination - Shopify
Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.
Shopify
Payouts
Select
Optional Parameters
Date (format: yyyy-MM-ddd)
Date maximum (format: yyyy-MM-ddd)
Date minimum(format: yyyy-MM-ddd)
Payouts before this Id
Payouts after this Id
Status
ContineOn404Error True
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get Payouts 

SELECT * FROM Payouts

get_payouts endpoint belongs to Payouts table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get Payouts 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Payouts';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

get_payouts endpoint belongs to Payouts table(s), and can therefore be used via those table(s).