FOLIO Orders API

openapi: 3.2.0
info:
  title: Folio Orders API
  version: 0.0.1
  description: 'Operations tagged Orders across 4 of this provider''s published API definitions: folio-mod-ebsconet-openapi.json, folio-mod-mosaic-openapi.json, folio-mod-ebsconet-openapi.yml, folio-mod-mosaic-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /ebsconet/
- url: /mosaic
tags:
- name: Orders
paths:
  /orders/order-lines/{poLineNumber}:
    description: Orders API
    get:
      summary: Get single Ebsconet product order line
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ebsconet_order_line'
        '400':
          description: Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
          content:
            application/json:
              example:
                value:
                  $ref: examples/error.sample
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Purchase order line with a given number not found
          content:
            application/json:
              example:
                value:
                  $ref: examples/error.sample
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error, e.g. due to misconfiguration
          content:
            application/json:
              example:
                value:
                  $ref: examples/error.sample
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getEbsconetOrderLine
      parameters:
      - name: poLineNumber
        in: path
        description: product order line number
        required: true
        schema:
          $ref: '#/components/schemas/order_line_number'
      tags:
      - Orders
    put:
      summary: Save single Ebsconet product order line
      responses:
        '200':
          description: OK
        '400':
          description: Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
          content:
            application/json:
              example:
                value:
                  $ref: examples/error.sample
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error, e.g. due to misconfiguration
          content:
            application/json:
              example:
                value:
                  $ref: examples/error.sample
              schema:
                $ref: '#/components/schemas/Error'
      operationId: putEbsconetOrderLine
      parameters:
      - name: poLineNumber
        in: path
        description: product order line number
        required: true
        schema:
          $ref: '#/components/schemas/order_line_number'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ebsconet_order_line'
        required: true
      tags:
      - Orders
    servers:
    - url: /ebsconet/
  /orders:
    description: Orders API
    post:
      summary: Create a new order in FOLIO
      operationId: createMosaicOrder
      requestBody:
        $ref: '#/components/requestBodies/MosaicOrderRequest'
      responses:
        '201':
          description: Order successfully created, returns the POL number
          content:
            text/plain:
              schema:
                type: string
              example: 10001-1
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Orders
    servers:
    - url: /mosaic
components:
  schemas:
    workflow_status:
      $schema: http://json-schema.org/draft-04/schema#
      description: Composite workflow status
      type: string
      enum:
      - Pending
      - Open
      - Closed
      default: Pending
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters'
      additionalProperties: false
      required:
      - message
    order_line_number:
      id: po_line_number
      $schema: http://json-schema.org/draft-04/schema#
      description: A human readable number, assigned to this product order line
      type: string
      pattern: ^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$
    Parameter:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
      additionalProperties: false
      required:
      - key
    reference_number_item:
      id: reference_number_item
      $schema: http://json-schema.org/draft-04/schema#
      description: Reference number item
      type: object
      properties:
        refNumber:
          description: a reference number for this purchase order line
          type: string
        refNumberType:
          description: the reference number type
          type: string
          enum:
          - Vendor continuation reference number
          - Vendor order reference number
          - Vendor subscription reference number
          - Vendor internal number
          - Vendor title number
      additionalProperties: false
    ebsconet_order_line:
      id: ebsconet_order_line
      $schema: http://json-schema.org/draft-04/schema#
      description: Ebsconet order line integration schema
      type: object
      properties:
        cancellationRestriction:
          type: boolean
          description: Whether or not there are cancellation restrictions for this purchase order line
          readOnly: false
        cancellationRestrictionNote:
          type: string
          description: Free-form notes related to cancellation restrictions
          readOnly: false
        currency:
          type: string
          description: An ISO currency code
          readOnly: false
        fundCode:
          type: string
          description: Fund distribution code
          readOnly: false
        poLineNumber:
          $ref: '#/components/schemas/order_line_number'
          description: A human readable number assigned to this PO line
          readOnly: true
        publisherName:
          type: string
          description: Publisher of the material
          readOnly: false
        internalNote:
          type: string
          description: Renewal note for this purchase order line
        quantity:
          type: integer
          description: Quantity of physical items or resources of 'Other' order format in this purchase order line
          readOnly: false
        subscriptionFromDate:
          type:
          - string
          - 'null'
          description: the start date of the subscription
          format: date-time
          readOnly: false
        subscriptionToDate:
          type:
          - string
          - 'null'
          description: the end date of the subscription
          format: date-time
          readOnly: false
        unitPrice:
          type: number
          description: The per-item list price for physical or resources of 'Other' order format
          readOnly: false
        vendor:
          type: string
          description: Vendor code
          maxLength: 55
          pattern: '[\S ]+'
          readOnly: true
        vendorAccountNumber:
          type: string
          description: Account number on the vendor's end associated with this purchase order line
          readOnly: false
        vendorReferenceNumbers:
          type: array
          description: Reference number items array
          items:
            $ref: '#/components/schemas/reference_number_item'
        workflowStatus:
          $ref: '#/components/schemas/workflow_status'
          description: the workflow status for the purchase order
          readOnly: true
        type:
          type: string
          description: Set to non-renewal to cancel the purchase order line
          readOnly: true
          pattern: ^([Rr][Ee][Nn][Ee][Ww][Aa][Ll]|[Nn][Oo][Nn][-][Rr][Ee][Nn][Ee][Ww][Aa][Ll])$
        customerNote:
          type: string
          description: customerNote on the ebsconet's end can be associated with this purchase order line
          readOnly: false
      required:
      - currency
      - poLineNumber
    Parameters:
      type: array
      items:
        $ref: '#/components/schemas/Parameter'
      additionalProperties: false
    Error_2:
      description: An error
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters_2'
      additionalProperties: false
      required:
      - message
    MosaicOrder:
      type: object
      properties:
        id:
          type: string
          description: The UUID format string
        title:
          type: string
          description: title of the material
        assignedTo:
          type: string
          description: The UUID format string
        contributors:
          type: array
          items:
            type: object
          description: list of contributors to the material
        publicationDate:
          type: string
          description: date (year) of the material's publication
        edition:
          type: string
          description: edition of the material
        details:
          type: object
          description: details about this purchase order line
        requesterName:
          type: string
          description: who requested this purchase order line
        selectorName:
          type: string
          description: who selected this material
        notes:
          type: array
          items:
            type: string
          description: free-form notes associated with this mosaic order
        poLineDescription:
          type: string
          description: description for poLine
        internalNote:
          type: string
          description: Internal note for this purchase order line
        renewalNote:
          type: string
          description: Renewal note for this purchase order line
        referenceNumbers:
          type: object
          description: Collection of reference number items
        listUnitPrice:
          type: number
          description: The per-item list price for physical or resources of 'Other' order format
        listUnitPriceElectronic:
          type: number
          description: The e-resource per-item list price
        currency:
          type: string
          description: An ISO currency code
        quantityPhysical:
          type: integer
          description: Quantity of physical items or resources of 'Other' order format
        quantityElectronic:
          type: integer
          description: Quantity of electronic items in this purchase order line
        additionalCost:
          type: number
          description: Lump sum that is added to the total estimated price - not affected by discount
        discount:
          type: number
          description: Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost
        discountType:
          type: string
          enum:
          - amount
          - percentage
          default: percentage
          description: Percentage or amount discount type. Only applied when 'discount' is also provided; otherwise the template value is preserved.
        locations:
          type: array
          items:
            type: object
          description: Location records for this purchase order line
        fundDistribution:
          type: array
          items:
            type: object
          description: Fund distribution records for this purchase order line
        acquisitionMethod:
          type: string
          description: UUID of the acquisition method for this purchase order line
        acqUnitIds:
          type: array
          items:
            type: string
          description: acquisition unit ids associated with this purchase order
        billTo:
          type: string
          description: UUID for the billing address
        shipTo:
          type: string
          description: UUID for the shipping address
        vendor:
          type: string
          description: UUID for the vendor organization
        workflowStatus:
          type: string
          description: the workflow status for this purchase order
        format:
          type: string
          description: Order format (Physical Resource, Electronic Resource, P/E mix, Other)
        physical:
          type: object
          description: details of this purchase order line relating to physical materials
        eresource:
          type: object
          description: eresource-related details of this purchase order line
        checkinItems:
          type: boolean
          description: receiving workflow flag
        customFields:
          type: array
          items:
            type: object
          description: Mosaic custom fields for either the PO or POL
        metadata:
          type: object
          description: Metadata about creation and changes to records
    Errors:
      description: A set of errors
      type: object
      properties:
        errors:
          description: List of errors
          type: array
          items:
            $ref: '#/components/schemas/Error_2'
        total_records:
          description: Total number of errors
          type: integer
      additionalProperties: false
    Parameter_2:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          type: string
          minLength: 1
        value:
          type: string
      additionalProperties: false
      required:
      - key
    MosaicOrderRequest:
      type: object
      properties:
        orderTemplateId:
          type: string
          description: The UUID format string
        orderData:
          $ref: '#/components/schemas/MosaicOrder'
          description: the mosaic order
      required:
      - orderData
    Parameters_2:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter_2'
    Error_3:
      description: An error
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters_3'
      additionalProperties: false
      required:
      - message
    Errors_2:
      description: A set of errors
      type: object
      properties:
        errors:
          description: List of errors
          type: array
          items:
            $ref: '#/components/schemas/Error_3'
        total_records:
          description: Total number of errors
          type: integer
      additionalProperties: false
    Parameter_3:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          type: string
          minLength: 1
        value:
          type: string
      additionalProperties: false
      required:
      - key
    Parameters_3:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter_3'
  responses:
    InternalServerError:
      description: Internal server error, e.g. due to misconfiguration
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    BadRequest:
      description: Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  requestBodies:
    MosaicOrderRequest:
      description: Mosaic Order object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MosaicOrderRequest'
x-refined-from:
- folio-mod-ebsconet-openapi.json
- folio-mod-mosaic-openapi.json
- folio-mod-ebsconet-openapi.yml
- folio-mod-mosaic-openapi.yml