Shopify Resource API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Resource 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: Resource
paths:
  /admin/api/2020-01/metafields.json:
    get:
      summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-01
      parameters:
      - in: query
        name: metafield[owner_id]
        schema:
          type: integer
        description: metafield[owner_id]
        required: false
      - in: query
        name: metafield[owner_resource]
        schema:
          type: string
        description: metafield[owner_resource]
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Shop resource
              example2:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Product resource
              example3:
                value:
                  metafield:
                    key: null
                summary: Creating a metafield without a key will fail and return an error
      summary: Shopify Creates A New Metafield For A Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-01
      parameters: []
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/metafields/{metafield_id}.json:
    get:
      summary: Shopify Retrieves A Single Metafield From A Resource By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-01
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/metafields.json:
    get:
      summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-04
      parameters:
      - in: query
        name: metafield[owner_id]
        schema:
          type: integer
        description: metafield[owner_id]
        required: false
      - in: query
        name: metafield[owner_resource]
        schema:
          type: string
        description: metafield[owner_resource]
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Shop resource
              example2:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Product resource
              example3:
                value:
                  metafield:
                    key: null
                summary: Creating a metafield without a key will fail and return an error
      summary: Shopify Creates A New Metafield For A Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-04
      parameters: []
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/metafields/{metafield_id}.json:
    get:
      summary: Shopify Retrieves A Single Metafield From A Resource By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-04
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/metafields.json:
    get:
      summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-07
      parameters:
      - in: query
        name: metafield[owner_id]
        schema:
          type: integer
        description: metafield[owner_id]
        required: false
      - in: query
        name: metafield[owner_resource]
        schema:
          type: string
        description: metafield[owner_resource]
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Shop resource
              example2:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Product resource
              example3:
                value:
                  metafield:
                    key: null
                summary: Creating a metafield without a key will fail and return an error
      summary: Shopify Creates A New Metafield For A Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-07
      parameters: []
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/metafields/{metafield_id}.json:
    get:
      summary: Shopify Retrieves A Single Metafield From A Resource By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-07
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/metafields.json:
    get:
      summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-10
      parameters:
      - in: query
        name: metafield[owner_id]
        schema:
          type: integer
        description: metafield[owner_id]
        required: false
      - in: query
        name: metafield[owner_resource]
        schema:
          type: string
        description: metafield[owner_resource]
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: get_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Shop resource
              example2:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Product resource
              example3:
                value:
                  metafield:
                    key: null
                summary: Creating a metafield without a key will fail and return an error
      summary: Shopify Creates A New Metafield For A Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-10
      parameters: []
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: create_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/metafields/{metafield_id}.json:
    get:
      summary: Shopify Retrieves A Single Metafield From A Resource By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-10
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: get_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/metafields.json:
    get:
      summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2021-01
      parameters:
      - in: query
        name: metafield[owner_id]
        schema:
          type: integer
        description: metafield[owner_id]
        required: false
      - in: query
        name: metafield[owner_resource]
        schema:
          type: string
        description: metafield[owner_resource]
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Shop resource
              example2:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Product resource
              example3:
                value:
                  metafield:
                    key: null
                summary: Creating a metafield without a key will fail and return an error
      summary: Shopify Creates A New Metafield For A Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2021-01
      parameters: []
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/metafields/{metafield_id}.json:
    get:
      summary: Shopify Retrieves A Single Metafield From A Resource By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2021-01
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/metafields.json:
    get:
      summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-unstable
      parameters:
      - in: query
        name: metafield[owner_id]
        schema:
          type: integer
        description: metafield[owner_id]
        required: false
      - in: query
        name: metafield[owner_resource]
        schema:
          type: string
        description: metafield[owner_resource]
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Shop resource
              example2:
                value:
                  metafield:
                    namespace: inventory
                    key: warehouse
                    value: 25
                    value_type: integer
                summary: Create a new metafield for a Product resource
              example3:
                value:
                  metafield:
                    key: null
                summary: Creating a metafield without a key will fail and return an error
      summary: Shopify Creates A New Metafield For A Resource
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#create-unstable
      parameters: []
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_metafields
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/metafields/{metafield_id}.json:
    get:
      summary: Shopify Retrieves A Single Metafield From A Resource By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-unstable
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Resource
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_metafields_param_metafield_id
      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