Shopify

Shopify Existing API

The Existing API from Shopify — 78 operation(s) for existing.

GitHub OpenAPI

Operations 30

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/inventory_items/{inventory_item_id}.json Update an inventory item (API 2020-01) · Shopify Updates An Existing Inventory Item #
Ask an LLM
“How do I change an existing inventory item using the 2020-01 Admin API?”
“Can I edit the inventory item behind a variant on API version 2020-01?”
Tell an agent
Update inventory item {inventory_item_id} via the 2020-01 API.
Using version 2020-01, save edits to stock item {inventory_item_id}.
PUT /admin/api/2020-04/inventory_items/{inventory_item_id}.json Update an inventory item (API 2020-04) · Shopify Updates An Existing Inventory Item #
Ask an LLM
“Which April 2020 (2020-04) endpoint modifies an inventory item?”
“Is editing an existing inventory item supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, modify inventory item {inventory_item_id}.
Apply changes to the stock record {inventory_item_id} with the April 2020 endpoint.
PUT /admin/api/2020-07/inventory_items/{inventory_item_id}.json Update an inventory item (API 2020-07) · Shopify Updates An Existing Inventory Item #
Ask an LLM
“My inventory app targets 2020-07; what updates an inventory item there?”
“Can the July 2020 API revise an inventory item I already track?”
Tell an agent
Revise tracked inventory item {inventory_item_id} using July 2020 (2020-07).
With API 2020-07, write updates to inventory item {inventory_item_id}.
PUT /admin/api/2020-10/inventory_items/{inventory_item_id}.json Update an inventory item (API 2020-10) · Shopify Updates An Existing Inventory Item #
Ask an LLM
“What is the 2020-10 call for updating an inventory item?”
“Does the October 2020 API let me correct an existing inventory item?”
Tell an agent
Correct inventory item {inventory_item_id} on the October 2020 version.
Update the 2020-10 inventory item {inventory_item_id}.
PUT /admin/api/2021-01/inventory_items/{inventory_item_id}.json Update an inventory item (API 2021-01) · Shopify Updates An Existing Inventory Item #
Ask an LLM
“Under the 2021-01 API, where do I update an inventory item?”
“Can I amend an inventory item with the January 2021 API version?”
Tell an agent
Amend inventory item {inventory_item_id} through API version 2021-01.
Push an update for stock item {inventory_item_id} against January 2021.
PUT /admin/api/unstable/inventory_items/{inventory_item_id}.json Update an inventory item (unstable API) · Shopify Updates An Existing Inventory Item #
Ask an LLM
“Is there an unstable-channel endpoint for updating an inventory item?”
“Can I test inventory item edits against the unstable API version?”
Tell an agent
Update inventory item {inventory_item_id} on the unstable API.
Against the unstable version, test editing stock item {inventory_item_id}.
PUT /admin/api/2020-01/redirects/{redirect_id}.json Update a URL redirect (API 2020-01) · Shopify Updates An Existing Redirect #
Ask an LLM
“How do I change an existing URL redirect on my online store with the 2020-01 API?”
“Can I fix a redirect that points old links to the wrong page, on version 2020-01?”
Tell an agent
Update redirect {redirect_id} via the 2020-01 API.
Using version 2020-01, fix URL redirect {redirect_id}.
PUT /admin/api/2020-04/redirects/{redirect_id}.json Update a URL redirect (API 2020-04) · Shopify Updates An Existing Redirect #
Ask an LLM
“Which April 2020 (2020-04) endpoint modifies a URL redirect?”
“Is editing an existing storefront redirect supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, modify redirect {redirect_id}.
Change where storefront redirect {redirect_id} goes with the April 2020 endpoint.
PUT /admin/api/2020-07/redirects/{redirect_id}.json Update a URL redirect (API 2020-07) · Shopify Updates An Existing Redirect #
Ask an LLM
“My SEO app targets 2020-07; what updates a redirect there?”
“Can the July 2020 API repoint an old URL redirect?”
Tell an agent
Repoint old URL redirect {redirect_id} using July 2020 (2020-07).
With API 2020-07, write changes to redirect {redirect_id}.
PUT /admin/api/2020-10/redirects/{redirect_id}.json Update a URL redirect (API 2020-10) · Shopify Updates An Existing Redirect #
Ask an LLM
“What is the 2020-10 call for editing a URL redirect?”
“Does the October 2020 API let me correct a redirect's target?”
Tell an agent
Correct the target of redirect {redirect_id} on the October 2020 version.
Update the 2020-10 URL redirect {redirect_id}.
PUT /admin/api/2021-01/redirects/{redirect_id}.json Update a URL redirect (API 2021-01) · Shopify Updates An Existing Redirect #
Ask an LLM
“Under the 2021-01 API, where do I update a URL redirect?”
“Can I amend a store redirect with the January 2021 API version?”
Tell an agent
Amend redirect {redirect_id} through API version 2021-01.
Push an update for store redirect {redirect_id} against January 2021.
PUT /admin/api/unstable/redirects/{redirect_id}.json Update a URL redirect (unstable API) · Shopify Updates An Existing Redirect #
Ask an LLM
“Is there an unstable-channel endpoint for updating a URL redirect?”
“Can I test redirect edits against the unstable API version?”
Tell an agent
Update redirect {redirect_id} on the unstable API.
Against the unstable version, test editing URL redirect {redirect_id}.
PUT /admin/api/2020-01/themes/{theme_id}.json Update a theme (API 2020-01) · Shopify Updates An Existing Theme #
Ask an LLM
“How do I change an existing online store theme using the 2020-01 API?”
“Can I edit a theme's settings record on API version 2020-01?”
Tell an agent
Update theme {theme_id} via the 2020-01 API.
Using version 2020-01, save edits to online store theme {theme_id}.
PUT /admin/api/2020-04/themes/{theme_id}.json Update a theme (API 2020-04) · Shopify Updates An Existing Theme #
Ask an LLM
“Which April 2020 (2020-04) endpoint modifies a theme?”
“Is editing an existing storefront theme supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, modify theme {theme_id}.
Apply changes to storefront theme {theme_id} with the April 2020 endpoint.
PUT /admin/api/2020-07/themes/{theme_id}.json Update a theme (API 2020-07) · Shopify Updates An Existing Theme #
Ask an LLM
“My theme app targets 2020-07; what updates a theme there?”
“Can the July 2020 API revise a theme that is already installed?”
Tell an agent
Revise installed theme {theme_id} using July 2020 (2020-07).
With API 2020-07, write updates to theme {theme_id}.
PUT /admin/api/2020-10/themes/{theme_id}.json Update a theme (API 2020-10) · Shopify Updates An Existing Theme #
Ask an LLM
“What is the 2020-10 call for updating a theme?”
“Does the October 2020 API let me change an existing theme record?”
Tell an agent
Change the theme record {theme_id} on the October 2020 version.
Update the 2020-10 theme {theme_id}.
PUT /admin/api/2021-01/themes/{theme_id}.json Update a theme (API 2021-01) · Shopify Updates An Existing Theme #
Ask an LLM
“Under the 2021-01 API, where do I update a theme?”
“Can I amend a store theme with the January 2021 API version?”
Tell an agent
Amend theme {theme_id} through API version 2021-01.
Push an update for store theme {theme_id} against January 2021.
PUT /admin/api/unstable/themes/{theme_id}.json Update a theme (unstable API) · Shopify Updates An Existing Theme #
Ask an LLM
“Is there an unstable-channel endpoint for updating a theme?”
“Can I test theme edits against the unstable API version?”
Tell an agent
Update theme {theme_id} on the unstable API.
Against the unstable version, test editing online store theme {theme_id}.
PUT /admin/api/2020-01/products/{product_id}/images/{image_id}.json Modify a product image (API 2020-01) · Shopify Modify An Existing Product Image #
Ask an LLM
“How do I edit an image already attached to a product with the 2020-01 API?”
“Can I change a product photo's record on API version 2020-01?”
Tell an agent
Update image {image_id} on product {product_id} via the 2020-01 API.
Using version 2020-01, modify product {product_id}'s photo {image_id}.
PUT /admin/api/2020-04/products/{product_id}/images/{image_id}.json Modify a product image (API 2020-04) · Shopify Modify An Existing Product Image #
Ask an LLM
“Which April 2020 (2020-04) endpoint modifies a product image?”
“Is editing an existing product picture supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, modify image {image_id} of product {product_id}.
Apply changes to picture {image_id} on product {product_id} with the April 2020 endpoint.
PUT /admin/api/2020-07/products/{product_id}/images/{image_id}.json Modify a product image (API 2020-07) · Shopify Modify An Existing Product Image #
Ask an LLM
“My catalog app targets 2020-07; what updates a product image there?”
“Can the July 2020 API revise an image already on a product listing?”
Tell an agent
Revise listing image {image_id} for product {product_id} using July 2020 (2020-07).
With API 2020-07, write updates to product {product_id} image {image_id}.
PUT /admin/api/2020-10/products/{product_id}/images/{image_id}.json Modify a product image (API 2020-10) · Shopify Modify An Existing Product Image #
Ask an LLM
“What is the 2020-10 call for modifying a product image?”
“Does the October 2020 API let me change an existing product photo?”
Tell an agent
Change photo {image_id} of product {product_id} on the October 2020 version.
Update the 2020-10 product image {image_id} for product {product_id}.
PUT /admin/api/2021-01/products/{product_id}/images/{image_id}.json Modify a product image (API 2021-01) · Shopify Modify An Existing Product Image #
Ask an LLM
“Under the 2021-01 API, where do I update a product image?”
“Can I amend a product's picture with the January 2021 API version?”
Tell an agent
Amend image {image_id} of product {product_id} through API version 2021-01.
Push an update for product {product_id} picture {image_id} against January 2021.
PUT /admin/api/unstable/products/{product_id}/images/{image_id}.json Modify a product image (unstable API) · Shopify Modify An Existing Product Image #
Ask an LLM
“Is there an unstable-channel endpoint for modifying a product image?”
“Can I test product image edits against the unstable API version?”
Tell an agent
Update image {image_id} on product {product_id} on the unstable API.
Against the unstable version, test editing product {product_id} photo {image_id}.
GET /admin/api/2020-01/checkouts/{token}/payments/{payment_id}.json Retrieve a checkout payment (API 2020-01) · Shopify Retrieves The Payment Information For An Existing Payment #
Ask an LLM
“How do I get the payment information for one payment on a checkout with the 2020-01 API?”
“Can a sales channel check the status of a checkout payment on version 2020-01?”
Tell an agent
Get payment {payment_id} on checkout {token} via the 2020-01 API.
Using version 2020-01, show payment details for {payment_id} in checkout {token}.
GET /admin/api/2020-04/checkouts/{token}/payments/{payment_id}.json Retrieve a checkout payment (API 2020-04) · Shopify Retrieves The Payment Information For An Existing Payment #
Ask an LLM
“Which April 2020 (2020-04) endpoint returns a single checkout payment?”
“Is reading payment info for a checkout supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, fetch payment {payment_id} for checkout {token}.
Pull checkout {token}'s payment {payment_id} with the April 2020 endpoint.
GET /admin/api/2020-07/checkouts/{token}/payments/{payment_id}.json Retrieve a checkout payment (API 2020-07) · Shopify Retrieves The Payment Information For An Existing Payment #
Ask an LLM
“My sales channel targets 2020-07; what reads a checkout payment there?”
“Can the July 2020 API tell me whether a checkout payment went through?”
Tell an agent
Tell me if payment {payment_id} on checkout {token} went through, using July 2020 (2020-07).
With API 2020-07, read payment {payment_id} of checkout {token}.
GET /admin/api/2020-10/checkouts/{token}/payments/{payment_id}.json Retrieve a checkout payment (API 2020-10) · Shopify Retrieves The Payment Information For An Existing Payment #
Ask an LLM
“What is the 2020-10 call for retrieving a payment made on a checkout?”
“Does the October 2020 API show the result of one checkout payment?”
Tell an agent
Show the result of payment {payment_id} for checkout {token} on the October 2020 version.
Retrieve the 2020-10 checkout {token} payment {payment_id}.
GET /admin/api/2021-01/checkouts/{token}/payments/{payment_id}.json Retrieve a checkout payment (API 2021-01) · Shopify Retrieves The Payment Information For An Existing Payment #
Ask an LLM
“Under the 2021-01 API, where do I inspect a checkout payment?”
“Can I verify one checkout payment with the January 2021 API version?”
Tell an agent
Inspect payment {payment_id} on checkout {token} through API version 2021-01.
Verify checkout {token} payment {payment_id} against January 2021.
GET /admin/api/unstable/checkouts/{token}/payments/{payment_id}.json Retrieve a checkout payment (unstable API) · Shopify Retrieves The Payment Information For An Existing Payment #
Ask an LLM
“Is there an unstable-channel endpoint for reading a checkout payment?”
“Can I test checkout payment lookups against the unstable API version?”
Tell an agent
Get payment {payment_id} for checkout {token} on the unstable API.
Against the unstable version, test fetching checkout {token} payment {payment_id}.

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/shopify/openapi/shopify-existing-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-product-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://artifacts.apis.io/shopify/json-structure/shopify-product-structure.json
📊
JSONStructure
https://artifacts.apis.io/shopify/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/shopify/json-ld/shopify-context.jsonld
🔗
Examples
https://artifacts.apis.io/shopify/examples/shopify-create-product-example.json
🔗
Examples
https://artifacts.apis.io/shopify/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://artifacts.apis.io/shopify/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://artifacts.apis.io/shopify/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:shopify-existing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-existing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Existing 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:


# --- truncated at 32 KB (36 KB total) ---
# Full source: https://artifacts.apis.io/shopify/openapi/shopify-existing-api-openapi.yml