Shopify

Shopify Admin API

The Admin API from Shopify — 6 operation(s) for admin.

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

PUT /admin/api/2020-01/metafields/{metafield_id}.json Update a metafield (API 2020-01) · Shopify Updates A Metafield #
Ask an LLM
“How do I change an existing metafield using the 2020-01 Admin API?”
“Can I edit a custom metafield I already stored, on API version 2020-01?”
Tell an agent
Update metafield {metafield_id} via the 2020-01 API.
Using version 2020-01, edit the stored custom metafield {metafield_id}.
PUT /admin/api/2020-04/metafields/{metafield_id}.json Update a metafield (API 2020-04) · Shopify Updates A Metafield #
Ask an LLM
“Which April 2020 (2020-04) endpoint modifies a metafield that already exists?”
“Is changing metafield data supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, modify metafield {metafield_id}.
Change the data held in metafield {metafield_id} with the April 2020 endpoint.
PUT /admin/api/2020-07/metafields/{metafield_id}.json Update a metafield (API 2020-07) · Shopify Updates A Metafield #
Ask an LLM
“My integration targets 2020-07; what updates a metafield there?”
“Can the July 2020 Admin API overwrite extra data I attached as a metafield?”
Tell an agent
Overwrite metafield {metafield_id} using July 2020 (2020-07).
With API 2020-07, save changes to metafield {metafield_id}.
PUT /admin/api/2020-10/metafields/{metafield_id}.json Update a metafield (API 2020-10) · Shopify Updates A Metafield #
Ask an LLM
“What is the 2020-10 call for revising a metafield?”
“Does the October 2020 Admin API let me correct a metafield value?”
Tell an agent
Correct metafield {metafield_id} on the October 2020 version.
Revise the 2020-10 metafield {metafield_id}.
PUT /admin/api/2021-01/metafields/{metafield_id}.json Update a metafield (API 2021-01) · Shopify Updates A Metafield #
Ask an LLM
“Under the 2021-01 Admin API, where do I update a metafield?”
“Can I amend a metafield with the January 2021 API version?”
Tell an agent
Amend metafield {metafield_id} through API version 2021-01.
Push an update for metafield {metafield_id} against January 2021.
PUT /admin/api/unstable/metafields/{metafield_id}.json Update a metafield (unstable API) · Shopify Updates A Metafield #
Ask an LLM
“Is there an unstable-channel endpoint for updating a metafield?”
“Can I test metafield edits against the unstable Admin API version?”
Tell an agent
Update metafield {metafield_id} on the unstable API.
Against the unstable version, test editing metafield {metafield_id}.

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-admin-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-admin-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-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Admin 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: Admin
paths:
  /admin/api/2020-01/metafields/{metafield_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    id: 721389482
                    value: something new
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
              example2:
                value:
                  metafield:
                    id: 845366454
                    value: titre
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
      summary: Shopify Updates A Metafield
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-01
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      tags:
      - Admin
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/metafields/{metafield_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    id: 721389482
                    value: something new
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
              example2:
                value:
                  metafield:
                    id: 845366454
                    value: titre
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
      summary: Shopify Updates A Metafield
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-04
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      tags:
      - Admin
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/metafields/{metafield_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    id: 721389482
                    value: something new
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
              example2:
                value:
                  metafield:
                    id: 845366454
                    value: titre
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
      summary: Shopify Updates A Metafield
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-07
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      tags:
      - Admin
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/metafields/{metafield_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    id: 721389482
                    value: something new
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
              example2:
                value:
                  metafield:
                    id: 845366454
                    value: titre
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
      summary: Shopify Updates A Metafield
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-10
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      tags:
      - Admin
      responses:
        '200':
          description: ''
      operationId: update_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/metafields/{metafield_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    id: 721389482
                    value: something new
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
              example2:
                value:
                  metafield:
                    id: 845366454
                    value: titre
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
      summary: Shopify Updates A Metafield
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2021-01
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      tags:
      - Admin
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/metafields/{metafield_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  metafield:
                    id: 721389482
                    value: something new
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
              example2:
                value:
                  metafield:
                    id: 845366454
                    value: titre
                    value_type: string
                summary: Update a metafield. The namespace and key of an existing metafield can't be changed.
      summary: Shopify Updates A Metafield
      description: https://shopify.dev/docs/admin-api/rest/reference/metafield#update-unstable
      parameters:
      - in: path
        name: metafield_id
        required: true
        schema:
          type: string
        description: metafield_id
      tags:
      - Admin
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_metafields_param_metafield_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true