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

post:
  operationId: PostPriceListsPriceList
  summary: Create a Price List
  description: Creates a Price List
  x-authenticated: true
  requestBody:
    content:
      application/json:
        schema:
          $ref: ../components/schemas/AdminPostPriceListsPriceListReq.yaml
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/price-lists/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/price-lists/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Price List
  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
get:
  operationId: GetPriceLists
  summary: List Price Lists
  description: Retrieves a list of Price Lists.
  x-authenticated: true
  parameters:
    - in: query
      name: limit
      description: The number of items to get
      schema:
        type: number
        default: '10'
    - in: query
      name: offset
      description: The offset at which to get items
      schema:
        type: number
        default: '0'
    - in: query
      name: expand
      description: >-
        (Comma separated) Which fields should be expanded in each item of the
        result.
      schema:
        type: string
    - in: query
      name: order
      description: field to order results by.
      schema:
        type: string
    - in: query
      name: id
      description: ID to search for.
      schema:
        type: string
    - in: query
      name: q
      description: >-
        query to search in price list description, price list name, and customer
        group name fields.
      schema:
        type: string
    - in: query
      name: status
      style: form
      explode: false
      description: Status to search for.
      schema:
        type: array
        items:
          type: string
          enum:
            - active
            - draft
    - in: query
      name: name
      description: price list name to search for.
      schema:
        type: string
    - in: query
      name: customer_groups
      style: form
      explode: false
      description: Customer Group IDs to search for.
      schema:
        type: array
        items:
          type: string
    - in: query
      name: type
      style: form
      explode: false
      description: Type to search for.
      schema:
        type: array
        items:
          type: string
          enum:
            - sale
            - override
    - in: query
      name: created_at
      description: Date comparison for when resulting price lists 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 price lists 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 price lists 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/price-lists/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/price-lists/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Price List
  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