Tomas Cohen Arazi
5cd9c904c4
This patch introduces the OpenAPI definitions required for the orders endpoint. It matches the voted RFC. Sponsored-by: Camden County Signed-off-by: Matthias Meusburger <matthias.meusburger@biblibre.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
328 lines
8.5 KiB
JSON
328 lines
8.5 KiB
JSON
{
|
|
"type": "object",
|
|
"properties": {
|
|
"order_id": {
|
|
"type": "integer",
|
|
"description": "Internally assigned order identifier"
|
|
},
|
|
"biblio_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Identifier for the linked bibliographic record"
|
|
},
|
|
"created_by": {
|
|
"type": "integer",
|
|
"description": "Interal patron identifier of the order line creator"
|
|
},
|
|
"entry_date": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "date",
|
|
"description": "Date the bib was added to the basket"
|
|
},
|
|
"quantity": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Ordered quantity"
|
|
},
|
|
"currency": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Currency used for the purchase"
|
|
},
|
|
"list_price": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Vendor price for the line item"
|
|
},
|
|
"replacement_price": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Replacement cost for this item"
|
|
},
|
|
"date_received": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "date",
|
|
"description": "Date the order was received"
|
|
},
|
|
"invoice_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Id of the order invoice"
|
|
},
|
|
"shipping_cost": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Shipping cost"
|
|
},
|
|
"unit_price": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "The actual cost entered when receiving this line item"
|
|
},
|
|
"unit_price_tax_excluded": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Unit price excluding tax (on receiving)"
|
|
},
|
|
"unit_price_tax_included": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Unit price including tax (on receiving)"
|
|
},
|
|
"quantity_received": {
|
|
"type": "integer",
|
|
"description": "Quantity received so far"
|
|
},
|
|
"cancellation_date": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "date",
|
|
"description": "Date the line item was deleted"
|
|
},
|
|
"cancellation_reason": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Reason of cancellation"
|
|
},
|
|
"internal_note": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Notes related to this order line, made for staff"
|
|
},
|
|
"vendor_note": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Notes related to this order line, made for vendor"
|
|
},
|
|
"basket_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Basket this order is linked to"
|
|
},
|
|
"timestamp": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Date and time this order line was last modified"
|
|
},
|
|
"rrp": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Retail cost for this item"
|
|
},
|
|
"rrp_tax_excluded": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Replacement cost for this item (tax excluded)"
|
|
},
|
|
"rrp_tax_included": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Replacement cost for this item (tax included)"
|
|
},
|
|
"ecost": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Effective cost"
|
|
},
|
|
"ecost_tax_excluded": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Effective cost (tax excluded)"
|
|
},
|
|
"ecost_tax_included": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Effective cost (tax included)"
|
|
},
|
|
"tax_rate_on_ordering": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Tax rate on ordering (%)"
|
|
},
|
|
"tax_rate_on_receiving": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Tax rate on receiving (%)"
|
|
},
|
|
"tax_value_on_ordering": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Tax value on ordering"
|
|
},
|
|
"tax_value_on_receiving": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Tax value on receiving"
|
|
},
|
|
"discount_rate": {
|
|
"type": [
|
|
"number",
|
|
"null"
|
|
],
|
|
"description": "Discount rate"
|
|
},
|
|
"fund_id": {
|
|
"type": "integer",
|
|
"description": "Internal identifier for the fund this order goes against"
|
|
},
|
|
"statistics_1": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Statistical field"
|
|
},
|
|
"statistics_2": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Statistical field (2)"
|
|
},
|
|
"statistics_1_authcat": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Statistical category for this order"
|
|
},
|
|
"statistics_2_authcat": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Statistical category for this order (2)"
|
|
},
|
|
"uncertain_price": {
|
|
"type": "boolean",
|
|
"description": "If this price was uncertain"
|
|
},
|
|
"claims_count": {
|
|
"type": "integer",
|
|
"description": "Generated claim letters count"
|
|
},
|
|
"last_claim_date": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "date",
|
|
"description": "Last date a claim letter was generated"
|
|
},
|
|
"subscription_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Subscription ID linking the order to a subscription"
|
|
},
|
|
"parent_order_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Order ID of parent order line if exists"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"new",
|
|
"ordered",
|
|
"partial",
|
|
"complete",
|
|
"cancelled"
|
|
],
|
|
"description": "The current order status"
|
|
},
|
|
"basket": {
|
|
"type": [
|
|
"object",
|
|
"null"
|
|
]
|
|
},
|
|
"biblio": {
|
|
"type": [
|
|
"object",
|
|
"null"
|
|
]
|
|
},
|
|
"fund": {
|
|
"type": [
|
|
"object",
|
|
"null"
|
|
]
|
|
},
|
|
"invoice": {
|
|
"type": [
|
|
"object",
|
|
"null"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array"
|
|
},
|
|
"subscription": {
|
|
"type": [
|
|
"object",
|
|
"null"
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|