4 x-mojo-to: Acquisitions::Orders#list
5 operationId: listOrders
14 description: Identifier for a linked bibliographic record
19 description: Identifier for a linked acquisition basket
24 description: Identifier for the fund the order goes against
29 description: Current status for the order. Can be 'new', 'ordered', 'partial',
30 'complete' or 'cancelled'
35 description: If only active orders should be listed
38 - $ref: "../swagger.yaml#/parameters/match"
39 - $ref: "../swagger.yaml#/parameters/order_by"
40 - $ref: "../swagger.yaml#/parameters/page"
41 - $ref: "../swagger.yaml#/parameters/per_page"
42 - $ref: "../swagger.yaml#/parameters/q_param"
43 - $ref: "../swagger.yaml#/parameters/q_body"
44 - $ref: "../swagger.yaml#/parameters/q_header"
45 - $ref: "../swagger.yaml#/parameters/request_id_header"
49 description: Embed list sent as a request header
58 - biblio.active_orders+count
61 - biblio.suggestions.suggester
63 - current_item_level_holds+count
70 description: A list of orders
74 $ref: "../swagger.yaml#/definitions/order"
76 description: Authentication required
78 $ref: "../swagger.yaml#/definitions/error"
80 description: Access forbidden
82 $ref: "../swagger.yaml#/definitions/error"
84 description: Order not found
86 $ref: "../swagger.yaml#/definitions/error"
89 Internal server error. Possible `error_code` attribute values:
91 * `internal_server_error`
93 $ref: "../swagger.yaml#/definitions/error"
95 description: Under maintenance
97 $ref: "../swagger.yaml#/definitions/error"
104 x-mojo-to: Acquisitions::Orders#add
105 operationId: addOrder
112 description: A JSON object representing an order
115 $ref: "../swagger.yaml#/definitions/order"
120 description: Order added
122 $ref: "../swagger.yaml#/definitions/order"
124 description: Bad request
126 $ref: "../swagger.yaml#/definitions/error"
128 description: Authentication required
130 $ref: "../swagger.yaml#/definitions/error"
132 description: Access forbidden
134 $ref: "../swagger.yaml#/definitions/error"
136 description: Conflict in creating the resource
138 $ref: "../swagger.yaml#/definitions/error"
141 Internal server error. Possible `error_code` attribute values:
143 * `internal_server_error`
145 $ref: "../swagger.yaml#/definitions/error"
147 description: Under maintenance
149 $ref: "../swagger.yaml#/definitions/error"
150 x-koha-authorization:
152 acquisition: order_manage
153 "/acquisitions/orders/{order_id}":
155 x-mojo-to: Acquisitions::Orders#get
156 operationId: getOrder
161 - $ref: "../swagger.yaml#/parameters/order_id_pp"
165 description: Embed list sent as a request header
171 - basket.basket_group
174 - biblio.active_orders+count
177 - biblio.suggestions.suggester
179 - current_item_level_holds+count
183 collectionFormat: csv
188 description: An order
190 $ref: "../swagger.yaml#/definitions/order"
192 description: Authentication required
194 $ref: "../swagger.yaml#/definitions/error"
196 description: Access forbidden
198 $ref: "../swagger.yaml#/definitions/error"
200 description: Order not found
202 $ref: "../swagger.yaml#/definitions/error"
205 Internal server error. Possible `error_code` attribute values:
207 * `internal_server_error`
209 $ref: "../swagger.yaml#/definitions/error"
211 description: Under maintenance
213 $ref: "../swagger.yaml#/definitions/error"
214 x-koha-authorization:
216 acquisition: order_manage
218 x-mojo-to: Acquisitions::Orders#update
219 operationId: updateOrder
222 summary: Update order
224 - $ref: "../swagger.yaml#/parameters/order_id_pp"
227 description: A JSON object representing an order
230 $ref: "../swagger.yaml#/definitions/order"
235 description: An order
237 $ref: "../swagger.yaml#/definitions/order"
239 description: Authentication required
241 $ref: "../swagger.yaml#/definitions/error"
243 description: Access forbidden
245 $ref: "../swagger.yaml#/definitions/error"
247 description: Order not found
249 $ref: "../swagger.yaml#/definitions/error"
252 Internal server error. Possible `error_code` attribute values:
254 * `internal_server_error`
256 $ref: "../swagger.yaml#/definitions/error"
258 description: Under maintenance
260 $ref: "../swagger.yaml#/definitions/error"
261 x-koha-authorization:
263 acquisition: order_manage
265 x-mojo-to: Acquisitions::Orders#delete
266 operationId: deleteOrder
269 summary: Delete order
271 - $ref: "../swagger.yaml#/parameters/order_id_pp"
276 description: Order deleted
278 description: Authentication required
280 $ref: "../swagger.yaml#/definitions/error"
282 description: Access forbidden
284 $ref: "../swagger.yaml#/definitions/error"
286 description: Order not found
288 $ref: "../swagger.yaml#/definitions/error"
291 Internal server error. Possible `error_code` attribute values:
293 * `internal_server_error`
295 $ref: "../swagger.yaml#/definitions/error"
297 description: Under maintenance
299 $ref: "../swagger.yaml#/definitions/error"
300 x-koha-authorization:
302 acquisition: order_manage