Shopify Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » Shopify Connector » EndPoints > Get Payouts

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]

Parameters

Parameter Label Required Options Description
date Date (format: yyyy-MM-ddd) NO
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
Filter the response to payouts made on the specified date.
date_max Date maximum (format: yyyy-MM-ddd) NO
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
Filter the response to payouts made inclusively before the specified date.
date_min Date minimum(format: yyyy-MM-ddd) NO
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
Filter the response to payouts made inclusively after the specified date.
last_id Payouts before this Id NO Filter the response to payouts made before the specified ID.
since_id Payouts after this Id NO Filter the response to payouts made after the specified ID.
status Status NO
Option Value
scheduled scheduled
in_transit in_transit
paid paid
failed failed
canceled canceled
Filter the response to payouts made with the specified status.
limit Page Size NO The maximum number of records to show.

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.