Shopify Publish API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Publish 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: Publish
paths:
  /admin/api/2020-01/collection_listings/{collection_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/collection_listings/{collection_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/collection_listings/{collection_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/collection_listings/{collection_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/collection_listings/{collection_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/collection_listings/{collection_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_collection_listings_param_collection_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/product_listings/{product_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/product_listings/{product_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_product_listings_param_product_listing_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/product_listings/{product_listing_id}.json:
    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:
      - Publish
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_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