Shopify

Shopify Cards API

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

GitHub OpenAPI

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

OpenAPI Specification

shopify-cards-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Cards API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
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
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth