medusa-store/docs/api/admin/paths/admin_price-lists.yaml

get:
  operationId: GetPriceLists
  summary: List Price Lists
  description: >-
    Retrieve a list of price lists. The price lists can be filtered by fields
    such as `q` or `status`. The price lists can also be sorted or paginated.
  x-authenticated: true
  parameters:
    - in: query
      name: limit
      description: Limit the number of price lists returned.
      schema:
        type: number
        default: '10'
    - in: query
      name: offset
      description: The number of price lists to skip when retrieving the price lists.
      schema:
        type: number
        default: '0'
    - in: query
      name: expand
      description: >-
        Comma-separated relations that should be expanded in the returned price
        lists.
      schema:
        type: string
    - in: query
      name: fields
      description: >-
        Comma-separated fields that should be included in the returned price
        lists.
      schema:
        type: string
    - in: query
      name: order
      description: A price-list field to sort-order the retrieved price lists by.
      schema:
        type: string
    - in: query
      name: id
      description: Filter by ID
      schema:
        type: string
    - in: query
      name: q
      description: >-
        term to search price lists' description, name, and customer group's
        name.
      schema:
        type: string
    - in: query
      name: status
      style: form
      explode: false
      description: Filter by status.
      schema:
        type: array
        items:
          type: string
          enum:
            - active
            - draft
    - in: query
      name: name
      description: Filter by name
      schema:
        type: string
    - in: query
      name: customer_groups
      style: form
      explode: false
      description: Filter by customer-group IDs.
      schema:
        type: array
        items:
          type: string
    - in: query
      name: type
      style: form
      explode: false
      description: Filter by type.
      schema:
        type: array
        items:
          type: string
          enum:
            - sale
            - override
    - in: query
      name: created_at
      description: Filter by a creation date range.
      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: Filter by an update date range.
      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: Filter by a deletion date range.
      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-codegen:
    method: list
    queryParams: AdminGetPriceListPaginationParams
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/admin_price-lists/get.js
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_price-lists/get.sh
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Price Lists
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminPriceListsListRes.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
post:
  operationId: PostPriceListsPriceList
  summary: Create a Price List
  description: Create a Price List.
  x-authenticated: true
  requestBody:
    content:
      application/json:
        schema:
          $ref: ../components/schemas/AdminPostPriceListsPriceListReq.yaml
  x-codegen:
    method: create
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/admin_price-lists/post.js
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_price-lists/post.sh
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Price Lists
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminPriceListRes.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