Koha/api/v1/swagger/paths/acquisitions_vendors.yaml

---
/acquisitions/vendors:
  get:
    x-mojo-to: Acquisitions::Vendors#list
    operationId: listVendors
    tags:
      - vendors
    summary: List vendors
    produces:
      - application/json
    parameters:
      - name: name
        in: query
        description: Case insensitive search on vendor name
        required: false
        type: string
      - name: accountnumber
        in: query
        description: Case insensitive search on vendor's account number
        required: false
        type: string
      - $ref: "../swagger.yaml#/parameters/match"
      - $ref: "../swagger.yaml#/parameters/order_by"
      - $ref: "../swagger.yaml#/parameters/page"
      - $ref: "../swagger.yaml#/parameters/per_page"
      - $ref: "../swagger.yaml#/parameters/q_param"
      - $ref: "../swagger.yaml#/parameters/q_body"
      - $ref: "../swagger.yaml#/parameters/request_id_header"
      - name: x-koha-embed
        in: header
        required: false
        description: Embed list sent as a request header
        type: array
        items:
          type: string
          enum:
            - aliases
        collectionFormat: csv
    responses:
      "200":
        description: A list of vendors
        schema:
          type: array
          items:
            $ref: "../swagger.yaml#/definitions/vendor"
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: Vendor not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        acquisition: vendors_manage
  post:
    x-mojo-to: Acquisitions::Vendors#add
    operationId: addVendor
    tags:
      - vendors
    summary: Add vendor
    parameters:
      - name: body
        in: body
        description: A JSON object representing a vendor
        required: true
        schema:
          $ref: "../swagger.yaml#/definitions/vendor"
    produces:
      - application/json
    responses:
      "201":
        description: Vendor added
        schema:
          $ref: "../swagger.yaml#/definitions/vendor"
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: Vendor not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        acquisition: vendors_manage
"/acquisitions/vendors/{vendor_id}":
  get:
    x-mojo-to: Acquisitions::Vendors#get
    operationId: getVendor
    tags:
      - vendors
    summary: Get vendor
    parameters:
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
    produces:
      - application/json
    responses:
      "200":
        description: A vendor
        schema:
          $ref: "../swagger.yaml#/definitions/vendor"
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: Vendor not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        acquisition: vendors_manage
  put:
    x-mojo-to: Acquisitions::Vendors#update
    operationId: updateVendor
    tags:
      - vendors
    summary: Update vendor
    parameters:
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
      - name: body
        in: body
        description: A JSON object representing a vendor
        required: true
        schema:
          $ref: "../swagger.yaml#/definitions/vendor"
    produces:
      - application/json
    responses:
      "200":
        description: A vendor
        schema:
          $ref: "../swagger.yaml#/definitions/vendor"
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: Vendor not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        acquisition: vendors_manage
  delete:
    x-mojo-to: Acquisitions::Vendors#delete
    operationId: deleteVendor
    tags:
      - vendors
    summary: Delete vendor
    parameters:
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
    produces:
      - application/json
    responses:
      "204":
        description: Vendor deleted
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: Vendor not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        acquisition: vendors_manage