Shopify

Shopify Card API

The Card API from Shopify — 24 operation(s) for card.

GitHub OpenAPI
Business capability
Tender and Payment Acceptance Management BC-2320.20

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

POST /admin/api/2020-01/gift_cards.json Issue a new gift card (2020-01) · Shopify Creates A Gift Card #
Ask an LLM
“How do I issue a new gift card with API version 2020-01?”
“Can an app create gift cards on the 2020-01 version?”
Tell an agent
Create a new gift card using API version 2020-01.
Issue a gift card through the 2020-01 gift card endpoint.
GET /admin/api/2020-01/gift_cards/{gift_card_id}.json Retrieve a gift card by ID (2020-01) · Shopify Retrieves A Single Gift Card By Its Id #
Ask an LLM
“Can I look up a single gift card by its ID on API version 2020-01?”
“What does the 2020-01 version return for one gift card?”
Tell an agent
Retrieve gift card {gift_card_id} using API version 2020-01.
Show the 2020-01 record for gift card {gift_card_id}.
PUT /admin/api/2020-01/gift_cards/{gift_card_id}.json Update a gift card (2020-01) · Shopify Updates An Existing Gift Card #
Ask an LLM
“Can I change an existing gift card through API version 2020-01?”
“Which 2020-01 call edits a gift card that was already issued?”
Tell an agent
Update gift card {gift_card_id} using API version 2020-01.
Edit issued gift card {gift_card_id} on the 2020-01 version.
POST /admin/api/2020-01/gift_cards/{gift_card_id}/disable.json Disable a gift card (2020-01) · Shopify Disables A Gift Card #
Ask an LLM
“How do I disable a gift card so it can no longer be used, on 2020-01?”
“Can I deactivate a lost or compromised gift card with the 2020-01 version?”
Tell an agent destructive · confirm first
Disable gift card {gift_card_id} using API version 2020-01.
Deactivate gift card {gift_card_id} on the 2020-01 version.
POST /admin/api/2020-04/gift_cards.json Create a gift card (2020-04) · Shopify Creates A Gift Card #
Ask an LLM
“Can I create a gift card programmatically with the 2020-04 release?”
“Which 2020-04 endpoint makes a brand-new gift card?”
Tell an agent
Make a brand-new gift card with the 2020-04 release.
Using release 2020-04, create a gift card.
GET /admin/api/2020-04/gift_cards/{gift_card_id}.json Get a gift card's details (2020-04) · Shopify Retrieves A Single Gift Card By Its Id #
Ask an LLM
“Where do I read one gift card's details on the 2020-04 release?”
“Can release 2020-04 fetch a gift card if I have its ID?”
Tell an agent
Fetch gift card {gift_card_id} with the 2020-04 release.
Using release 2020-04, pull up gift card {gift_card_id}.
PUT /admin/api/2020-04/gift_cards/{gift_card_id}.json Modify an existing gift card (2020-04) · Shopify Updates An Existing Gift Card #
Ask an LLM
“Can release 2020-04 modify a gift card after it has been issued?”
“What's the 2020-04 call to save changes to a gift card?”
Tell an agent
Modify gift card {gift_card_id} through release 2020-04.
Using release 2020-04, save changes to gift card {gift_card_id}.
POST /admin/api/2020-04/gift_cards/{gift_card_id}/disable.json Deactivate a gift card (2020-04) · Shopify Disables A Gift Card #
Ask an LLM
“Which 2020-04 call stops a gift card from being redeemed?”
“Can I shut off a gift card with release 2020-04?”
Tell an agent destructive · confirm first
Shut off gift card {gift_card_id} with release 2020-04.
Using release 2020-04, disable gift card {gift_card_id} so it cannot be redeemed.
POST /admin/api/2020-07/gift_cards.json Issue a gift card (2020-07) · Shopify Creates A Gift Card #
Ask an LLM
“Does the 2020-07 API let my app issue gift cards?”
“What's involved in issuing a gift card on the 2020-07 API?”
Tell an agent
Issue one new gift card on the 2020-07 API.
For the 2020-07 API, create a gift card for my store.
GET /admin/api/2020-07/gift_cards/{gift_card_id}.json Look up one gift card (2020-07) · Shopify Retrieves A Single Gift Card By Its Id #
Ask an LLM
“What information comes back for a single gift card on the 2020-07 API?”
“Can I look at a specific gift card by ID with 2020-07?”
Tell an agent
Get the details of gift card {gift_card_id} from API 2020-07.
Look up gift card {gift_card_id} on the 2020-07 API.
PUT /admin/api/2020-07/gift_cards/{gift_card_id}.json Edit a gift card (2020-07) · Shopify Updates An Existing Gift Card #
Ask an LLM
“Does the 2020-07 API allow editing a gift card that already exists?”
“Can I adjust an issued gift card through 2020-07?”
Tell an agent
Apply changes to gift card {gift_card_id}, API 2020-07.
Edit gift card {gift_card_id} with the 2020-07 API.
POST /admin/api/2020-07/gift_cards/{gift_card_id}/disable.json Disable a gift card (2020-07) · Shopify Disables A Gift Card #
Ask an LLM
“Is disabling a gift card supported on the 2020-07 API?”
“How would I block a gift card from further use on 2020-07?”
Tell an agent destructive · confirm first
Block gift card {gift_card_id} from further use on the 2020-07 API.
Disable gift card {gift_card_id} (API 2020-07).
POST /admin/api/2020-10/gift_cards.json Create a gift card (2020-10, current version) · Shopify Creates A Gift Card #
Ask an LLM
“How do I create a gift card on the current 2020-10 version?”
“Can the non-deprecated 2020-10 API issue a gift card?”
Tell an agent
Create a gift card on 2020-10.
Issue a new gift card using the non-deprecated 2020-10 API.
GET /admin/api/2020-10/gift_cards/{gift_card_id}.json Retrieve a gift card (2020-10) · Shopify Retrieves A Single Gift Card By Its Id #
Ask an LLM
“Can I retrieve a gift card by ID with the non-deprecated 2020-10 API?”
“Which gift card details does the current 2020-10 version return?”
Tell an agent
Retrieve gift card {gift_card_id} on 2020-10.
Show gift card {gift_card_id}, current 2020-10 version.
PUT /admin/api/2020-10/gift_cards/{gift_card_id}.json Update a gift card (2020-10) · Shopify Updates An Existing Gift Card #
Ask an LLM
“What's the way to update an existing gift card with the current 2020-10 version?”
“Can a gift card be changed via 2020-10 after it is issued?”
Tell an agent
Update gift card {gift_card_id} on 2020-10.
Change gift card {gift_card_id} with the non-deprecated 2020-10 API.
POST /admin/api/2020-10/gift_cards/{gift_card_id}/disable.json Disable a gift card (2020-10) · Shopify Disables A Gift Card #
Ask an LLM
“Can I disable a gift card with the non-deprecated 2020-10 API?”
“Which 2020-10 call makes a gift card unusable?”
Tell an agent destructive · confirm first
Disable gift card {gift_card_id} on 2020-10.
Make gift card {gift_card_id} unusable using the current 2020-10 version.
POST /admin/api/2021-01/gift_cards.json Create a gift card (2021-01) · Shopify Creates A Gift Card #
Ask an LLM
“Is creating a gift card possible with version 2021-01?”
“What's the 2021-01 endpoint for making a new gift card?”
Tell an agent
With version 2021-01, create a gift card.
Set up a new gift card via the 2021-01 version.
GET /admin/api/2021-01/gift_cards/{gift_card_id}.json Fetch a gift card (2021-01) · Shopify Retrieves A Single Gift Card By Its Id #
Ask an LLM
“Can version 2021-01 return a single gift card by its ID?”
“What does a gift card look like when fetched through 2021-01?”
Tell an agent
With version 2021-01, fetch gift card {gift_card_id}.
Display gift card {gift_card_id} from the 2021-01 version.
PUT /admin/api/2021-01/gift_cards/{gift_card_id}.json Modify a gift card (2021-01) · Shopify Updates An Existing Gift Card #
Ask an LLM
“Can I modify an existing gift card in version 2021-01?”
“Which 2021-01 call updates a gift card?”
Tell an agent
With version 2021-01, update gift card {gift_card_id}.
Revise gift card {gift_card_id} through the 2021-01 version.
POST /admin/api/2021-01/gift_cards/{gift_card_id}/disable.json Disable a gift card (2021-01) · Shopify Disables A Gift Card #
Ask an LLM
“Is it possible to disable a gift card through version 2021-01?”
“Which 2021-01 endpoint turns off a gift card?”
Tell an agent destructive · confirm first
With version 2021-01, disable gift card {gift_card_id}.
Turn off gift card {gift_card_id} via the 2021-01 version.
POST /admin/api/unstable/gift_cards.json Create a gift card (unstable version) · Shopify Creates A Gift Card #
Ask an LLM
“Can I test creating a gift card against the unstable API version?”
“What does the unstable version expect when issuing a gift card?”
Tell an agent
On the unstable API version, create a gift card.
Try issuing a gift card using the unstable version.
GET /admin/api/unstable/gift_cards/{gift_card_id}.json Retrieve a gift card (unstable version) · Shopify Retrieves A Single Gift Card By Its Id #
Ask an LLM
“Can I read a single gift card from the unstable API version?”
“What does the unstable version return for one gift card?”
Tell an agent
On the unstable API version, retrieve gift card {gift_card_id}.
Try fetching gift card {gift_card_id} with the unstable version.
PUT /admin/api/unstable/gift_cards/{gift_card_id}.json Update a gift card (unstable version) · Shopify Updates An Existing Gift Card #
Ask an LLM
“Can I update an existing gift card against the unstable API version?”
“How does the unstable version handle edits to a gift card?”
Tell an agent
On the unstable API version, update gift card {gift_card_id}.
Try editing gift card {gift_card_id} using the unstable version.
POST /admin/api/unstable/gift_cards/{gift_card_id}/disable.json Disable a gift card (unstable version) · Shopify Disables A Gift Card #
Ask an LLM
“Can I disable a gift card through the unstable API version?”
“Does the unstable version support deactivating a gift card?”
Tell an agent destructive · confirm first
On the unstable API version, disable gift card {gift_card_id}.
Try deactivating gift card {gift_card_id} with the unstable version.
POST /admin/api/2020-01/checkouts/{token}/payments.json Pay for a checkout with a card vault session (2020-01) · Shopify Creates A Payment On A Checkout Using The Session Id Returned By The… #
Ask an LLM
“How does a sales channel take payment on a checkout from a card vault session in 2020-01?”
“Does the 2020-01 checkout payment call need a unique idempotency token?”
Tell an agent
Create a payment on checkout {token} with API version 2020-01.
Charge checkout {token} from its card vault session, version 2020-01.
POST /admin/api/2020-04/checkouts/{token}/payments.json Create a checkout payment (2020-04) · Shopify Creates A Payment On A Checkout Using The Session Id Returned By The… #
Ask an LLM
“Can a sales channel app charge a checkout using a card vault session ID on release 2020-04?”
“What does release 2020-04 need to record a payment against a checkout?”
Tell an agent
Record a payment against checkout {token} through release 2020-04.
Using release 2020-04, pay for checkout {token} with the vaulted card session.
POST /admin/api/2020-07/checkouts/{token}/payments.json Charge a checkout via card vault session (2020-07) · Shopify Creates A Payment On A Checkout Using The Session Id Returned By The… #
Ask an LLM
“Is taking a card vault payment on a checkout supported by the 2020-07 API?”
“Which 2020-07 call completes payment for a checkout token?”
Tell an agent
Take payment on checkout {token} using the 2020-07 API.
For the 2020-07 API, create a card vault payment for checkout {token}.
POST /admin/api/2020-10/checkouts/{token}/payments.json Create a checkout payment (2020-10, current version) · Shopify Creates A Payment On A Checkout Using The Session Id Returned By The… #
Ask an LLM
“How do I create a payment on a checkout with a card vault session on the current 2020-10 version?”
“Can the non-deprecated 2020-10 API accept a vaulted card payment for a checkout?”
Tell an agent
Create a payment on checkout {token} on 2020-10.
Charge checkout {token} with its vaulted card using the non-deprecated 2020-10 API.
POST /admin/api/2021-01/checkouts/{token}/payments.json Create a checkout payment (2021-01) · Shopify Creates A Payment On A Checkout Using The Session Id Returned By The… #
Ask an LLM
“Can version 2021-01 create a payment on a checkout from a card vault session?”
“Which 2021-01 call pays a checkout with a vaulted card?”
Tell an agent
With version 2021-01, create a payment for checkout {token}.
Pay checkout {token} from its card vault session via the 2021-01 version.
POST /admin/api/unstable/checkouts/{token}/payments.json Create a checkout payment (unstable version) · Shopify Creates A Payment On A Checkout Using The Session Id Returned By The… #
Ask an LLM
“Can I test a card vault checkout payment against the unstable API version?”
“Does the unstable version accept payments on a checkout by token?”
Tell an agent
On the unstable API version, create a payment on checkout {token}.
Try charging checkout {token} with a card vault session 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-card-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-card-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-card-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Card 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 (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-card-api-openapi.yml