Shopify Match API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Match 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: Match
paths:
  /admin/api/2020-01/customers/search.json:
    get:
      summary: Shopify Searches For Customers That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-01
      parameters:
      - in: query
        name: order
        description: "Set the field and direction by which to order results.\n                  (default: last_order_date DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: Text to search for in the shop's customer data.
        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: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_customers_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/customers/search.json:
    get:
      summary: Shopify Searches For Customers That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-04
      parameters:
      - in: query
        name: order
        description: "Set the field and direction by which to order results.\n                  (default: last_order_date DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: Text to search for in the shop's customer data.
        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: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_customers_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/customers/search.json:
    get:
      summary: Shopify Searches For Customers That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-07
      parameters:
      - in: query
        name: order
        description: "Set the field and direction by which to order results.\n                  (default: last_order_date DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: Text to search for in the shop's customer data.
        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: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_customers_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/customers/search.json:
    get:
      summary: Shopify Searches For Customers That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-10
      parameters:
      - in: query
        name: order
        description: "Set the field and direction by which to order results.\n                  (default: last_order_date DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: Text to search for in the shop's customer data.
        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: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Match
      responses:
        '200':
          description: ''
      operationId: get_customers_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/customers/search.json:
    get:
      summary: Shopify Searches For Customers That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2021-01
      parameters:
      - in: query
        name: order
        description: "Set the field and direction by which to order results.\n                  (default: last_order_date DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: Text to search for in the shop's customer data.
        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: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_customers_search
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/customers/search.json:
    get:
      summary: Shopify Searches For Customers That Match A Supplied Query
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-unstable
      parameters:
      - in: query
        name: order
        description: "Set the field and direction by which to order results.\n                  (default: last_order_date DESC)"
        schema: {}
        required: false
      - in: query
        name: query
        description: Text to search for in the shop's customer data.
        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: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_customers_search
      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:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_gift_cards_search
      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:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_gift_cards_search
      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:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_gift_cards_search
      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:
      - Match
      responses:
        '200':
          description: ''
      operationId: get_gift_cards_search
      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:
      - Match
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_gift_cards_search
      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:
      - Match
      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