Shopify Admin REST API

The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. It provides access to products, customers, orders, inventory, fulfillments, and webhooks for managing all aspects of a Shopify store.

Documentation

Specifications

Examples

Schemas & Data

Other Resources

OpenAPI Specification

shopify-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Shopify  API
  description: >-
    Explore Shopify's API reference and templating documentation. Shopify
    provides a range of software tools, app templates, example apps, and
    libraries to accelerate your development process. The Admin API lets you
    build apps and integrations that extend and enhance the Shopify admin.
  version: 2020-10
paths:
  /admin/oauth/access_scopes.json:
    get:
      summary: Shopify Retrieves A List Of Access Scopes Associated To The Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/accessscope#index-2020-10
      parameters: []
      tags:
        - Access
        - Associated
        - Lists
        - Scopes
        - Tokens
      responses:
        '200':
          description: ''
      operationId: get_admin_oauth_access_scopes
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/storefront_access_tokens.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  storefront_access_token:
                    title: Test
                summary: Create a new storefront access token
              example2:
                value:
                  storefront_access_token:
                    title: Test
                summary: >-
                  Generating a token for an app that lacks required
                  unauthenticated scopes fails
              example3:
                value:
                  storefront_access_token:
                    title: Token
                summary: Creating a token after exceeding the limit fails
      summary: Shopify Creates A New Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-01
      parameters: []
      tags:
        - Access
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-01
      parameters: []
      tags:
        - Access
        - Have
        - Issued
        - Lists
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/storefront_access_tokens/{storefront_access_token_id}.json:
    delete:
      summary: Shopify Deletes An Existing Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-01
      parameters:
        - in: path
          name: storefront_access_token_id
          required: true
          schema:
            type: string
          description: storefront_access_token_id
      tags:
        - Access
        - Existing
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: >-
        deprecated_202001_delete_storefront_access_tokens_param_storefront_access_token_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/storefront_access_tokens.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  storefront_access_token:
                    title: Test
                summary: Create a new storefront access token
              example2:
                value:
                  storefront_access_token:
                    title: Test
                summary: >-
                  Generating a token for an app that lacks required
                  unauthenticated scopes fails
              example3:
                value:
                  storefront_access_token:
                    title: Token
                summary: Creating a token after exceeding the limit fails
      summary: Shopify Creates A New Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-04
      parameters: []
      tags:
        - Access
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-04
      parameters: []
      tags:
        - Access
        - Have
        - Issued
        - Lists
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/storefront_access_tokens/{storefront_access_token_id}.json:
    delete:
      summary: Shopify Deletes An Existing Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-04
      parameters:
        - in: path
          name: storefront_access_token_id
          required: true
          schema:
            type: string
          description: storefront_access_token_id
      tags:
        - Access
        - Existing
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: >-
        deprecated_202004_delete_storefront_access_tokens_param_storefront_access_token_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/storefront_access_tokens.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  storefront_access_token:
                    title: Test
                summary: Create a new storefront access token
              example2:
                value:
                  storefront_access_token:
                    title: Test
                summary: >-
                  Generating a token for an app that lacks required
                  unauthenticated scopes fails
              example3:
                value:
                  storefront_access_token:
                    title: Token
                summary: Creating a token after exceeding the limit fails
      summary: Shopify Creates A New Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-07
      parameters: []
      tags:
        - Access
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-07
      parameters: []
      tags:
        - Access
        - Have
        - Issued
        - Lists
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/storefront_access_tokens/{storefront_access_token_id}.json:
    delete:
      summary: Shopify Deletes An Existing Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-07
      parameters:
        - in: path
          name: storefront_access_token_id
          required: true
          schema:
            type: string
          description: storefront_access_token_id
      tags:
        - Access
        - Existing
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: >-
        deprecated_202007_delete_storefront_access_tokens_param_storefront_access_token_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/storefront_access_tokens.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  storefront_access_token:
                    title: Test
                summary: Create a new storefront access token
              example2:
                value:
                  storefront_access_token:
                    title: Test
                summary: >-
                  Generating a token for an app that lacks required
                  unauthenticated scopes fails
              example3:
                value:
                  storefront_access_token:
                    title: Token
                summary: Creating a token after exceeding the limit fails
      summary: Shopify Creates A New Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-10
      parameters: []
      tags:
        - Access
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: create_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-10
      parameters: []
      tags:
        - Access
        - Have
        - Issued
        - Lists
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: get_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/storefront_access_tokens/{storefront_access_token_id}.json:
    delete:
      summary: Shopify Deletes An Existing Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-10
      parameters:
        - in: path
          name: storefront_access_token_id
          required: true
          schema:
            type: string
          description: storefront_access_token_id
      tags:
        - Access
        - Existing
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: delete_storefront_access_tokens_param_storefront_access_token_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/storefront_access_tokens.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  storefront_access_token:
                    title: Test
                summary: Create a new storefront access token
              example2:
                value:
                  storefront_access_token:
                    title: Test
                summary: >-
                  Generating a token for an app that lacks required
                  unauthenticated scopes fails
              example3:
                value:
                  storefront_access_token:
                    title: Token
                summary: Creating a token after exceeding the limit fails
      summary: Shopify Creates A New Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2021-01
      parameters: []
      tags:
        - Access
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2021-01
      parameters: []
      tags:
        - Access
        - Have
        - Issued
        - Lists
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/storefront_access_tokens/{storefront_access_token_id}.json:
    delete:
      summary: Shopify Deletes An Existing Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2021-01
      parameters:
        - in: path
          name: storefront_access_token_id
          required: true
          schema:
            type: string
          description: storefront_access_token_id
      tags:
        - Access
        - Existing
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: >-
        deprecated_202101_delete_storefront_access_tokens_param_storefront_access_token_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/storefront_access_tokens.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  storefront_access_token:
                    title: Test
                summary: Create a new storefront access token
              example2:
                value:
                  storefront_access_token:
                    title: Test
                summary: >-
                  Generating a token for an app that lacks required
                  unauthenticated scopes fails
              example3:
                value:
                  storefront_access_token:
                    title: Token
                summary: Creating a token after exceeding the limit fails
      summary: Shopify Creates A New Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-unstable
      parameters: []
      tags:
        - Access
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-unstable
      parameters: []
      tags:
        - Access
        - Have
        - Issued
        - Lists
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_storefront_access_tokens
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/storefront_access_tokens/{storefront_access_token_id}.json:
    delete:
      summary: Shopify Deletes An Existing Storefront Access Token
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-unstable
      parameters:
        - in: path
          name: storefront_access_token_id
          required: true
          schema:
            type: string
          description: storefront_access_token_id
      tags:
        - Access
        - Existing
        - Storefront
        - Tokens
      responses:
        '200':
          description: ''
      operationId: >-
        deprecated_unstable_delete_storefront_access_tokens_param_storefront_access_token_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/reports.json:
    get:
      summary: Shopify Retrieves A List Of Reports
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#index-2020-01
      parameters:
        - in: query
          name: ids
          description: A comma-separated list of report IDs.
          schema: {}
          required: false
        - in: query
          name: limit
          description: |-
            The amount of results to return.
                              (default: 50, maximum: 250)
          schema: {}
          required: false
        - in: query
          name: since_id
          description: Restrict results to after the specified ID.
          schema: {}
          required: false
        - in: query
          name: updated_at_min
          description: >-
            Show reports last updated after date. (format:
            2014-04-25T16:15:47-04:00)
          schema: {}
          required: false
        - in: query
          name: updated_at_max
          description: >-
            Show reports last updated before date. (format:
            2014-04-25T16:15:47-04:00)
          schema: {}
          required: false
        - in: query
          name: fields
          description: A comma-separated list of fields to include in the response.
          schema: {}
          required: false
      tags:
        - Lists
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_reports
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  report:
                    name: A new app report
                    shopify_ql: >-
                      SHOW total_sales BY order_id FROM sales SINCE -1m UNTIL
                      today ORDER BY total_sales
                summary: Create a new report
      summary: Shopify Creates A New Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-01
      parameters:
        - in: query
          name: name
          description: 'The name of the report. Maximum length: 255 characters.'
          schema: {}
          required: false
        - in: query
          name: shopify_ql
          description: The ShopifyQL the report will query.
          schema: {}
          required: false
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_reports
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /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
        - Reports
        - Single
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  report:
                    id: 517154478
                    name: Changed Report Name
                    shopify_ql: >-
                      SHOW total_sales BY order_id FROM sales SINCE -12m UNTIL
                      today ORDER BY total_sales
                summary: Update an existing report
      summary: Shopify Updates A Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-01
      parameters:
        - in: path
          name: report_id
          required: true
          schema:
            type: string
          description: report_id
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-01
      parameters:
        - in: path
          name: report_id
          required: true
          schema:
            type: string
          description: report_id
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/reports.json:
    get:
      summary: Shopify Retrieves A List Of Reports
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#index-2020-04
      parameters:
        - in: query
          name: ids
          description: A comma-separated list of report IDs.
          schema: {}
          required: false
        - in: query
          name: limit
          description: |-
            The amount of results to return.
                              (default: 50, maximum: 250)
          schema: {}
          required: false
        - in: query
          name: since_id
          description: Restrict results to after the specified ID.
          schema: {}
          required: false
        - in: query
          name: updated_at_min
          description: >-
            Show reports last updated after date. (format:
            2014-04-25T16:15:47-04:00)
          schema: {}
          required: false
        - in: query
          name: updated_at_max
          description: >-
            Show reports last updated before date. (format:
            2014-04-25T16:15:47-04:00)
          schema: {}
          required: false
        - in: query
          name: fields
          description: A comma-separated list of fields to include in the response.
          schema: {}
          required: false
      tags:
        - Lists
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_reports
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  report:
                    name: A new app report
                    shopify_ql: >-
                      SHOW total_sales BY order_id FROM sales SINCE -1m UNTIL
                      today ORDER BY total_sales
                summary: Create a new report
      summary: Shopify Creates A New Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-04
      parameters:
        - in: query
          name: name
          description: 'The name of the report. Maximum length: 255 characters.'
          schema: {}
          required: false
        - in: query
          name: shopify_ql
          description: The ShopifyQL the report will query.
          schema: {}
          required: false
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_reports
      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
        - Reports
        - Single
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  report:
                    id: 517154478
                    name: Changed Report Name
                    shopify_ql: >-
                      SHOW total_sales BY order_id FROM sales SINCE -12m UNTIL
                      today ORDER BY total_sales
                summary: Update an existing report
      summary: Shopify Updates A Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-04
      parameters:
        - in: path
          name: report_id
          required: true
          schema:
            type: string
          description: report_id
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-04
      parameters:
        - in: path
          name: report_id
          required: true
          schema:
            type: string
          description: report_id
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/reports.json:
    get:
      summary: Shopify Retrieves A List Of Reports
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#index-2020-07
      parameters:
        - in: query
          name: ids
          description: A comma-separated list of report IDs.
          schema: {}
          required: false
        - in: query
          name: limit
          description: |-
            The amount of results to return.
                              (default: 50, maximum: 250)
          schema: {}
          required: false
        - in: query
          name: since_id
          description: Restrict results to after the specified ID.
          schema: {}
          required: false
        - in: query
          name: updated_at_min
          description: >-
            Show reports last updated after date. (format:
            2014-04-25T16:15:47-04:00)
          schema: {}
          required: false
        - in: query
          name: updated_at_max
          description: >-
            Show reports last updated before date. (format:
            2014-04-25T16:15:47-04:00)
          schema: {}
          required: false
        - in: query
          name: fields
          description: A comma-separated list of fields to include in the response.
          schema: {}
          required: false
      tags:
        - Lists
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_reports
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  report:
                    name: A new app report
                    shopify_ql: >-
                      SHOW total_sales BY order_id FROM sales SINCE -1m UNTIL
                      today ORDER BY total_sales
                summary: Create a new report
      summary: Shopify Creates A New Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-07
      parameters:
        - in: query
          name: name
          description: 'The name of the report. Maximum length: 255 characters.'
          schema: {}
          required: false
        - in: query
          name: shopify_ql
          description: The ShopifyQL the report will query.
          schema: {}
          required: false
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_reports
      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
        - Reports
        - Single
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  report:
                    id: 517154478
                    name: Changed Report Name
                    shopify_ql: >-
                      SHOW total_sales BY order_id FROM sales SINCE -12m UNTIL
                      today ORDER BY total_sales
                summary: Update an existing report
      summary: Shopify Updates A Report
      description: >-
        https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-07
      parameters:
        - in: path
          name: report_id
          required: true
          schema:
            type: string
          description: report_id
      tags:
        - Reports
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_reports_param_report_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTa

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