openapi: 3.1.0
info:
  title: Shopify Admin REST About Gift 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: Gift
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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    note: This is a note
                    initial_value: 100
                    code: ABCD EFGH IJKL MNOP
                    template_suffix: gift_cards.birthday.liquid
                summary: Create a gift card with a custom code
              example2:
                value:
                  gift_card:
                    initial_value: 25
                summary: Create a gift card with an automatically generated code
      summary: Shopify Creates A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-01
      parameters: []
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/gift_cards/{gift_card_id}.json:
    get:
      summary: Shopify Retrieves A Single Gift Card By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-01
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards_param_gift_card_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                    note: Updating with a new note
                summary: Update the note of a gift card
              example2:
                value:
                  gift_card:
                    id: 48394658
                    expires_on: '2020-01-01'
                summary: Update the expiry date of a gift card
      summary: Shopify Updates An Existing Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-01
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_gift_cards_param_gift_card_id
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/gift_cards/{gift_card_id}/disable.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                summary: Disable a gift card
      summary: Shopify Disables A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-01
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_gift_cards_param_gift_card_id_disable
      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:
      - Gift
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    note: This is a note
                    initial_value: 100
                    code: ABCD EFGH IJKL MNOP
                    template_suffix: gift_cards.birthday.liquid
                summary: Create a gift card with a custom code
              example2:
                value:
                  gift_card:
                    initial_value: 25
                summary: Create a gift card with an automatically generated code
      summary: Shopify Creates A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-04
      parameters: []
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/gift_cards/{gift_card_id}.json:
    get:
      summary: Shopify Retrieves A Single Gift Card By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-04
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards_param_gift_card_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                    note: Updating with a new note
                summary: Update the note of a gift card
              example2:
                value:
                  gift_card:
                    id: 48394658
                    expires_on: '2020-01-01'
                summary: Update the expiry date of a gift card
      summary: Shopify Updates An Existing Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-04
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_gift_cards_param_gift_card_id
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/gift_cards/{gift_card_id}/disable.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                summary: Disable a gift card
      summary: Shopify Disables A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-04
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_gift_cards_param_gift_card_id_disable
      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:
      - Gift
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    note: This is a note
                    initial_value: 100
                    code: ABCD EFGH IJKL MNOP
                    template_suffix: gift_cards.birthday.liquid
                summary: Create a gift card with a custom code
              example2:
                value:
                  gift_card:
                    initial_value: 25
                summary: Create a gift card with an automatically generated code
      summary: Shopify Creates A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-07
      parameters: []
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/gift_cards/{gift_card_id}.json:
    get:
      summary: Shopify Retrieves A Single Gift Card By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-07
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards_param_gift_card_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                    note: Updating with a new note
                summary: Update the note of a gift card
              example2:
                value:
                  gift_card:
                    id: 48394658
                    expires_on: '2020-01-01'
                summary: Update the expiry date of a gift card
      summary: Shopify Updates An Existing Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-07
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_gift_cards_param_gift_card_id
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/gift_cards/{gift_card_id}/disable.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                summary: Disable a gift card
      summary: Shopify Disables A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-07
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_gift_cards_param_gift_card_id_disable
      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:
      - Gift
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    note: This is a note
                    initial_value: 100
                    code: ABCD EFGH IJKL MNOP
                    template_suffix: gift_cards.birthday.liquid
                summary: Create a gift card with a custom code
              example2:
                value:
                  gift_card:
                    initial_value: 25
                summary: Create a gift card with an automatically generated code
      summary: Shopify Creates A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-10
      parameters: []
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: create_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/gift_cards/{gift_card_id}.json:
    get:
      summary: Shopify Retrieves A Single Gift Card By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-10
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: get_gift_cards_param_gift_card_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                    note: Updating with a new note
                summary: Update the note of a gift card
              example2:
                value:
                  gift_card:
                    id: 48394658
                    expires_on: '2020-01-01'
                summary: Update the expiry date of a gift card
      summary: Shopify Updates An Existing Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-10
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: update_gift_cards_param_gift_card_id
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/gift_cards/{gift_card_id}/disable.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                summary: Disable a gift card
      summary: Shopify Disables A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-10
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: create_gift_cards_param_gift_card_id_disable
      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:
      - Gift
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    note: This is a note
                    initial_value: 100
                    code: ABCD EFGH IJKL MNOP
                    template_suffix: gift_cards.birthday.liquid
                summary: Create a gift card with a custom code
              example2:
                value:
                  gift_card:
                    initial_value: 25
                summary: Create a gift card with an automatically generated code
      summary: Shopify Creates A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2021-01
      parameters: []
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/gift_cards/{gift_card_id}.json:
    get:
      summary: Shopify Retrieves A Single Gift Card By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2021-01
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards_param_gift_card_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                    note: Updating with a new note
                summary: Update the note of a gift card
              example2:
                value:
                  gift_card:
                    id: 48394658
                    expires_on: '2020-01-01'
                summary: Update the expiry date of a gift card
      summary: Shopify Updates An Existing Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2021-01
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_gift_cards_param_gift_card_id
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/gift_cards/{gift_card_id}/disable.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                summary: Disable a gift card
      summary: Shopify Disables A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2021-01
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_gift_cards_param_gift_card_id_disable
      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:
      - Gift
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    note: This is a note
                    initial_value: 100
                    code: ABCD EFGH IJKL MNOP
                    template_suffix: gift_cards.birthday.liquid
                summary: Create a gift card with a custom code
              example2:
                value:
                  gift_card:
                    initial_value: 25
                summary: Create a gift card with an automatically generated code
      summary: Shopify Creates A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-unstable
      parameters: []
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_gift_cards
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/gift_cards/{gift_card_id}.json:
    get:
      summary: Shopify Retrieves A Single Gift Card By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-unstable
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_gift_cards_param_gift_card_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                    note: Updating with a new note
                summary: Update the note of a gift card
              example2:
                value:
                  gift_card:
                    id: 48394658
                    expires_on: '2020-01-01'
                summary: Update the expiry date of a gift card
      summary: Shopify Updates An Existing Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-unstable
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_gift_cards_param_gift_card_id
      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:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_gift_cards_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/gift_cards/{gift_card_id}/disable.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  gift_card:
                    id: 48394658
                summary: Disable a gift card
      summary: Shopify Disables A Gift Card
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-unstable
      parameters:
      - in: path
        name: gift_card_id
        required: true
        schema:
          type: string
        description: gift_card_id
      tags:
      - Gift
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_gift_cards_param_gift_card_id_disable
      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:
      - Gift
      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