Shopify

Shopify Cards API

The Cards API from Shopify — 18 operation(s) for cards.

GitHub OpenAPI

Operations 18

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

GET /admin/api/2020-01/gift_cards.json List gift cards (API 2020-01) · Shopify Retrieves A List Of Gift Cards #
Ask an LLM
“Which gift cards has my Shopify Plus store issued, per API 2020-01?”
“Can I list only the enabled gift cards with version 2020-01?”
Tell an agent
List 2020-01 gift cards with status {status}.
Show gift cards after {since_id} using API 2020-01.
GET /admin/api/2020-01/gift_cards/count.json Count gift cards (API 2020-01) · Shopify Retrieves A Count Of Gift Cards #
Ask an LLM
“How many gift cards exist in my store according to API 2020-01?”
“Can the 2020-01 count split gift cards by enabled or disabled status?”
Tell an agent
Count gift cards with API 2020-01.
Count 2020-01 gift cards whose status is {status}.
GET /admin/api/2020-04/gift_cards.json List gift cards (API 2020-04) · Shopify Retrieves A List Of Gift Cards #
Ask an LLM
“What gift cards does version 2020-04 list for my shop?”
“Is there a page size limit on the 2020-04 gift card list?”
Tell an agent
Get {limit} gift cards per page from the 2020-04 endpoint.
List disabled or enabled gift cards, status {status}, via API 2020-04.
GET /admin/api/2020-04/gift_cards/count.json Count gift cards (API 2020-04) · Shopify Retrieves A Count Of Gift Cards #
Ask an LLM
“What is the total number of gift cards on my store with version 2020-04?”
“Can I count only disabled gift cards on API 2020-04?”
Tell an agent
Give me the gift card total from the 2020-04 count endpoint.
Tally 2020-04 gift cards with status {status}.
GET /admin/api/2020-07/gift_cards.json List gift cards (API 2020-07) · Shopify Retrieves A List Of Gift Cards #
Ask an LLM
“Can I list every gift card in my store with API 2020-07?”
“Can the 2020-07 gift card list return just a few fields?”
Tell an agent
List gift cards on version 2020-07.
Return {fields} for each gift card with API 2020-07.
GET /admin/api/2020-07/gift_cards/count.json Count gift cards (API 2020-07) · Shopify Retrieves A Count Of Gift Cards #
Ask an LLM
“How many enabled gift cards does my shop have on API 2020-07?”
“Does version 2020-07 offer a quick gift card count?”
Tell an agent
Count gift cards via the 2020-07 API.
Count gift cards in status {status} with version 2020-07.
GET /admin/api/2020-10/gift_cards.json List gift cards (API 2020-10) · Shopify Retrieves A List Of Gift Cards #
Ask an LLM
“What gift cards has my Shopify store issued, using API 2020-10?”
“Can I page through gift cards on 2020-10 from the last ID I saw?”
Tell an agent
List all gift cards using API version 2020-10.
Continue the 2020-10 gift card list after {since_id}, {limit} at a time.
GET /admin/api/2020-10/gift_cards/count.json Count gift cards (API 2020-10) · Shopify Retrieves A Count Of Gift Cards #
Ask an LLM
“How many gift cards does my store have on API 2020-10?”
“Can the 2020-10 count include only enabled gift cards?”
Tell an agent
Count my gift cards with API version 2020-10.
Count 2020-10 gift cards having status {status}.
GET /admin/api/2021-01/gift_cards.json List gift cards (API 2021-01) · Shopify Retrieves A List Of Gift Cards #
Ask an LLM
“Does the 2021-01 API still list my store's gift cards?”
“Which disabled gift cards exist according to version 2021-01?”
Tell an agent
Retrieve gift cards through the 2021-01 API.
List 2021-01 gift cards with status {status}, showing only {fields}.
GET /admin/api/2021-01/gift_cards/count.json Count gift cards (API 2021-01) · Shopify Retrieves A Count Of Gift Cards #
Ask an LLM
“What is my gift card count according to version 2021-01?”
“Can I get a 2021-01 count of gift cards filtered by status?”
Tell an agent
Count gift cards via the 2021-01 count endpoint.
Count 2021-01 gift cards in status {status}.
GET /admin/api/unstable/gift_cards.json List gift cards (unstable API) · Shopify Retrieves A List Of Gift Cards #
Ask an LLM
“Can I list gift cards on the unstable API version?”
“Which gift cards does the unstable endpoint return after a given ID?”
Tell an agent
List gift cards on the unstable API version.
Get unstable-version gift cards after {since_id}.
GET /admin/api/unstable/gift_cards/count.json Count gift cards (unstable API) · Shopify Retrieves A Count Of Gift Cards #
Ask an LLM
“Can I count gift cards on the unstable API version?”
“How many gift cards of one status does the unstable count report?”
Tell an agent
Count gift cards on the unstable API version.
Count unstable-version gift cards with status {status}.

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-cards-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-cards-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-cards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Cards 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: Cards
paths:
  /admin/api/2020-01/gift_cards.json:
    get:
      summary: Shopify Retrieves A List Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-01
      parameters:
      - in: query
        name: status
        description: "Retrieve gift cards with a given status. Valid values:\n                    \n                        enabled: Restrict results to only enabled gift cards\n                        disabled: Restrict results to only disabled gift cards"
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/gift_cards/count.json:
    get:
      summary: Shopify Retrieves A Count Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-01
      parameters:
      - in: query
        name: status
        description: "Count gift cards with a given status. Valid values:\n                    \n                        enabled: Count only enabled gift cards\n                        disabled: Count only disabled gift cards"
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/gift_cards/search.json:
    get:
      summary: Shopify Searches For Gift Cards That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-01
      parameters:
      - in: query
        name: order
        description: "The field and direction to order results by.\n                  (default: disabled_at DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: The text to search for.
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/gift_cards.json:
    get:
      summary: Shopify Retrieves A List Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-04
      parameters:
      - in: query
        name: status
        description: "Retrieve gift cards with a given status. Valid values:\n                    \n                        enabled: Restrict results to only enabled gift cards\n                        disabled: Restrict results to only disabled gift cards"
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/gift_cards/count.json:
    get:
      summary: Shopify Retrieves A Count Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-04
      parameters:
      - in: query
        name: status
        description: "Count gift cards with a given status. Valid values:\n                    \n                        enabled: Count only enabled gift cards\n                        disabled: Count only disabled gift cards"
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/gift_cards/search.json:
    get:
      summary: Shopify Searches For Gift Cards That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-04
      parameters:
      - in: query
        name: order
        description: "The field and direction to order results by.\n                  (default: disabled_at DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: The text to search for.
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/gift_cards.json:
    get:
      summary: Shopify Retrieves A List Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-07
      parameters:
      - in: query
        name: status
        description: "Retrieve gift cards with a given status. Valid values:\n                    \n                        enabled: Restrict results to only enabled gift cards\n                        disabled: Restrict results to only disabled gift cards"
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/gift_cards/count.json:
    get:
      summary: Shopify Retrieves A Count Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-07
      parameters:
      - in: query
        name: status
        description: "Count gift cards with a given status. Valid values:\n                    \n                        enabled: Count only enabled gift cards\n                        disabled: Count only disabled gift cards"
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/gift_cards/search.json:
    get:
      summary: Shopify Searches For Gift Cards That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-07
      parameters:
      - in: query
        name: order
        description: "The field and direction to order results by.\n                  (default: disabled_at DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: The text to search for.
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/gift_cards.json:
    get:
      summary: Shopify Retrieves A List Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-10
      parameters:
      - in: query
        name: status
        description: "Retrieve gift cards with a given status. Valid values:\n                    \n                        enabled: Restrict results to only enabled gift cards\n                        disabled: Restrict results to only disabled gift cards"
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/gift_cards/count.json:
    get:
      summary: Shopify Retrieves A Count Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-10
      parameters:
      - in: query
        name: status
        description: "Count gift cards with a given status. Valid values:\n                    \n                        enabled: Count only enabled gift cards\n                        disabled: Count only disabled gift cards"
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/gift_cards/search.json:
    get:
      summary: Shopify Searches For Gift Cards That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-10
      parameters:
      - in: query
        name: order
        description: "The field and direction to order results by.\n                  (default: disabled_at DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: The text to search for.
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: get_gift_cards_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/gift_cards.json:
    get:
      summary: Shopify Retrieves A List Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2021-01
      parameters:
      - in: query
        name: status
        description: "Retrieve gift cards with a given status. Valid values:\n                    \n                        enabled: Restrict results to only enabled gift cards\n                        disabled: Restrict results to only disabled gift cards"
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/gift_cards/count.json:
    get:
      summary: Shopify Retrieves A Count Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2021-01
      parameters:
      - in: query
        name: status
        description: "Count gift cards with a given status. Valid values:\n                    \n                        enabled: Count only enabled gift cards\n                        disabled: Count only disabled gift cards"
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/gift_cards/search.json:
    get:
      summary: Shopify Searches For Gift Cards That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2021-01
      parameters:
      - in: query
        name: order
        description: "The field and direction to order results by.\n                  (default: disabled_at DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: The text to search for.
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/gift_cards.json:
    get:
      summary: Shopify Retrieves A List Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-unstable
      parameters:
      - in: query
        name: status
        description: "Retrieve gift cards with a given status. Valid values:\n                    \n                        enabled: Restrict results to only enabled gift cards\n                        disabled: Restrict results to only disabled gift cards"
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/gift_cards/count.json:
    get:
      summary: Shopify Retrieves A Count Of Gift Cards
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-unstable
      parameters:
      - in: query
        name: status
        description: "Count gift cards with a given status. Valid values:\n                    \n                        enabled: Count only enabled gift cards\n                        disabled: Count only disabled gift cards"
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/gift_cards/search.json:
    get:
      summary: Shopify Searches For Gift Cards That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-unstable
      parameters:
      - in: query
        name: order
        description: "The field and direction to order results by.\n                  (default: disabled_at DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: The text to search for.
        schema: {}
        required: false
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Cards
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_gift_cards_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true