Shopify Payouts API

The Payouts API from Shopify — 6 operation(s) for payouts.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-payouts-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Payouts API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Payouts
paths:
  /admin/api/2020-01/shopify_payments/payouts.json:
    get:
      summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-01
      parameters:
      - in: query
        name: since_id
        description: Filter the response to payouts made after the specified ID.
        schema: {}
        required: false
      - in: query
        name: last_id
        description: Filter the response to payouts made before the specified ID.
        schema: {}
        required: false
      - in: query
        name: date_min
        description: Filter the response to payouts made inclusively after the specified date.
        schema: {}
        required: false
      - in: query
        name: date_max
        description: Filter the response to payouts made inclusively before the specified date.
        schema: {}
        required: false
      - in: query
        name: date
        description: Filter the response to payouts made on the specified date.
        schema: {}
        required: false
      - in: query
        name: status
        description: Filter the response to payouts made with the specified status.
        schema: {}
        required: false
      tags:
      - Payouts
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_shopify_payments_payouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/shopify_payments/payouts.json:
    get:
      summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-04
      parameters:
      - in: query
        name: since_id
        description: Filter the response to payouts made after the specified ID.
        schema: {}
        required: false
      - in: query
        name: last_id
        description: Filter the response to payouts made before the specified ID.
        schema: {}
        required: false
      - in: query
        name: date_min
        description: Filter the response to payouts made inclusively after the specified date.
        schema: {}
        required: false
      - in: query
        name: date_max
        description: Filter the response to payouts made inclusively before the specified date.
        schema: {}
        required: false
      - in: query
        name: date
        description: Filter the response to payouts made on the specified date.
        schema: {}
        required: false
      - in: query
        name: status
        description: Filter the response to payouts made with the specified status.
        schema: {}
        required: false
      tags:
      - Payouts
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_shopify_payments_payouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/shopify_payments/payouts.json:
    get:
      summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-07
      parameters:
      - in: query
        name: since_id
        description: Filter the response to payouts made after the specified ID.
        schema: {}
        required: false
      - in: query
        name: last_id
        description: Filter the response to payouts made before the specified ID.
        schema: {}
        required: false
      - in: query
        name: date_min
        description: Filter the response to payouts made inclusively after the specified date.
        schema: {}
        required: false
      - in: query
        name: date_max
        description: Filter the response to payouts made inclusively before the specified date.
        schema: {}
        required: false
      - in: query
        name: date
        description: Filter the response to payouts made on the specified date.
        schema: {}
        required: false
      - in: query
        name: status
        description: Filter the response to payouts made with the specified status.
        schema: {}
        required: false
      tags:
      - Payouts
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_shopify_payments_payouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/shopify_payments/payouts.json:
    get:
      summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-10
      parameters:
      - in: query
        name: since_id
        description: Filter the response to payouts made after the specified ID.
        schema: {}
        required: false
      - in: query
        name: last_id
        description: Filter the response to payouts made before the specified ID.
        schema: {}
        required: false
      - in: query
        name: date_min
        description: Filter the response to payouts made inclusively after the specified date.
        schema: {}
        required: false
      - in: query
        name: date_max
        description: Filter the response to payouts made inclusively before the specified date.
        schema: {}
        required: false
      - in: query
        name: date
        description: Filter the response to payouts made on the specified date.
        schema: {}
        required: false
      - in: query
        name: status
        description: Filter the response to payouts made with the specified status.
        schema: {}
        required: false
      tags:
      - Payouts
      responses:
        '200':
          description: ''
      operationId: get_shopify_payments_payouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/shopify_payments/payouts.json:
    get:
      summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2021-01
      parameters:
      - in: query
        name: since_id
        description: Filter the response to payouts made after the specified ID.
        schema: {}
        required: false
      - in: query
        name: last_id
        description: Filter the response to payouts made before the specified ID.
        schema: {}
        required: false
      - in: query
        name: date_min
        description: Filter the response to payouts made inclusively after the specified date.
        schema: {}
        required: false
      - in: query
        name: date_max
        description: Filter the response to payouts made inclusively before the specified date.
        schema: {}
        required: false
      - in: query
        name: date
        description: Filter the response to payouts made on the specified date.
        schema: {}
        required: false
      - in: query
        name: status
        description: Filter the response to payouts made with the specified status.
        schema: {}
        required: false
      tags:
      - Payouts
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_shopify_payments_payouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/shopify_payments/payouts.json:
    get:
      summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-unstable
      parameters:
      - in: query
        name: since_id
        description: Filter the response to payouts made after the specified ID.
        schema: {}
        required: false
      - in: query
        name: last_id
        description: Filter the response to payouts made before the specified ID.
        schema: {}
        required: false
      - in: query
        name: date_min
        description: Filter the response to payouts made inclusively after the specified date.
        schema: {}
        required: false
      - in: query
        name: date_max
        description: Filter the response to payouts made inclusively before the specified date.
        schema: {}
        required: false
      - in: query
        name: date
        description: Filter the response to payouts made on the specified date.
        schema: {}
        required: false
      - in: query
        name: status
        description: Filter the response to payouts made with the specified status.
        schema: {}
        required: false
      tags:
      - Payouts
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_shopify_payments_payouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth