Export Payouts from Shopify
This task will export a list of payouts from Shopify Payments, and save them to an XML file.
Important
This task uses Shopify's REST API, which is now deprecated. We recommend migrating to the equivalent GraphQL API task. See here for more information.
Note
This task will only work if you are using Shopify Payments as the payment gateway for your store, and you have enabled the 'read_shopify_payments_payouts' scope within the private app you created as part of the connection setup process.
Settings
Connection
Required
The Shopify connection to use. See Shopify Connection if you require more information on how to create/manage connections.
Export Settings > Export New or All Records
Required
Choose from one of the following options:
- New - The task will only export payouts where the ID is higher that the one shown in the Since ID setting.
- All - The task will export any payout
Export Settings > Since ID
Required
When the task is set to export new records, only records where the ID is greater than what's shown here will be exported.
Export Transactions
Required
Set to 'True' to export the Shopify Payments transactions associated with each payout. This provides the list of transactions that were paid by each payout.
Page Size
Required
Used to control the number of records that are exported per page. Defaults to 100
.
Payout Status
Required
Used to filter the payouts that will be exported by the task, based on payout status. Set to Any
to export any payouts regardless of it's status, or choose a specific status to filter on:
- Scheduled - Payouts that have been created and had transactions assigned to them, but have not yet been submitted to the bank.
- In Transit - Payouts submitted to the bank for processing.
- Paid - Payouts successfully deposited into the bank.
- Failed - Payouts declined by the bank.
- Canceled - Payouts canceled by Shopify.
Note
This setting only takes effect when the Export New or All Records setting is set to 'All'. When it's set to 'New', the task will always return payouts at any status.
Record IDs
Required
To export specific records from Shopify, enter an ID or comma separated list of IDs. This will override all other export settings.
Timeout
Optional
The length of time to wait (in seconds) for Shopify to respond to each API request. If left blank, or set to 0 or less, a default value of 100 seconds will be applied.
Output File
Required
The XML file to save the list of payouts to.
Zynk Settings
See Common Task Settings.
Permissions
This task requires the following permissions in your Shopify app:
- read_shopify_payments_payouts
Examples
Sample output file:
<?xml version="1.0" encoding="utf-8"?>
<payouts type="array" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<payout>
<id>88744400000</id>
<status>in_transit</status>
<date>2022-04-22T00:00:00</date>
<currency>GBP</currency>
<amount>244.26</amount>
<summary>
<adjustments-fee-amount>0.00</adjustments-fee-amount>
<adjustments-gross-amount>0.00</adjustments-gross-amount>
<charges-fee-amount>5.14</charges-fee-amount>
<charges-gross-amount>249.40</charges-gross-amount>
<refunds-fee-amount>0.00</refunds-fee-amount>
<refunds-gross-amount>0.00</refunds-gross-amount>
<reserved-funds-fee-amount>0.00</reserved-funds-fee-amount>
<reserved-funds-gross-amount>0.00</reserved-funds-gross-amount>
<retried-payouts-fee_amount>0.00</retried-payouts-fee-amount>
<retried-payouts-gross-amount>0.00</retried-payouts-gross-amount>
</summary>
<transactions>
<transaction>
<id>1915272476091</id>
<type>payout</type>
<test>false</test>
<payout-id>88744400000</payout-id>
<payout-status>in_transit</payout-status>
<currency>GBP</currency>
<amount>-244.26</amount>
<fee>0.00</fee>
<net>-244.26</net>
<source-id>88744400000</source-id>
<source-type>payout</source-type>
<source-order-transaction-id xsi:nil="true" />
<source-order-id xsi:nil="true" />
<processed-at>2022-04-20T05:41:12+01:00</processed-at>
</transaction>
<transaction>
<id>1915101346939</id>
<type>charge</type>
<test>false</test>
<payout-id>88744400000</payout-id>
<payout-status>in_transit</payout-status>
<currency>GBP</currency>
<amount>5.90</amount>
<fee>0.31</fee>
<net>5.59</net>
<source-id>2083780364283</source-id>
<source-type>charge</source-type>
<source-order-id>4727609131259</source-order-id>
<source-order-transaction-id>5542146375231</source-order-transaction-id>
<processed-at>2022-04-19T18:57:50+01:00</processed-at>
</transaction>
<transaction>
<id>1915017069947</id>
<type>charge</type>
<test>false</test>
<payout-id>88744400000</payout-id>
<payout-status>in_transit</payout-status>
<currency>GBP</currency>
<amount>243.50</amount>
<fee>4.83</fee>
<net>238.67</net>
<source-id>2083635098555</source-id>
<source-type>charge</source-type>
<source-order-id>4727276568827</source-order-id>
<source-order-transaction-id>5541794175291</source-order-transaction-id>
<processed-at>2022-04-19T15:25:08+01:00</processed-at>
</transaction>
</transactions>
</payout>
</payouts>