Shopify Configuration API

The Configuration API from Shopify — 6 operation(s) for configuration.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-configuration-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Configuration 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: Configuration
paths:
  /admin/api/2020-01/shop.json:
    get:
      summary: Shopify Retrieves The Shop's Configuration
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-01
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Configuration
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_shop
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/shop.json:
    get:
      summary: Shopify Retrieves The Shop's Configuration
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-04
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Configuration
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_shop
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/shop.json:
    get:
      summary: Shopify Retrieves The Shop's Configuration
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-07
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Configuration
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_shop
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/shop.json:
    get:
      summary: Shopify Retrieves The Shop's Configuration
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-10
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Configuration
      responses:
        '200':
          description: ''
      operationId: get_shop
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/shop.json:
    get:
      summary: Shopify Retrieves The Shop's Configuration
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2021-01
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Configuration
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_shop
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/shop.json:
    get:
      summary: Shopify Retrieves The Shop's Configuration
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-unstable
      parameters:
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Configuration
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_shop
      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