Shopify

Shopify Checkout API

The Checkout API from Shopify — 36 operation(s) for checkout.

GitHub OpenAPI
Business capability
Cart & Checkout AE-140.20

Operations 36

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/checkouts.json Start a new sales-channel checkout (API 2020-01) · Shopify Creates A Checkout #
Ask an LLM
“How does my sales channel app open a new checkout for a buyer on API 2020-01?”
“Can a sales channel create checkouts through version 2020-01?”
Tell an agent
Create a new checkout for my sales channel using 2020-01.
Open a fresh buyer checkout via release 2020-01.
POST /admin/api/2020-04/checkouts.json Start a new sales-channel checkout (API 2020-04) · Shopify Creates A Checkout #
Ask an LLM
“Which 2020-04 call begins a checkout session from my sales channel?”
“Is creating a checkout supported on release 2020-04?”
Tell an agent
Start a checkout for a shopper with API 2020-04.
Begin a new sales-channel checkout on version 2020-04.
POST /admin/api/2020-07/checkouts.json Start a new sales-channel checkout (API 2020-07) · Shopify Creates A Checkout #
Ask an LLM
“Can my channel app spin up a checkout for a customer using 2020-07?”
“What 2020-07 request creates a checkout before payment?”
Tell an agent
Create a checkout through the 2020-07 release.
Set up a new checkout for my buyer, version 2020-07.
POST /admin/api/2020-10/checkouts.json Start a new sales-channel checkout (API 2020-10) · Shopify Creates A Checkout #
Ask an LLM
“How do I create a checkout from a sales channel on 2020-10?”
“Which 2020-10 endpoint kicks off a checkout for my channel's shopper?”
Tell an agent
Open a new checkout via API 2020-10.
Create a sales channel checkout for a customer on 2020-10.
POST /admin/api/2021-01/checkouts.json Start a new sales-channel checkout (API 2021-01) · Shopify Creates A Checkout #
Ask an LLM
“Can I start a checkout for a buyer through version 2021-01?”
“What request creates a checkout on release 2021-01?”
Tell an agent
Create a checkout for my sales channel with 2021-01.
Kick off a new shopper checkout on version 2021-01.
POST /admin/api/unstable/checkouts.json Start a new sales-channel checkout (unstable API) · Shopify Creates A Checkout #
Ask an LLM
“Can the unstable API create a checkout for my sales channel?”
“Is starting a buyer checkout available on the unstable release?”
Tell an agent
Create a checkout using the unstable API version.
Begin a sales-channel checkout on the unstable release.
POST /admin/api/2020-01/checkouts/{token}/complete.json Complete a checkout without payment (API 2020-01) · Shopify Completes A Checkout #
Ask an LLM
“How do I finish a checkout that needs no payment, like a free order, on 2020-01?”
“Can I turn a checkout into an order with API 2020-01?”
Tell an agent
Complete checkout {token} using version 2020-01.
Finalize the checkout {token} into an order via 2020-01.
GET /admin/api/2020-01/checkouts/{token}.json Look up a checkout by token (API 2020-01) · Shopify Retrieves A Checkout #
Ask an LLM
“What's in a buyer's checkout right now, like line items and totals, on 2020-01?”
“Can I check whether a checkout is ready to complete with release 2020-01?”
Tell an agent
Get checkout {token} with API 2020-01.
Show the current state of checkout {token}, version 2020-01.
PUT /admin/api/2020-01/checkouts/{token}.json Change an existing checkout (API 2020-01) · Shopify Modifies An Existing Checkout #
Ask an LLM
“Can I modify a checkout the buyer already started on API 2020-01?”
“Which 2020-01 call edits an open checkout before it's completed?”
Tell an agent
Update checkout {token} on release 2020-01.
Modify the in-progress checkout {token} via 2020-01.
POST /admin/api/2020-04/checkouts/{token}/complete.json Complete a checkout without payment (API 2020-04) · Shopify Completes A Checkout #
Ask an LLM
“Can I close out a zero-cost checkout into an order through 2020-04?”
“Which 2020-04 request completes a checkout?”
Tell an agent
Complete the checkout {token} with 2020-04.
Convert checkout {token} into an order on release 2020-04.
GET /admin/api/2020-04/checkouts/{token}.json Look up a checkout by token (API 2020-04) · Shopify Retrieves A Checkout #
Ask an LLM
“Can I read back a checkout's details using its token on 2020-04?”
“What does version 2020-04 show for one buyer's checkout?”
Tell an agent
Retrieve checkout {token} via release 2020-04.
Look up buyer checkout {token} on API 2020-04.
PUT /admin/api/2020-04/checkouts/{token}.json Change an existing checkout (API 2020-04) · Shopify Modifies An Existing Checkout #
Ask an LLM
“Is editing an existing checkout supported on version 2020-04?”
“Can my sales channel revise a checkout mid-purchase with 2020-04?”
Tell an agent
Modify checkout {token} using API 2020-04.
Save changes to the open checkout {token}, 2020-04.
POST /admin/api/2020-07/checkouts/{token}/complete.json Complete a checkout without payment (API 2020-07) · Shopify Completes A Checkout #
Ask an LLM
“How can a checkout that requires no payment be completed on 2020-07?”
“Can release 2020-07 place the order for a finished checkout?”
Tell an agent
Complete checkout {token} through version 2020-07.
Place the order for checkout {token} on API 2020-07.
GET /admin/api/2020-07/checkouts/{token}.json Look up a checkout by token (API 2020-07) · Shopify Retrieves A Checkout #
Ask an LLM
“Where can I see a checkout's line items and totals on API 2020-07?”
“Can 2020-07 tell me the status of one checkout by token?”
Tell an agent
Fetch checkout {token} with version 2020-07.
Show me checkout {token} as it stands, release 2020-07.
PUT /admin/api/2020-07/checkouts/{token}.json Change an existing checkout (API 2020-07) · Shopify Modifies An Existing Checkout #
Ask an LLM
“Can I amend a checkout that's still open with 2020-07?”
“What 2020-07 call updates an existing checkout by token?”
Tell an agent
Edit checkout {token} via 2020-07.
Update the buyer's open checkout {token} on version 2020-07.
POST /admin/api/2020-10/checkouts/{token}/complete.json Complete a checkout without payment (API 2020-10) · Shopify Completes A Checkout #
Ask an LLM
“Can I complete a free checkout and create the order on 2020-10?”
“Which 2020-10 endpoint finalizes a checkout?”
Tell an agent
Complete checkout {token} on API 2020-10.
Wrap up checkout {token} as an order using 2020-10.
GET /admin/api/2020-10/checkouts/{token}.json Look up a checkout by token (API 2020-10) · Shopify Retrieves A Checkout #
Ask an LLM
“How do I view one checkout's contents by its token on 2020-10?”
“Can version 2020-10 show if a checkout has been completed yet?”
Tell an agent
Get the checkout {token} using API 2020-10.
Read checkout {token} details on 2020-10.
PUT /admin/api/2020-10/checkouts/{token}.json Change an existing checkout (API 2020-10) · Shopify Modifies An Existing Checkout #
Ask an LLM
“Can I update a buyer's existing checkout through 2020-10?”
“Which 2020-10 request changes a checkout before it's paid?”
Tell an agent
Update checkout {token} with version 2020-10.
Change the in-progress checkout {token}, API 2020-10.
POST /admin/api/2021-01/checkouts/{token}/complete.json Complete a checkout without payment (API 2021-01) · Shopify Completes A Checkout #
Ask an LLM
“Can I finish a no-payment checkout using release 2021-01?”
“What 2021-01 call completes a checkout into an order?”
Tell an agent
Complete checkout {token} via release 2021-01.
Finalize checkout {token} and create its order on 2021-01.
GET /admin/api/2021-01/checkouts/{token}.json Look up a checkout by token (API 2021-01) · Shopify Retrieves A Checkout #
Ask an LLM
“Can I retrieve a checkout by its token on version 2021-01?”
“What does 2021-01 return for a single buyer checkout?”
Tell an agent
Get checkout {token} through 2021-01.
Pull up buyer checkout {token} on API 2021-01.
PUT /admin/api/2021-01/checkouts/{token}.json Change an existing checkout (API 2021-01) · Shopify Modifies An Existing Checkout #
Ask an LLM
“Can I alter an open checkout with API 2021-01?”
“Which 2021-01 endpoint modifies an existing checkout?”
Tell an agent
Update checkout {token} on release 2021-01.
Revise the open checkout {token} using 2021-01.
POST /admin/api/unstable/checkouts/{token}/complete.json Complete a checkout without payment (unstable API) · Shopify Completes A Checkout #
Ask an LLM
“Can the unstable API complete a checkout that needs no payment?”
“Is finalizing a checkout into an order available on the unstable release?”
Tell an agent
Complete checkout {token} with the unstable API.
Turn checkout {token} into an order on the unstable version.
GET /admin/api/unstable/checkouts/{token}.json Look up a checkout by token (unstable API) · Shopify Retrieves A Checkout #
Ask an LLM
“Can I read a checkout by token through the unstable API?”
“What does the unstable release show for one checkout?”
Tell an agent
Get checkout {token} from the unstable API.
Show checkout {token} on the unstable release.
PUT /admin/api/unstable/checkouts/{token}.json Change an existing checkout (unstable API) · Shopify Modifies An Existing Checkout #
Ask an LLM
“Can I modify an existing checkout using the unstable version?”
“Is updating an open checkout supported on the unstable API?”
Tell an agent
Update checkout {token} via the unstable API.
Edit open checkout {token} on the unstable release.
GET /admin/api/2020-01/checkouts/{token}/payments.json List payments on a checkout (API 2020-01) · Shopify Retrieves A List Of Payments On A Particular Checkout #
Ask an LLM
“Which payment attempts were made on a buyer's checkout, per API 2020-01?”
“Can I see failed and successful payments for one checkout on 2020-01?”
Tell an agent
List payments on checkout {token} using 2020-01.
Show every payment attempt for checkout {token}, release 2020-01.
GET /admin/api/2020-01/checkouts/{token}/payments/count.json Count payment attempts on a checkout (API 2020-01) · Shopify Counts The Number Of Payments Attempted On A Checkout #
Ask an LLM
“How many times has a buyer tried to pay on one checkout, on version 2020-01?”
“Can I get just a number of payment attempts for a checkout with 2020-01?”
Tell an agent
Count payment attempts on checkout {token} with 2020-01.
Tell me how many payments were tried on checkout {token}, API 2020-01.
GET /admin/api/2020-04/checkouts/{token}/payments.json List payments on a checkout (API 2020-04) · Shopify Retrieves A List Of Payments On A Particular Checkout #
Ask an LLM
“What payments has a checkout received so far when read through 2020-04?”
“Can release 2020-04 list the payment records attached to a checkout?”
Tell an agent
Get the payments made against checkout {token} on 2020-04.
List payment records for checkout {token} via version 2020-04.
GET /admin/api/2020-04/checkouts/{token}/payments/count.json Count payment attempts on a checkout (API 2020-04) · Shopify Counts The Number Of Payments Attempted On A Checkout #
Ask an LLM
“What's the total number of payment tries on a checkout under 2020-04?”
“Is there a count-only call for checkout payments in release 2020-04?”
Tell an agent
Count the payments attempted on checkout {token} via 2020-04.
Give me the payment attempt total for checkout {token}, 2020-04.
GET /admin/api/2020-07/checkouts/{token}/payments.json List payments on a checkout (API 2020-07) · Shopify Retrieves A List Of Payments On A Particular Checkout #
Ask an LLM
“Can I review each payment a shopper submitted on a checkout with 2020-07?”
“Which payments belong to one checkout according to version 2020-07?”
Tell an agent
Show payments for checkout {token} with API 2020-07.
List the payment attempts recorded on checkout {token}, 2020-07.
GET /admin/api/2020-07/checkouts/{token}/payments/count.json Count payment attempts on a checkout (API 2020-07) · Shopify Counts The Number Of Payments Attempted On A Checkout #
Ask an LLM
“How many payment attempts sit on a checkout per API 2020-07?”
“Can 2020-07 count checkout payments without listing them?”
Tell an agent
Count payments on checkout {token}, version 2020-07.
Return the number of payment tries for checkout {token} on 2020-07.
GET /admin/api/2020-10/checkouts/{token}/payments.json List payments on a checkout (API 2020-10) · Shopify Retrieves A List Of Payments On A Particular Checkout #
Ask an LLM
“Can I see the payment history of one checkout on 2020-10?”
“Which payments were attempted on a checkout, per version 2020-10?”
Tell an agent
List all payments for checkout {token} on API 2020-10.
Get each payment attempt on checkout {token} with 2020-10.
GET /admin/api/2020-10/checkouts/{token}/payments/count.json Count payment attempts on a checkout (API 2020-10) · Shopify Counts The Number Of Payments Attempted On A Checkout #
Ask an LLM
“How many payment attempts has one checkout had on API 2020-10?”
“Can I get a quick payment count for a checkout with version 2020-10?”
Tell an agent
Count payment attempts for checkout {token} on 2020-10.
Tally the payments tried on checkout {token}, API 2020-10.
GET /admin/api/2021-01/checkouts/{token}/payments.json List payments on a checkout (API 2021-01) · Shopify Retrieves A List Of Payments On A Particular Checkout #
Ask an LLM
“What payment records exist for a checkout when I use release 2021-01?”
“Can 2021-01 list payment attempts for a given checkout?”
Tell an agent
List checkout {token} payments using version 2021-01.
Show the payment attempts on checkout {token} via 2021-01.
GET /admin/api/2021-01/checkouts/{token}/payments/count.json Count payment attempts on a checkout (API 2021-01) · Shopify Counts The Number Of Payments Attempted On A Checkout #
Ask an LLM
“How many payments were tried on a checkout according to 2021-01?”
“Can I count one checkout's payment attempts with release 2021-01?”
Tell an agent
Count checkout {token} payment attempts via 2021-01.
Get the number of payments on checkout {token}, version 2021-01.
GET /admin/api/unstable/checkouts/{token}/payments.json List payments on a checkout (unstable API) · Shopify Retrieves A List Of Payments On A Particular Checkout #
Ask an LLM
“Can the unstable API list payments attempted on a checkout?”
“What payment attempts does the unstable release show for one checkout?”
Tell an agent
List payments for checkout {token} from the unstable API.
Show checkout {token} payment attempts on the unstable release.
GET /admin/api/unstable/checkouts/{token}/payments/count.json Count payment attempts on a checkout (unstable API) · Shopify Counts The Number Of Payments Attempted On A Checkout #
Ask an LLM
“Can I count payment attempts on a checkout through the unstable API?”
“Does the unstable release offer a payment count for checkouts?”
Tell an agent
Count payment attempts on checkout {token} with the unstable version.
Return the payment total tried on checkout {token}, unstable API.

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-checkout-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-checkout-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-checkout-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Checkout 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 (40 KB total) ---
# Full source: https://artifacts.apis.io/shopify/openapi/shopify-checkout-api-openapi.yml