Shopify

Shopify Match API

The Match API from Shopify — 12 operation(s) for match.

GitHub OpenAPI

Operations 12

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-match-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-match-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-match-api-openapi.yml Raw ↑ 
openapi: 3.2.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