Shopify

Shopify Get API

The Get API from Shopify — 28 operation(s) for get.

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-get-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-get-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Get 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: Get
paths:
  /admin/api/2020-01/blogs/count.json:
    get:
      summary: Shopify Get A Count Of All Blogs
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#count-2020-01
      parameters: []
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_blogs_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/blogs/{blog_id}.json:
    get:
      summary: Shopify Get A Single Blog By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#show-2020-01
      parameters:
      - in: path
        name: blog_id
        required: true
        schema:
          type: string
        description: blog_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_blogs_param_blog_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/products/{product_id}/images.json:
    get:
      summary: Shopify Get All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_products_param_product_id_images
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/products/{product_id}/images/count.json:
    get:
      summary: Shopify Get A Count Of All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_products_param_product_id_images_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/products/{product_id}/images/{image_id}.json:
    get:
      summary: Shopify Get A Single Product Image By Id
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/products/{product_id}/images.json:
    get:
      summary: Shopify Get All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-04
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_products_param_product_id_images
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/products/{product_id}/images/count.json:
    get:
      summary: Shopify Get A Count Of All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-04
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_products_param_product_id_images_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/products/{product_id}/images/{image_id}.json:
    get:
      summary: Shopify Get A Single Product Image By Id
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-04
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/products/{product_id}/images.json:
    get:
      summary: Shopify Get All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-07
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_products_param_product_id_images
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/products/{product_id}/images/count.json:
    get:
      summary: Shopify Get A Count Of All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-07
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_products_param_product_id_images_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/products/{product_id}/images/{image_id}.json:
    get:
      summary: Shopify Get A Single Product Image By Id
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-07
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/products/{product_id}/images.json:
    get:
      summary: Shopify Get All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-10
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: get_products_param_product_id_images
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/products/{product_id}/images/count.json:
    get:
      summary: Shopify Get A Count Of All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-10
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: get_products_param_product_id_images_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/products/{product_id}/images/{image_id}.json:
    get:
      summary: Shopify Get A Single Product Image By Id
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-10
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: get_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/products/{product_id}/images.json:
    get:
      summary: Shopify Get All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2021-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_products_param_product_id_images
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/products/{product_id}/images/count.json:
    get:
      summary: Shopify Get A Count Of All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2021-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_products_param_product_id_images_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/products/{product_id}/images/{image_id}.json:
    get:
      summary: Shopify Get A Single Product Image By Id
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2021-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/products/{product_id}/images.json:
    get:
      summary: Shopify Get All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-unstable
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_products_param_product_id_images
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/products/{product_id}/images/count.json:
    get:
      summary: Shopify Get A Count Of All Product Images
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-unstable
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: query
        name: since_id
        description: Restrict results to after the specified ID
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_products_param_product_id_images_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/products/{product_id}/images/{image_id}.json:
    get:
      summary: Shopify Get A Single Product Image By Id
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-unstable
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /fetch_tracking_numbers:
    get:
      summary: Shopify Get Tracking Numbers For Orders
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#fetch-tracking-numbers
      parameters:
      - in: query
        name: order_names
        description: 'The fulfillment names we require tracking numbers for (i.e. #1001.1)'
        schema: {}
        required: false
      - in: query
        name: shop
        description: The shop's myshopify url
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_unknown_version_get_fetch_tracking_numbers
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /fetch_stock:
    get:
      summary: Shopify Get Inventory Levels
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#fetch-stock
      parameters:
      - in: query
        name: max_retries
        description: The maximum amount of times Shopify will send the request for inventory levels.
        schema: {}
        required: false
      - in: query
        name: shop
        description: The shop's myshopify url.
        schema: {}
        required: false
      - in: query
        name: sku
        description: The SKU for the Product Variant we need stock levels for.
        schema: {}
        required: false
      - in: query
        name: timestamp
        description: The Unix timestamp from when the inventory request was made.
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_unknown_version_get_fetch_stock
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-01
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-04
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-07
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-10
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2021-01
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-unstable
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Get
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_shipping_zones
      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