Shopify

Shopify Summaries API

The Summaries API from Shopify — 18 operation(s) for summaries.

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-summaries-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-summaries-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Summaries 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: Summaries
paths:
  /admin/api/2020-01/products/{product_id}/images/{image_id}.json:
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-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
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-04/products/{product_id}/images/{image_id}.json:
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-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
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-07/products/{product_id}/images/{image_id}.json:
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-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
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-10/products/{product_id}/images/{image_id}.json:
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-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
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: delete_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2021-01/products/{product_id}/images/{image_id}.json:
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-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
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_delete_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/unstable/products/{product_id}/images/{image_id}.json:
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-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
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_delete_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-01/fulfillment_services.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-01
      parameters:
      - in: query
        name: scope
        description: "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n                        all: Returns all the fulfillment providers"
        schema: {}
        required: false
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_fulfillment_services
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-01
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_service:
                    id: 755357713
                    name: New Fulfillment Service Name
                summary: Update a fulfillment service
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-01
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-01
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-04/fulfillment_services.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-04
      parameters:
      - in: query
        name: scope
        description: "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n                        all: Returns all the fulfillment providers"
        schema: {}
        required: false
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_fulfillment_services
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-04
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_service:
                    id: 755357713
                    name: New Fulfillment Service Name
                summary: Update a fulfillment service
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-04
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-04
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-07/fulfillment_services.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-07
      parameters:
      - in: query
        name: scope
        description: "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n                        all: Returns all the fulfillment providers"
        schema: {}
        required: false
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_fulfillment_services
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-07
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_service:
                    id: 755357713
                    name: New Fulfillment Service Name
                summary: Update a fulfillment service
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-07
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-07
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-10/fulfillment_services.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-10
      parameters:
      - in: query
        name: scope
        description: "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n                        all: Returns all the fulfillment providers"
        schema: {}
        required: false
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: get_fulfillment_services
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-10
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: get_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_service:
                    id: 755357713
                    name: New Fulfillment Service Name
                summary: Update a fulfillment service
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-10
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: update_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-10
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: delete_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2021-01/fulfillment_services.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2021-01
      parameters:
      - in: query
        name: scope
        description: "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n                        all: Returns all the fulfillment providers"
        schema: {}
        required: false
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_fulfillment_services
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2021-01
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_service:
                    id: 755357713
                    name: New Fulfillment Service Name
                summary: Update a fulfillment service
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2021-01
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2021-01
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_delete_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/unstable/fulfillment_services.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-unstable
      parameters:
      - in: query
        name: scope
        description: "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n                        all: Returns all the fulfillment providers"
        schema: {}
        required: false
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_fulfillment_services
      x-api-evangelist-processing:
        ChooseTags: true
  /admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json:
    get:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-unstable
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_service:
                    id: 755357713
                    name: New Fulfillment Service Name
                summary: Update a fulfillment service
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-unstable
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
    delete:
      summary: Shopify Needs a summary
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-unstable
      parameters:
      - in: path
        name: fulfillment_service_id
        required: true
        schema:
          type: string
        description: fulfillment_service_id
      tags:
      - Summaries
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_delete_fulfillment_services_param_fulfillment_service_id
      x-api-evangelist-processing:
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth