Skip to main content
Anchor to PayoutSortKeys

PayoutSortKeys

enum

The set of valid sort keys for the Payout query.

Anchor to Valid valuesValid values

Anchor to ADJUSTMENT_GROSSADJUSTMENT_GROSS

Sort by the adjustment_gross value.

Anchor to ADVANCE_GROSSADVANCE_GROSS

Sort by the advance_gross value.

Anchor to AMOUNTAMOUNT

Sort by the amount value.

Anchor to CHARGE_GROSSCHARGE_GROSS

Sort by the charge_gross value.

Anchor to DUTIES_GROSSDUTIES_GROSS

Sort by the duties_gross value.

Anchor to FEE_AMOUNTFEE_AMOUNT

Sort by the fee_amount value.

Anchor to IDID

Sort by the id value.

Anchor to ISSUED_ATISSUED_AT

Sort by the issued_at value.

Anchor to REFUND_GROSSREFUND_GROSS

Sort by the refund_gross value.

Anchor to RELEVANCERELEVANCE

Sort by relevance to the search terms when the query parameter is specified on the connection. Don't use this sort key when no search query is specified.

Anchor to SHIPPING_LABEL_GROSSSHIPPING_LABEL_GROSS

Sort by the shipping_label_gross value.

Anchor to STATUSSTATUS

Sort by the status value.

Was this section helpful?

Anchor to FieldsFields

Anchor to ShopifyPaymentsAccount.payoutsShopifyPaymentsAccount.payouts
•ARGUMENT

Balance and payout information for a Shopify Payments account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field.

Anchor to ShopifyPaymentsBankAccount.payoutsShopifyPaymentsBankAccount.payouts
•ARGUMENT

A bank account that can receive payouts.

Was this section helpful?