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
Parameters
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
|---|---|---|---|---|---|
| Id |
DT_I8
|
bigint
|
False |
||
| Status |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
| Date |
DT_DBTIMESTAMP
|
datetime
|
False |
||
| Currency |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
| Amount |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | 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 component to read data or in API Destination component to read/write data:
Read from Payouts table using API Destination
This Endpoint belongs to Payouts table, therefore you cannot work with it directly. Use this table and table-operation pair instead:
ODBC application
Use these SQL queries in your ODBC application data source:
Get payouts
SELECT * FROM get_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 get_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).