Shopify

Shopify Resource API

The Resource API from Shopify — 12 operation(s) for resource.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /admin/api/2020-01/metafields.json Attach a metafield to a resource (2020-01) · Shopify Creates A New Metafield For A Resource #
Ask an LLM
“How do I store custom data on a store resource as a metafield with API version 2020-01?”
“Can my app add a new metafield through the 2020-01 version?”
Tell an agent
Create a new metafield using API version 2020-01.
Attach custom metafield data to a resource on the 2020-01 version.
POST /admin/api/2020-04/metafields.json Create a metafield (2020-04) · Shopify Creates A New Metafield For A Resource #
Ask an LLM
“Which 2020-04 endpoint saves extra custom fields on a resource?”
“Can release 2020-04 create metafields?”
Tell an agent
Using release 2020-04, save a metafield on a resource.
Make a new metafield with the 2020-04 release.
POST /admin/api/2020-07/metafields.json Add a metafield to a resource (2020-07) · Shopify Creates A New Metafield For A Resource #
Ask an LLM
“Does the 2020-07 API let me extend a resource with a metafield?”
“What's involved in adding custom metadata on the 2020-07 API?”
Tell an agent
Extend a resource with a new metafield on the 2020-07 API.
For the 2020-07 API, add a metafield.
POST /admin/api/2020-10/metafields.json Create a metafield (2020-10, current version) · Shopify Creates A New Metafield For A Resource #
Ask an LLM
“What's the way to create a metafield on the current 2020-10 version?”
“Can the non-deprecated 2020-10 API store custom metadata for a resource?”
Tell an agent
Create a metafield on 2020-10.
Save a key-value metafield on a store resource with the non-deprecated 2020-10 API.
POST /admin/api/2021-01/metafields.json Create a metafield (2021-01) · Shopify Creates A New Metafield For A Resource #
Ask an LLM
“Is creating a metafield possible with version 2021-01?”
“Which 2021-01 call adds custom data to a resource?”
Tell an agent
With version 2021-01, create a metafield.
Add custom data to a resource via the 2021-01 version.
POST /admin/api/unstable/metafields.json Create a metafield (unstable version) · Shopify Creates A New Metafield For A Resource #
Ask an LLM
“Can I test creating a metafield against the unstable API version?”
“What does the unstable version expect when adding a metafield?”
Tell an agent
On the unstable API version, create a metafield.
Try adding a metafield using the unstable version.

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-resource-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/shopify-resource-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shopify-resource-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Resource 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
tags:
- name: Resource
paths:
  /admin/api/2020-01/metafields.json:
    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-04/metafields.json:
    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-07/metafields.json:
    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-10/metafields.json:
    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/2021-01/metafields.json:
    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/unstable/metafields.json:
    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