Shopify

Shopify Script API

The Script API from Shopify — 18 operation(s) for script.

GitHub OpenAPI

Operations 12

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/script_tags.json Create a storefront script tag (2020-01) · Shopify Creates A New Script Tag #
Ask an LLM
“How do I load my app's script on the storefront with a script tag, on API 2020-01?”
“Can I create a new script tag through the January 2020 Admin API?”
Tell an agent
Create a script tag via 2020-01.
On January 2020, add a new script tag to the online store.
PUT /admin/api/2020-01/script_tags/{script_tag_id}.json Update a script tag (2020-01) · Shopify Updates A Script Tag #
Ask an LLM
“How do I change an existing script tag using API 2020-01?”
“Can I update a script tag I already created, in the January 2020 Admin API?”
Tell an agent
Update script tag {script_tag} via 2020-01.
On January 2020, modify existing script tag {script_tag}.
POST /admin/api/2020-04/script_tags.json Create a storefront script tag (2020-04) · Shopify Creates A New Script Tag #
Ask an LLM
“Which 2020-04 endpoint creates a script tag?”
“In April 2020, can my app add a script tag to the storefront?”
Tell an agent
Add a new script tag using 2020-04.
Using April 2020, register a script tag for the storefront.
PUT /admin/api/2020-04/script_tags/{script_tag_id}.json Update a script tag (2020-04) · Shopify Updates A Script Tag #
Ask an LLM
“Which 2020-04 endpoint updates a script tag?”
“In April 2020, can I edit a script tag after it's installed?”
Tell an agent
Edit script tag {script_tag} using 2020-04.
Using April 2020, update the existing script tag {script_tag}.
POST /admin/api/2020-07/script_tags.json Create a storefront script tag (2020-07) · Shopify Creates A New Script Tag #
Ask an LLM
“What call creates a new script tag in the 2020-07 API?”
“Is adding a storefront script tag possible with July 2020?”
Tell an agent
Create a new script tag with 2020-07.
Via July 2020, install a script tag on the storefront.
PUT /admin/api/2020-07/script_tags/{script_tag_id}.json Update a script tag (2020-07) · Shopify Updates A Script Tag #
Ask an LLM
“What call modifies an existing script tag in the 2020-07 API?”
“Is updating an installed script tag possible with July 2020?”
Tell an agent
Modify script tag {script_tag} with 2020-07.
Via July 2020, change script tag {script_tag}.
POST /admin/api/2020-10/script_tags.json Create a storefront script tag · Shopify Creates A New Script Tag #
Ask an LLM
“My app needs JavaScript on the storefront; how do I create a script tag on 2020-10?”
“Where in October 2020 do I add a new script tag?”
Tell an agent
Create a script tag for the online store (API 2020-10).
With October 2020, add a new storefront script tag.
PUT /admin/api/2020-10/script_tags/{script_tag_id}.json Update a script tag · Shopify Updates A Script Tag #
Ask an LLM
“My storefront script tag needs changes; how do I update it on 2020-10?”
“Where in October 2020 do I edit an existing script tag?”
Tell an agent
Update existing script tag {script_tag} (API 2020-10).
With October 2020, edit script tag {script_tag}.
POST /admin/api/2021-01/script_tags.json Create a storefront script tag (2021-01) · Shopify Creates A New Script Tag #
Ask an LLM
“On 2021-01, how can I create a script tag?”
“Does January 2021 let apps add new script tags?”
Tell an agent
Add a script tag using 2021-01.
Using January 2021, create a new storefront script tag.
PUT /admin/api/2021-01/script_tags/{script_tag_id}.json Update a script tag (2021-01) · Shopify Updates A Script Tag #
Ask an LLM
“On 2021-01, how can I update a script tag?”
“Does January 2021 let me change a script tag I already created?”
Tell an agent
Change script tag {script_tag} using 2021-01.
Using January 2021, update existing script tag {script_tag}.
POST /admin/api/unstable/script_tags.json Create a storefront script tag (unstable) · Shopify Creates A New Script Tag #
Ask an LLM
“Can I create a script tag on the unstable API?”
“Which unstable-version endpoint adds a new script tag?”
Tell an agent
Create a new script tag on unstable.
Using the unstable endpoint, add a script tag to the store.
PUT /admin/api/unstable/script_tags/{script_tag_id}.json Update a script tag (unstable) · Shopify Updates A Script Tag #
Ask an LLM
“Can I update a script tag on the unstable API?”
“Which unstable-version endpoint edits an existing script tag?”
Tell an agent
Update script tag {script_tag} on unstable.
Using the unstable endpoint, modify existing script tag {script_tag}.

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-script-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-script-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-script-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Script 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: Script
paths:
  /admin/api/2020-01/script_tags.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    event: onload
                    src: https://djavaskripped.org/fancy.js
                summary: Create a new script tag
              example2:
                value:
                  script_tag:
                    body: foobar
                summary: Creating a script tag without a src and event will return an error
      summary: Shopify Creates A New Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-01
      parameters: []
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_script_tags
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/script_tags/{script_tag_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    id: 596726825
                    src: https://somewhere-else.com/another.js
                summary: Update a script tag's URL
      summary: Shopify Updates A Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-01
      parameters:
      - in: path
        name: script_tag_id
        required: true
        schema:
          type: string
        description: script_tag_id
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_script_tags_param_script_tag_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/script_tags.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    event: onload
                    src: https://djavaskripped.org/fancy.js
                summary: Create a new script tag
              example2:
                value:
                  script_tag:
                    body: foobar
                summary: Creating a script tag without a src and event will return an error
      summary: Shopify Creates A New Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-04
      parameters: []
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_script_tags
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/script_tags/{script_tag_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    id: 596726825
                    src: https://somewhere-else.com/another.js
                summary: Update a script tag's URL
      summary: Shopify Updates A Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-04
      parameters:
      - in: path
        name: script_tag_id
        required: true
        schema:
          type: string
        description: script_tag_id
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_script_tags_param_script_tag_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/script_tags.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    event: onload
                    src: https://djavaskripped.org/fancy.js
                summary: Create a new script tag
              example2:
                value:
                  script_tag:
                    body: foobar
                summary: Creating a script tag without a src and event will return an error
      summary: Shopify Creates A New Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-07
      parameters: []
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_script_tags
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/script_tags/{script_tag_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    id: 596726825
                    src: https://somewhere-else.com/another.js
                summary: Update a script tag's URL
      summary: Shopify Updates A Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-07
      parameters:
      - in: path
        name: script_tag_id
        required: true
        schema:
          type: string
        description: script_tag_id
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_script_tags_param_script_tag_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/script_tags.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    event: onload
                    src: https://djavaskripped.org/fancy.js
                summary: Create a new script tag
              example2:
                value:
                  script_tag:
                    body: foobar
                summary: Creating a script tag without a src and event will return an error
      summary: Shopify Creates A New Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-10
      parameters: []
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: create_script_tags
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/script_tags/{script_tag_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    id: 596726825
                    src: https://somewhere-else.com/another.js
                summary: Update a script tag's URL
      summary: Shopify Updates A Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-10
      parameters:
      - in: path
        name: script_tag_id
        required: true
        schema:
          type: string
        description: script_tag_id
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: update_script_tags_param_script_tag_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/script_tags.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    event: onload
                    src: https://djavaskripped.org/fancy.js
                summary: Create a new script tag
              example2:
                value:
                  script_tag:
                    body: foobar
                summary: Creating a script tag without a src and event will return an error
      summary: Shopify Creates A New Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2021-01
      parameters: []
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_script_tags
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/script_tags/{script_tag_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    id: 596726825
                    src: https://somewhere-else.com/another.js
                summary: Update a script tag's URL
      summary: Shopify Updates A Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2021-01
      parameters:
      - in: path
        name: script_tag_id
        required: true
        schema:
          type: string
        description: script_tag_id
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_script_tags_param_script_tag_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/script_tags.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    event: onload
                    src: https://djavaskripped.org/fancy.js
                summary: Create a new script tag
              example2:
                value:
                  script_tag:
                    body: foobar
                summary: Creating a script tag without a src and event will return an error
      summary: Shopify Creates A New Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-unstable
      parameters: []
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_script_tags
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/script_tags/{script_tag_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  script_tag:
                    id: 596726825
                    src: https://somewhere-else.com/another.js
                summary: Update a script tag's URL
      summary: Shopify Updates A Script Tag
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-unstable
      parameters:
      - in: path
        name: script_tag_id
        required: true
        schema:
          type: string
        description: script_tag_id
      tags:
      - Script
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_script_tags_param_script_tag_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true