medusa-store/docs/api/admin/paths/collections.yaml

post:
  operationId: PostCollections
  summary: Create a Collection
  description: Creates a Product Collection.
  x-authenticated: true
  requestBody:
    content:
      application/json:
        schema:
          type: object
          required:
            - title
          properties:
            title:
              type: string
              description: The title to identify the Collection by.
            handle:
              type: string
              description: >-
                An optional handle to be used in slugs, if none is provided we
                will kebab-case the title.
            metadata:
              description: >-
                An optional set of key-value pairs to hold additional
                information.
              type: object
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/collections/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/collections/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Collection
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                $ref: ../components/schemas/product_collection.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
get:
  operationId: GetCollections
  summary: List Collections
  description: Retrieve a list of Product Collection.
  x-authenticated: true
  parameters:
    - in: query
      name: limit
      description: The number of collections to return.
      schema:
        type: integer
        default: 10
    - in: query
      name: offset
      description: The number of collections to skip before the results.
      schema:
        type: integer
        default: 0
    - in: query
      name: title
      description: The title of collections to return.
      schema:
        type: string
    - in: query
      name: handle
      description: The handle of collections to return.
      schema:
        type: string
    - in: query
      name: q
      description: a search term to search titles and handles.
      schema:
        type: string
    - in: query
      name: discount_condition_id
      description: The discount condition id on which to filter the product collections.
      schema:
        type: string
    - in: query
      name: created_at
      description: Date comparison for when resulting collections were created.
      schema:
        type: object
        properties:
          lt:
            type: string
            description: filter by dates less than this date
            format: date
          gt:
            type: string
            description: filter by dates greater than this date
            format: date
          lte:
            type: string
            description: filter by dates less than or equal to this date
            format: date
          gte:
            type: string
            description: filter by dates greater than or equal to this date
            format: date
    - in: query
      name: updated_at
      description: Date comparison for when resulting collections were updated.
      schema:
        type: object
        properties:
          lt:
            type: string
            description: filter by dates less than this date
            format: date
          gt:
            type: string
            description: filter by dates greater than this date
            format: date
          lte:
            type: string
            description: filter by dates less than or equal to this date
            format: date
          gte:
            type: string
            description: filter by dates greater than or equal to this date
            format: date
    - in: query
      name: deleted_at
      description: Date comparison for when resulting collections were deleted.
      schema:
        type: object
        properties:
          lt:
            type: string
            description: filter by dates less than this date
            format: date
          gt:
            type: string
            description: filter by dates greater than this date
            format: date
          lte:
            type: string
            description: filter by dates less than or equal to this date
            format: date
          gte:
            type: string
            description: filter by dates greater than or equal to this date
            format: date
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/collections/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/collections/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Collection
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              collections:
                type: array
                items:
                  $ref: ../components/schemas/product_collection.yaml
              count:
                type: integer
                description: The total number of items available
              offset:
                type: integer
                description: The number of items skipped before these items
              limit:
                type: integer
                description: The number of items per page
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml