Shopify Applications API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Applications 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: Applications
paths:
  /admin/api/2020-01/reports/{report_id}.json:
    get:
      summary: Shopify Retrieves A Single Report Created By Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-01
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
        description: report_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/reports/{report_id}.json:
    get:
      summary: Shopify Retrieves A Single Report Created By Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-04
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
        description: report_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/reports/{report_id}.json:
    get:
      summary: Shopify Retrieves A Single Report Created By Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-07
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
        description: report_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/reports/{report_id}.json:
    get:
      summary: Shopify Retrieves A Single Report Created By Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-10
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
        description: report_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/reports/{report_id}.json:
    get:
      summary: Shopify Retrieves A Single Report Created By Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2021-01
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
        description: report_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/reports/{report_id}.json:
    get:
      summary: Shopify Retrieves A Single Report Created By Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-unstable
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
        description: report_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/application_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                summary: Create an application charge
              example2:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                    test: true
                summary: Create a test charge that will not cause a credit card to be charged
              example3:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 0.4
                    return_url: http://super-duper.shopifyapps.com
                summary: Trying to create a charge with a price less than 0.50 will return an error
              example4:
                value:
                  application_charge:
                    name: ''
                summary: Trying to create a charge without a price or name will return an error
      summary: Shopify Creates An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-01
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-01
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/application_charges/{application_charge_id}.json:
    get:
      summary: Shopify Retrieves An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-01
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_application_charges_param_application_charge_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                summary: Create an application charge
              example2:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                    test: true
                summary: Create a test charge that will not cause a credit card to be charged
              example3:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 0.4
                    return_url: http://super-duper.shopifyapps.com
                summary: Trying to create a charge with a price less than 0.50 will return an error
              example4:
                value:
                  application_charge:
                    name: ''
                summary: Trying to create a charge without a price or name will return an error
      summary: Shopify Creates An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-04
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-04
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_charges/{application_charge_id}.json:
    get:
      summary: Shopify Retrieves An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-04
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_application_charges_param_application_charge_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/application_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                summary: Create an application charge
              example2:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                    test: true
                summary: Create a test charge that will not cause a credit card to be charged
              example3:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 0.4
                    return_url: http://super-duper.shopifyapps.com
                summary: Trying to create a charge with a price less than 0.50 will return an error
              example4:
                value:
                  application_charge:
                    name: ''
                summary: Trying to create a charge without a price or name will return an error
      summary: Shopify Creates An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-07
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-07
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/application_charges/{application_charge_id}.json:
    get:
      summary: Shopify Retrieves An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-07
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_application_charges_param_application_charge_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/application_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                summary: Create an application charge
              example2:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                    test: true
                summary: Create a test charge that will not cause a credit card to be charged
              example3:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 0.4
                    return_url: http://super-duper.shopifyapps.com
                summary: Trying to create a charge with a price less than 0.50 will return an error
              example4:
                value:
                  application_charge:
                    name: ''
                summary: Trying to create a charge without a price or name will return an error
      summary: Shopify Creates An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-10
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: create_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-10
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/application_charges/{application_charge_id}.json:
    get:
      summary: Shopify Retrieves An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-10
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: get_application_charges_param_application_charge_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/application_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                summary: Create an application charge
              example2:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                    test: true
                summary: Create a test charge that will not cause a credit card to be charged
              example3:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 0.4
                    return_url: http://super-duper.shopifyapps.com
                summary: Trying to create a charge with a price less than 0.50 will return an error
              example4:
                value:
                  application_charge:
                    name: ''
                summary: Trying to create a charge without a price or name will return an error
      summary: Shopify Creates An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2021-01
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2021-01
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/application_charges/{application_charge_id}.json:
    get:
      summary: Shopify Retrieves An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2021-01
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_application_charges_param_application_charge_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/application_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                summary: Create an application charge
              example2:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 100
                    return_url: http://super-duper.shopifyapps.com
                    test: true
                summary: Create a test charge that will not cause a credit card to be charged
              example3:
                value:
                  application_charge:
                    name: Super Duper Expensive action
                    price: 0.4
                    return_url: http://super-duper.shopifyapps.com
                summary: Trying to create a charge with a price less than 0.50 will return an error
              example4:
                value:
                  application_charge:
                    name: ''
                summary: Trying to create a charge without a price or name will return an error
      summary: Shopify Creates An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-unstable
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-unstable
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/application_charges/{application_charge_id}.json:
    get:
      summary: Shopify Retrieves An Application Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-unstable
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_application_charges_param_application_charge_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-01
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves All Application Credits
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-01
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-01
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-04
      parameters: []
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves All Application Credits
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-04
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Applications
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-04
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
   

# --- truncated at 32 KB (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-applications-api-openapi.yml