Shopify

Shopify Listing API

The Listing API from Shopify — 9 operation(s) for listing.

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-listing-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-listing-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Listing 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: Listing
paths:
  /admin/api/2020-01/collection_listings/{collection_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-01
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  collection_listing:
                    collection_id: 482865238
                summary: Create a collection listing to publish a collection to your app
      summary: Shopify Create A Collection Listing To Publish A Collection To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-01
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Collection Listing To Unpublish A Collection From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-01
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/collection_listings/{collection_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-04
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  collection_listing:
                    collection_id: 482865238
                summary: Create a collection listing to publish a collection to your app
      summary: Shopify Create A Collection Listing To Publish A Collection To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-04
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Collection Listing To Unpublish A Collection From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-04
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/collection_listings/{collection_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-07
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  collection_listing:
                    collection_id: 482865238
                summary: Create a collection listing to publish a collection to your app
      summary: Shopify Create A Collection Listing To Publish A Collection To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-07
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Collection Listing To Unpublish A Collection From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-07
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/collection_listings/{collection_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-10
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: get_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  collection_listing:
                    collection_id: 482865238
                summary: Create a collection listing to publish a collection to your app
      summary: Shopify Create A Collection Listing To Publish A Collection To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-10
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Collection Listing To Unpublish A Collection From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-10
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: delete_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/collection_listings/{collection_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2021-01
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  collection_listing:
                    collection_id: 482865238
                summary: Create a collection listing to publish a collection to your app
      summary: Shopify Create A Collection Listing To Publish A Collection To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2021-01
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Collection Listing To Unpublish A Collection From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2021-01
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_delete_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/collection_listings/{collection_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-unstable
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  collection_listing:
                    collection_id: 482865238
                summary: Create a collection listing to publish a collection to your app
      summary: Shopify Create A Collection Listing To Publish A Collection To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-unstable
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Collection Listing To Unpublish A Collection From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-unstable
      parameters:
      - in: path
        name: collection_listing_id
        required: true
        schema:
          type: string
        description: collection_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_delete_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/product_listings/{product_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Product Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-01
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  product_listing:
                    product_id: 921728736
                summary: Create a product listing to publish a product to your app
      summary: Shopify Create A Product Listing To Publish A Product To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-01
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Product Listing To Unpublish A Product From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-01
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/product_listings/{product_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Product Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-04
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  product_listing:
                    product_id: 921728736
                summary: Create a product listing to publish a product to your app
      summary: Shopify Create A Product Listing To Publish A Product To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-04
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Product Listing To Unpublish A Product From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-04
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/product_listings/{product_listing_id}.json:
    get:
      summary: Shopify Retrieve A Specific Product Listing That Is Published To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-07
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  product_listing:
                    product_id: 921728736
                summary: Create a product listing to publish a product to your app
      summary: Shopify Create A Product Listing To Publish A Product To Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-07
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Delete A Product Listing To Unpublish A Product From Your App
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-07
      parameters:
      - in: path
        name: product_listing_id
        required: true
        schema:
          type: string
        description: product_listing_id
      tags:
      - Listing
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_product_listings_param_product_listing_id
      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