openapi: 3.1.0
info:
  title: Shopify Admin REST Collections API
  description: 'The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. It provides access to products, customers, orders, inventory, fulfillment, shipping, and store configuration. All requests require a valid Shopify access token. Note: Shopify is deprecating the REST Admin API in favor of GraphQL. New development should use the GraphQL Admin API.'
  version: 2024-10
  termsOfService: https://www.shopify.com/legal/api-terms
  contact:
    name: Shopify Developer Support
    url: https://shopify.dev/docs/api/admin-rest
  license:
    name: API Terms of Service
    url: https://www.shopify.com/legal/api-terms
servers:
- url: https://{store_name}.myshopify.com/admin/api/2024-10
  description: Shopify Admin REST API
  variables:
    store_name:
      description: The name of the Shopify store
      default: mystore
security:
- AccessToken: []
tags:
- name: Collections
paths:
  /collects.json:
    get:
      operationId: listCollects
      summary: List Collects
      description: Retrieves a list of collects (product-collection relationships).
      tags:
      - Collections
      parameters:
      - name: collection_id
        in: query
        description: Filter by collection ID
        schema:
          type: integer
          format: int64
      - name: product_id
        in: query
        description: Filter by product ID
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful response with list of collects
          content:
            application/json:
              schema:
                type: object
                properties:
                  collects:
                    type: array
                    items:
                      $ref: '#/components/schemas/Collect'
  /custom_collections.json:
    get:
      operationId: listCustomCollections
      summary: List Custom Collections
      description: Retrieves a list of custom collections.
      tags:
      - Collections
      parameters:
      - name: limit
        in: query
        description: The maximum number of results to show
        schema:
          type: integer
          minimum: 1
          maximum: 250
          default: 50
      responses:
        '200':
          description: Successful response with list of custom collections
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_collections:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomCollection'
components:
  schemas:
    CustomCollection:
      type: object
      properties:
        id:
          type: integer
          format: int64
        handle:
          type: string
        title:
          type: string
        updated_at:
          type: string
          format: date-time
        body_html:
          type: string
        published_at:
          type: string
          format: date-time
          nullable: true
        sort_order:
          type: string
        published_scope:
          type: string
        image:
          type: object
          nullable: true
    Collect:
      type: object
      properties:
        id:
          type: integer
          format: int64
        collection_id:
          type: integer
          format: int64
        product_id:
          type: integer
          format: int64
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        position:
          type: integer
        sort_value:
          type: string
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: X-Shopify-Access-Token
      description: Shopify access token for authentication