Order-lines API documentation

Purchase Order Lines

Manage purchase order (PO) lines

/orders/order-lines get post

get

Retrieve a list of order-line items.

post

Post a PO lines to corresponding PO

Retrieve a list of order-line items.

Request
Response

Query Parameters

offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
```
10
```
query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
using CQL (indexes for PO lines)
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

payment_status=="Cancelled"
```
lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 200

Returns a list of order-line items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of purchase order line records",
  "type": "object",
  "properties": {
    "poLines": {
      "description": "collection of purchase order line records",
      "type": "array",
      "id": "poLines",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "purchase order line",
        "properties": {
          "id": {
            "description": "UUID identifying this purchase order line",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "edition": {
            "description": "edition of the material",
            "type": "string"
          },
          "checkinItems": {
            "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
            "type": "boolean",
            "default": false
          },
          "agreementId": {
            "description": "UUID of the agreement this purchase order line is related to",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "acquisitionMethod": {
            "description": "the acquisition method for this purchase order line",
            "type": "string",
            "enum": [
              "Approval Plan",
              "Demand Driven Acquisitions (DDA)",
              "Depository",
              "Evidence Based Acquisitions (EBA)",
              "Exchange",
              "Gift",
              "Purchase At Vendor System",
              "Purchase",
              "Technical"
            ]
          },
          "alerts": {
            "description": "an array of alert record IDs",
            "id": "alerts",
            "type": "array",
            "items": {
              "description": "UUID of an alert record",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            }
          },
          "cancellationRestriction": {
            "description": "whether or not there are cancellation restrictions for this purchase order line",
            "type": "boolean"
          },
          "cancellationRestrictionNote": {
            "description": "free-form notes related to cancellation restrictions",
            "type": "string"
          },
          "claims": {
            "description": "list of claims",
            "id": "claims",
            "type": "array",
            "items": {
              "description": "claim record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "claimed": {
                  "description": "whether or not this purchase order line has been claimed",
                  "type": "boolean",
                  "default": false
                },
                "sent": {
                  "description": "date a claim was sent",
                  "type": "string",
                  "format": "date-time"
                },
                "grace": {
                  "description": "the number of days after the expected receipt date during which claims should not be processed",
                  "type": "integer"
                }
              },
              "additionalProperties": false
            }
          },
          "collection": {
            "description": "whether or not this purchase order line is for a collection",
            "type": "boolean",
            "default": false
          },
          "contributors": {
            "description": "list of contributors to the material",
            "id": "contributors",
            "type": "array",
            "items": {
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "description": "contributor to the material",
              "properties": {
                "contributor": {
                  "description": "the name of a contributor to the material",
                  "type": "string"
                },
                "contributorNameTypeId": {
                  "description": "UUID of the contributor type",
                  "type": "string",
                  "pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "contributorNameTypeId"
              ]
            }
          },
          "cost": {
            "description": "cost record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "listUnitPrice": {
                "description": "The per-item list price for physical or resources of 'Other' order format",
                "type": "number"
              },
              "listUnitPriceElectronic": {
                "description": "The e-resource per-item list price",
                "type": "number"
              },
              "currency": {
                "description": "An ISO currency code",
                "type": "string"
              },
              "additionalCost": {
                "description": "Lump sum that is added to the total estimated price - not affected by discount",
                "type": "number"
              },
              "discount": {
                "description": "Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost",
                "type": "number"
              },
              "discountType": {
                "description": "Percentage or amount discount type",
                "type": "string",
                "enum": [
                  "amount",
                  "percentage"
                ],
                "default": "percentage"
              },
              "exchangeRate": {
                "description": "Exchange rate",
                "type": "number"
              },
              "quantityPhysical": {
                "description": "Quantity of physical items or resources of 'Other' order format in this purchase order line",
                "type": "integer"
              },
              "quantityElectronic": {
                "description": "Quantity of electronic items in this purchase order line",
                "type": "integer"
              },
              "poLineEstimatedPrice": {
                "description": "The calculated total estimated price for this purchase order line: list price time quantities minus discount amount plus additional cost",
                "type": "number"
              },
              "fyroAdjustmentAmount": {
                "description": "Adjustment amount if rollover was happen",
                "type": "number"
              }
            },
            "additionalProperties": false,
            "required": [
              "currency"
            ]
          },
          "description": {
            "description": "description of the material",
            "type": "string"
          },
          "details": {
            "description": "details record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "receivingNote": {
                "description": "notes regarding receiving instructions",
                "type": "string"
              },
              "productIds": {
                "description": "a list of product identifiers",
                "id": "productIds",
                "type": "array",
                "items": {
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "description": "Product identifier",
                  "type": "object",
                  "properties": {
                    "productId": {
                      "description": "The actual product identifier",
                      "type": "string"
                    },
                    "productIdType": {
                      "description": "The type of product identifier",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "type": "string",
                      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                    },
                    "qualifier": {
                      "description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "subscriptionFrom": {
                "description": "the start date of the subscription",
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "subscriptionInterval": {
                "description": "the subscription interval in days",
                "type": "integer"
              },
              "subscriptionTo": {
                "description": "the end date of the subscription",
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              }
            },
            "additionalProperties": false
          },
          "donor": {
            "description": "the donor contributing to this purchase order line",
            "type": "string"
          },
          "eresource": {
            "description": "eresource record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "activated": {
                "description": "whether or not this resource is activated",
                "type": "boolean",
                "default": false
              },
              "activationDue": {
                "description": "number of days until activation, from date of order placement",
                "type": "integer"
              },
              "createInventory": {
                "description": "Shows what inventory objects need to be created for electronic resource",
                "type": "string",
                "enum": [
                  "Instance, Holding, Item",
                  "Instance, Holding",
                  "Instance",
                  "None"
                ]
              },
              "trial": {
                "description": "whether or not this is a trial",
                "type": "boolean",
                "default": false
              },
              "expectedActivation": {
                "description": "expected date the resource will be activated",
                "type": "string",
                "format": "date-time"
              },
              "userLimit": {
                "description": "the concurrent user-limit",
                "type": "integer"
              },
              "accessProvider": {
                "description": "UUID of the access provider",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "license": {
                "description": "License record",
                "type": "object",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "properties": {
                  "code": {
                    "description": "license code",
                    "type": "string"
                  },
                  "description": {
                    "description": "license description",
                    "type": "string"
                  },
                  "reference": {
                    "description": "license reference",
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "materialType": {
                "description": "UUID of the material Type",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "resourceUrl": {
                "description": "Electronic resource can be access via this URL",
                "type": "string",
                "pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
              }
            },
            "additionalProperties": false
          },
          "fundDistribution": {
            "description": "Fund distribution records for this purchase order line",
            "id": "fundDistribution",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "the fund code",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "value": {
                  "description": "The value of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "instanceId": {
            "description": "UUID of the instance record this purchase order line is related to",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "isPackage": {
            "description": "Indicates that this POL is for a package",
            "type": "boolean",
            "default": false
          },
          "locations": {
            "description": "Location records for this purchase order line",
            "id": "locations",
            "type": "array",
            "items": {
              "description": "location record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "locationId": {
                  "description": "UUID of the (inventory) location record",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "quantity": {
                  "description": "combined/total quanitity of physical and electronic items",
                  "type": "integer"
                },
                "quantityElectronic": {
                  "description": "quantity of electronic items",
                  "type": "integer"
                },
                "quantityPhysical": {
                  "description": "quantity of physical items",
                  "type": "integer"
                }
              },
              "additionalProperties": false,
              "required": [
                "locationId"
              ]
            }
          },
          "orderFormat": {
            "description": "The purchase order line format",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "enum": [
              "Electronic Resource",
              "P/E Mix",
              "Physical Resource",
              "Other"
            ]
          },
          "packagePoLineId": {
            "description": "UUID referencing the poLine that represents the package that this POLs title belongs to",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "paymentStatus": {
            "description": "The purchase order line payment status",
            "type": "string",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "enum": [
              "Awaiting Payment",
              "Cancelled",
              "Fully Paid",
              "Partially Paid",
              "Payment Not Required",
              "Pending",
              "Ongoing"
            ],
            "default": "Pending"
          },
          "physical": {
            "description": "UUID of the physical (details) record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "createInventory": {
                "description": "Shows what inventory objects need to be created for physical resource",
                "type": "string",
                "enum": [
                  "Instance, Holding, Item",
                  "Instance, Holding",
                  "Instance",
                  "None"
                ]
              },
              "materialType": {
                "description": "UUID of the material Type",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "materialSupplier": {
                "description": "UUID of the material supplier record",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "expectedReceiptDate": {
                "description": "vendor agreed date prior to the Receipt Due date item is expected to be received by",
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "receiptDue": {
                "description": "date item should be received by",
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "volumes": {
                "description": "list of volumes included to the physical material",
                "type": "array",
                "items": {
                  "description": "the identifier of volume",
                  "type": "string"
                }
              }
            },
            "additionalProperties": false,
            "required": [
              "volumes"
            ]
          },
          "poLineDescription": {
            "description": "purchase order line description",
            "type": "string"
          },
          "poLineNumber": {
            "description": "A human readable number assigned to this PO line",
            "type": "string",
            "pattern": "^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$"
          },
          "publicationDate": {
            "description": "date (year) of the material's publication",
            "type": "string",
            "pattern": "^[0-9]{4}$"
          },
          "publisher": {
            "description": "publisher of the material",
            "type": "string"
          },
          "purchaseOrderId": {
            "description": "UUID of the purchase order",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "receiptDate": {
            "description": "date the purchase order line was received",
            "type": [
              "null",
              "string"
            ],
            "format": "date-time"
          },
          "receiptStatus": {
            "description": "The purchase order line receipt status",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "enum": [
              "Awaiting Receipt",
              "Cancelled",
              "Fully Received",
              "Partially Received",
              "Pending",
              "Receipt Not Required",
              "Ongoing"
            ],
            "default": "Pending"
          },
          "reportingCodes": {
            "description": "a list of reporting codes associated with this purchase order line",
            "id": "reportingCodes",
            "type": "array",
            "items": {
              "description": "UUID of the reporting code",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            }
          },
          "requester": {
            "description": "who requested this purchase order line",
            "type": "string"
          },
          "rush": {
            "description": "whether or not this is a rush order",
            "type": "boolean",
            "default": false
          },
          "selector": {
            "description": "who selected this material",
            "type": "string"
          },
          "source": {
            "description": "the source of this purchase order line",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "enum": [
              "User",
              "API",
              "EDI",
              "MARC"
            ]
          },
          "tags": {
            "description": "arbitrary tags associated with this purchase order line",
            "id": "tags",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "tags",
            "properties": {
              "tagList": {
                "description": "List of tags",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "titleOrPackage": {
            "description": "title of the material",
            "type": "string"
          },
          "vendorDetail": {
            "description": "Vendor detail record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "instructions": {
                "description": "special instructions for the vendor",
                "type": "string"
              },
              "noteFromVendor": {
                "description": "free-form notes from the vendor",
                "type": "string"
              },
              "refNumber": {
                "description": "a reference number for this purchase order line",
                "type": "string"
              },
              "refNumberType": {
                "description": "the reference number type",
                "type": "string",
                "enum": [
                  "Supplier's continuation order",
                  "Supplier's unique order line reference number",
                  "Agent's unique subscription reference number",
                  "Library's continuation order number",
                  "Internal vendor number"
                ]
              },
              "vendorAccount": {
                "description": "the accound number on the vendor's end associated with this purchase order line",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "instructions"
            ]
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "orderFormat",
          "source",
          "purchaseOrderId",
          "titleOrPackage"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "poLines",
    "totalRecords"
  ]
}

Example:

{
    "poLines": [
      {
        "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
        "edition": "First edition",
        "checkinItems": false,
        "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
        "isPackage": false,
        "agreementId": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
        "acquisitionMethod": "Purchase At Vendor System",
        "alerts": [
          "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
        ],
        "cancellationRestriction": false,
        "cancellationRestrictionNote": "ABCDEFGHIJKLMNOPQRSTUVW",
        "claims": [
          {
            "claimed": false,
            "sent": "2018-10-09T00:00:00.000Z",
            "grace": 30
          }
        ],
        "collection": false,
        "contributors": [
          {
            "contributor": "Ed Mashburn",
            "contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
          }
        ],
        "cost": {
          "additionalCost": 4.99,
          "currency": "USD",
          "discount": 10,
          "discountType": "percentage",
          "exchangeRate": 1.12,
          "listUnitPriceElectronic": 24.99,
          "quantityElectronic": 2,
          "poLineEstimatedPrice": 49.97
        },
        "description": "ABCDEFGH",
        "details": {
          "receivingNote": "ABCDEFGHIJKL",
          "productIds": [
            {
              "productId": "9780764354113",
              "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
              "qualifier": "(paperback)"
            }
          ],
          "subscriptionFrom": "2018-10-09T00:00:00.000Z",
          "subscriptionInterval": 824,
          "subscriptionTo": "2020-10-09T00:00:00.000Z"
        },
        "donor": "ABCDEFGHIJKLM",
        "eresource": {
          "accessProvider": "ba3f3d45-247d-41f6-8dc9-6488adcad329",
          "activated": false,
          "activationDue": 10,
          "createInventory": "Instance, Holding",
          "expectedActivation": "2018-10-09T00:00:00.000Z",
          "license": {
            "code": "Code 1",
            "description": "License Agreement 1"
          },
          "materialType": "f7e72403-2a13-43a4-a069-aaabe6c9dea8",
          "trial": false,
          "userLimit": 10,
          "resourceUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
        },
        "fundDistribution": [
          {
            "code": "HIST",
            "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
            "distributionType": "percentage",
            "value": 100.0,
            "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
          }
        ],
        "locations": [
          {
            "locationId": "eb2d063a-5b4c-4cab-8db1-5fc5c5941df6",
            "quantity": 1,
            "quantityElectronic": 1
          },
          {
            "locationId": "53cf956f-c1df-410b-8bea-27f712cca7c0",
            "quantity": 1,
            "quantityElectronic": 1
          }
        ],
        "orderFormat": "Electronic Resource",
        "paymentStatus": "Awaiting Payment",
        "poLineDescription": "ABCDEFGHIJKLMNOPQRSTUVWXY",
        "poLineNumber": "268758-03",
        "publicationDate": "2017",
        "publisher": "Schiffer Publishing",
        "purchaseOrderId": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
        "receiptDate": "2018-10-09T00:00:00.000Z",
        "receiptStatus": "Awaiting Receipt",
        "reportingCodes": [
          "5926dcd7-85f5-4504-8283-712595ebc38b",
          "fa316c04-8101-4e72-8aaf-01281bac718f",
          "ea68b696-3125-4940-bf91-1d128323473e"
        ],
        "requester": "Leo Bulero",
        "rush": true,
        "selector": "ABCD",
        "source": "User",
        "tags": {
          "tagList": [
            "important"
          ]
        },
        "titleOrPackage": "Kayak Fishing in the Northern Gulf Coast",
        "vendorDetail": {
          "instructions": "ABCDEFG",
          "noteFromVendor": "ABCDEFGHIKJKLMNOP",
          "refNumber": "123456-78",
          "refNumberType": "Supplier's unique order line reference number",
          "vendorAccount": "8910-25"
        },
        "metadata": {
          "createdDate": "2018-07-19T00:00:00.000+0000",
          "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
        }
      }
    ],
    "totalRecords": 1
}

HTTP status code 400

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.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to list order-lines -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to list order-lines -- unauthorized

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Post a PO lines to corresponding PO

Request
Response

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "composite purchase order line with dereferenced/expanded orders fields",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID identifying this purchase order line",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "edition": {
      "description": "edition of the material",
      "type": "string"
    },
    "checkinItems": {
      "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
      "type": "boolean",
      "default": false
    },
    "instanceId": {
      "description": "UUID of the instance record this purchase order line is related to",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "agreementId": {
      "description": "UUID of the agreement this purchase order line is related to",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "acquisitionMethod": {
      "description": "the acquisition method for this purchase order line",
      "type": "string",
      "enum": [
        "Approval Plan",
        "Demand Driven Acquisitions (DDA)",
        "Depository",
        "Evidence Based Acquisitions (EBA)",
        "Exchange",
        "Gift",
        "Purchase At Vendor System",
        "Purchase",
        "Technical"
      ]
    },
    "alerts": {
      "description": "alerts associated with this purchase order line",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "an alert record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "id": {
            "description": "UUID of this alert record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "alert": {
            "description": "the alert text",
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "alert"
        ]
      }
    },
    "cancellationRestriction": {
      "description": "whether or not there are cancellation restrictions for this purchase order line",
      "type": "boolean"
    },
    "cancellationRestrictionNote": {
      "description": "free-form notes related to cancellation restrictions",
      "type": "string"
    },
    "claims": {
      "description": "claims associated with this purchase order line",
      "id": "claims",
      "type": "array",
      "items": {
        "description": "a claim record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "claimed": {
            "description": "whether or not this purchase order line has been claimed",
            "type": "boolean",
            "default": false
          },
          "sent": {
            "description": "date a claim was sent",
            "type": "string",
            "format": "date-time"
          },
          "grace": {
            "description": "the number of days after the expected receipt date during which claims should not be processed",
            "type": "integer"
          }
        },
        "additionalProperties": false
      }
    },
    "collection": {
      "description": "whether or not this purchase order line is for a collection",
      "type": "boolean"
    },
    "contributors": {
      "description": "list of contributors to the material",
      "id": "contributors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "contributor to the material",
        "properties": {
          "contributor": {
            "description": "the name of a contributor to the material",
            "type": "string"
          },
          "contributorNameTypeId": {
            "description": "UUID of the contributor type",
            "type": "string",
            "pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "contributorNameTypeId"
        ]
      }
    },
    "cost": {
      "description": "cost details associated with this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "listUnitPrice": {
          "description": "The per-item list price for physical or resources of 'Other' order format",
          "type": "number"
        },
        "listUnitPriceElectronic": {
          "description": "The e-resource per-item list price",
          "type": "number"
        },
        "currency": {
          "description": "An ISO currency code",
          "type": "string"
        },
        "additionalCost": {
          "description": "Lump sum that is added to the total estimated price - not affected by discount",
          "type": "number"
        },
        "discount": {
          "description": "Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost",
          "type": "number"
        },
        "discountType": {
          "description": "Percentage or amount discount type",
          "type": "string",
          "enum": [
            "amount",
            "percentage"
          ],
          "default": "percentage"
        },
        "exchangeRate": {
          "description": "Exchange rate",
          "type": "number"
        },
        "quantityPhysical": {
          "description": "Quantity of physical items or resources of 'Other' order format in this purchase order line",
          "type": "integer"
        },
        "quantityElectronic": {
          "description": "Quantity of electronic items in this purchase order line",
          "type": "integer"
        },
        "poLineEstimatedPrice": {
          "description": "The calculated total estimated price for this purchase order line: list price time quantities minus discount amount plus additional cost",
          "type": "number"
        },
        "fyroAdjustmentAmount": {
          "description": "Adjustment amount if rollover was happen",
          "type": "number"
        }
      },
      "additionalProperties": false,
      "required": [
        "currency"
      ]
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "details about this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "receivingNote": {
          "description": "notes regarding receiving instructions",
          "type": "string"
        },
        "productIds": {
          "description": "a list of product identifiers",
          "id": "productIds",
          "type": "array",
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "Product identifier",
            "type": "object",
            "properties": {
              "productId": {
                "description": "The actual product identifier",
                "type": "string"
              },
              "productIdType": {
                "description": "The type of product identifier",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "qualifier": {
                "description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "subscriptionFrom": {
          "description": "the start date of the subscription",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "subscriptionInterval": {
          "description": "the subscription interval in days",
          "type": "integer"
        },
        "subscriptionTo": {
          "description": "the end date of the subscription",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "eresource-related details of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "activated": {
          "description": "whether or not this resource is activated",
          "type": "boolean",
          "default": false
        },
        "activationDue": {
          "description": "number of days until activation, from date of order placement",
          "type": "integer"
        },
        "createInventory": {
          "description": "Shows what inventory objects need to be created for electronic resource",
          "type": "string",
          "enum": [
            "Instance, Holding, Item",
            "Instance, Holding",
            "Instance",
            "None"
          ]
        },
        "trial": {
          "description": "whether or not this is a trial",
          "type": "boolean",
          "default": false
        },
        "expectedActivation": {
          "description": "expected date the resource will be activated",
          "type": "string",
          "format": "date-time"
        },
        "userLimit": {
          "description": "the concurrent user-limit",
          "type": "integer"
        },
        "accessProvider": {
          "description": "UUID of the access provider",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "license": {
          "description": "License record",
          "type": "object",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "properties": {
            "code": {
              "description": "license code",
              "type": "string"
            },
            "description": {
              "description": "license description",
              "type": "string"
            },
            "reference": {
              "description": "license reference",
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "materialType": {
          "description": "UUID of the material Type",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "resourceUrl": {
          "description": "Electronic resource can be access via this URL",
          "type": "string",
          "pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
        }
      },
      "additionalProperties": false
    },
    "fundDistribution": {
      "description": "the UUIDs of the fund distribution records for this purchase order line",
      "id": "fundDistribution",
      "type": "array",
      "items": {
        "description": "a fund distribution record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "code": {
            "description": "the fund code",
            "type": "string"
          },
          "encumbrance": {
            "description": "UUID of encumbrance record associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "fundId": {
            "description": "UUID of the fund associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "expenseClassId": {
            "description": "UUID of the expense class associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "distributionType": {
            "description": "Percentage or amount type of the value property",
            "type": "string",
            "enum": [
              "amount",
              "percentage"
            ],
            "default": "percentage"
          },
          "value": {
            "description": "The value of the cost to be applied to this fund",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "fundId",
          "distributionType",
          "value"
        ]
      }
    },
    "isPackage": {
      "description": "Indicates that this POL is for a package",
      "type": "boolean",
      "default": false
    },
    "locations": {
      "description": "a list of the location records for this purchase order line",
      "id": "locations",
      "type": "array",
      "items": {
        "description": "The location details",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "locationId": {
            "description": "UUID of the (inventory) location record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "quantity": {
            "description": "combined/total quanitity of physical and electronic items",
            "type": "integer"
          },
          "quantityElectronic": {
            "description": "quantity of electronic items",
            "type": "integer"
          },
          "quantityPhysical": {
            "description": "quantity of physical items",
            "type": "integer"
          }
        },
        "additionalProperties": false,
        "required": [
          "locationId"
        ]
      }
    },
    "orderFormat": {
      "description": "The purchase order line format",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Electronic Resource",
        "P/E Mix",
        "Physical Resource",
        "Other"
      ]
    },
    "packagePoLineId": {
      "description": "UUID referencing the poLine that represents the package that this POLs title belongs to",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "paymentStatus": {
      "description": "The purchase order line payment status",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending",
        "Ongoing"
      ],
      "default": "Pending"
    },
    "physical": {
      "description": "details of this purchase order line relating to physical materials",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "createInventory": {
          "description": "Shows what inventory objects need to be created for physical resource",
          "type": "string",
          "enum": [
            "Instance, Holding, Item",
            "Instance, Holding",
            "Instance",
            "None"
          ]
        },
        "materialType": {
          "description": "UUID of the material Type",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "materialSupplier": {
          "description": "UUID of the material supplier record",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "expectedReceiptDate": {
          "description": "vendor agreed date prior to the Receipt Due date item is expected to be received by",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "receiptDue": {
          "description": "date item should be received by",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "volumes": {
          "description": "list of volumes included to the physical material",
          "type": "array",
          "items": {
            "description": "the identifier of volume",
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "volumes"
      ]
    },
    "poLineDescription": {
      "description": "purchase order line description",
      "type": "string"
    },
    "poLineNumber": {
      "description": "A human readable number assigned to this PO line",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$",
      "readonly": true
    },
    "publicationDate": {
      "description": "date (year) of the material's publication",
      "type": "string",
      "pattern": "^[0-9]{4}$"
    },
    "publisher": {
      "description": "publisher of the material",
      "type": "string"
    },
    "purchaseOrderId": {
      "description": "UUID of this parent purchase order",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "receiptDate": {
      "description": "date the purchase order line was received",
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "receiptStatus": {
      "description": "The purchase order line receipt status",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Awaiting Receipt",
        "Cancelled",
        "Fully Received",
        "Partially Received",
        "Pending",
        "Receipt Not Required",
        "Ongoing"
      ],
      "default": "Pending"
    },
    "reportingCodes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reportingCodes",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "purchase order line reporting code",
        "properties": {
          "id": {
            "description": "UUID of this reporting code record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "code": {
            "description": "a reporting code",
            "type": "string",
            "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z0-9]*$"
          },
          "description": {
            "description": "description of this reporting code",
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "code"
        ]
      }
    },
    "requester": {
      "description": "who requested this purchase order line",
      "type": "string"
    },
    "rush": {
      "description": "whether or not this is a rush order",
      "type": "boolean"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "the source of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "User",
        "API",
        "EDI",
        "MARC"
      ]
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "titleOrPackage": {
      "description": "title of the material",
      "type": "string"
    },
    "vendorDetail": {
      "description": "details related to the vendor of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "instructions": {
          "description": "special instructions for the vendor",
          "type": "string"
        },
        "noteFromVendor": {
          "description": "free-form notes from the vendor",
          "type": "string"
        },
        "refNumber": {
          "description": "a reference number for this purchase order line",
          "type": "string"
        },
        "refNumberType": {
          "description": "the reference number type",
          "type": "string",
          "enum": [
            "Supplier's continuation order",
            "Supplier's unique order line reference number",
            "Agent's unique subscription reference number",
            "Library's continuation order number",
            "Internal vendor number"
          ]
        },
        "vendorAccount": {
          "description": "the accound number on the vendor's end associated with this purchase order line",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "instructions"
      ]
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "acquisitionMethod",
    "cost",
    "orderFormat",
    "source",
    "titleOrPackage"
  ]
}

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "isPackage": false,
  "agreementId": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "acquisitionMethod": "Purchase At Vendor System",
  "alerts": [
    {
      "alert": "Receipt overdue",
      "id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
    }
  ],
  "cancellationRestriction": false,
  "cancellationRestrictionNote": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    {
      "claimed": false,
      "sent": "2018-10-09T00:00:00.000Z",
      "grace": 30
    }
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "exchangeRate": 1.12,
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 18.99,
    "quantityPhysical": 6,
    "quantityElectronic": 1,
    "poLineEstimatedPrice": 165.47
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
        "qualifier": "(paperback)"
      }
    ],
    "subscriptionFrom": "2018-10-09T00:00:00.000Z",
    "subscriptionInterval": 824,
    "subscriptionTo": "2020-10-09T00:00:00.000Z"
  },
  "donor": "ABCDEFGHIJKLM",
  "eresource": {
    "activated": false,
    "activationDue": 10,
    "createInventory": "Instance, Holding",
    "trial": false,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "userLimit": 10,
    "accessProvider": "ba3f3d45-247d-41f6-8dc9-6488adcad329",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "materialType": "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    },
    {
      "code": "GENRL",
      "fundId": "3652829d-a625-4c84-b297-9bd9955d6bc9",
      "percentage": 20.0,
      "encumbrance": "0466cb77-0344-43c6-85eb-0a64aa2934e5"
    }
  ],
  "locations": [
    {
      "locationId": "b241764c-1466-4e1d-a028-1a3684a5da87",
      "quantity": 5,
      "quantityElectronic": 1,
      "quantityPhysical": 4
    },
    {
      "locationId": "fcd64ce1-6995-48f0-840e-89ffa2288371",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "createInventory": "Instance, Holding, Item",
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "materialType": "fde2e5ca-cde3-11e8-a8d5-f2801f1b9fd1",
    "expectedReceiptDate": "2018-10-05T00:00:00.000Z",
    "receiptDue": "2018-10-10T00:00:00.000Z"
  },
  "poLineDescription": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "poLineNumber": "268758-03",
  "publicationDate": "2017",
  "publisher": "Schiffer Publishing",
  "purchaseOrderId": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receiptDate": "2018-10-09T00:00:00.000Z",
  "receiptStatus": "Awaiting Receipt",
  "reportingCodes": [
    {
      "code": "CODE1",
      "id": "5926dcd7-85f5-4504-8283-712595ebc38b",
      "description": "ABCDEF"
    },
    {
      "code": "CODE2",
      "id": "fa316c04-8101-4e72-8aaf-01281bac718f",
      "description": "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    },
    {
      "code": "CODE3",
      "id": "ea68b696-3125-4940-bf91-1d128323473e",
      "description": "ABCDE"
    }
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "User",
  "tags": {
    "tagList": [
     "important"
    ]
  },
  "titleOrPackage": "Kayak Fishing in the Northern Gulf Coast",
  "vendorDetail": {
    "instructions": "ABCDEFG",
    "noteFromVendor": "ABCDEFGHIKJKLMNOP",
    "refNumber": "123456-78",
    "refNumberType": "Supplier's unique order line reference number",
    "vendorAccount": "8910-10"
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

Location: required(string)
URI to the created order-line item

Body

Media type: application/json

Type: any

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "isPackage": false,
  "agreementId": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "acquisitionMethod": "Purchase At Vendor System",
  "alerts": [
    {
      "alert": "Receipt overdue",
      "id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
    }
  ],
  "cancellationRestriction": false,
  "cancellationRestrictionNote": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    {
      "claimed": false,
      "sent": "2018-10-09T00:00:00.000Z",
      "grace": 30
    }
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "exchangeRate": 1.12,
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 18.99,
    "quantityPhysical": 6,
    "quantityElectronic": 1,
    "poLineEstimatedPrice": 165.47
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
        "qualifier": "(paperback)"
      }
    ],
    "subscriptionFrom": "2018-10-09T00:00:00.000Z",
    "subscriptionInterval": 824,
    "subscriptionTo": "2020-10-09T00:00:00.000Z"
  },
  "donor": "ABCDEFGHIJKLM",
  "eresource": {
    "activated": false,
    "activationDue": 10,
    "createInventory": "Instance, Holding",
    "trial": false,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "userLimit": 10,
    "accessProvider": "ba3f3d45-247d-41f6-8dc9-6488adcad329",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "materialType": "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    },
    {
      "code": "GENRL",
      "fundId": "3652829d-a625-4c84-b297-9bd9955d6bc9",
      "percentage": 20.0,
      "encumbrance": "0466cb77-0344-43c6-85eb-0a64aa2934e5"
    }
  ],
  "locations": [
    {
      "locationId": "b241764c-1466-4e1d-a028-1a3684a5da87",
      "quantity": 5,
      "quantityElectronic": 1,
      "quantityPhysical": 4
    },
    {
      "locationId": "fcd64ce1-6995-48f0-840e-89ffa2288371",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "createInventory": "Instance, Holding, Item",
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "materialType": "fde2e5ca-cde3-11e8-a8d5-f2801f1b9fd1",
    "expectedReceiptDate": "2018-10-05T00:00:00.000Z",
    "receiptDue": "2018-10-10T00:00:00.000Z"
  },
  "poLineDescription": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "poLineNumber": "268758-03",
  "publicationDate": "2017",
  "publisher": "Schiffer Publishing",
  "purchaseOrderId": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receiptDate": "2018-10-09T00:00:00.000Z",
  "receiptStatus": "Awaiting Receipt",
  "reportingCodes": [
    {
      "code": "CODE1",
      "id": "5926dcd7-85f5-4504-8283-712595ebc38b",
      "description": "ABCDEF"
    },
    {
      "code": "CODE2",
      "id": "fa316c04-8101-4e72-8aaf-01281bac718f",
      "description": "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    },
    {
      "code": "CODE3",
      "id": "ea68b696-3125-4940-bf91-1d128323473e",
      "description": "ABCDE"
    }
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "User",
  "tags": {
    "tagList": [
     "important"
    ]
  },
  "titleOrPackage": "Kayak Fishing in the Northern Gulf Coast",
  "vendorDetail": {
    "instructions": "ABCDEFG",
    "noteFromVendor": "ABCDEFGHIKJKLMNOP",
    "refNumber": "123456-78",
    "refNumberType": "Supplier's unique order line reference number",
    "vendorAccount": "8910-10"
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 400

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.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to add order-line -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to create order-lines -- unauthorized

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

/orders/order-lines/{id} get put delete

Manage purchase order line (PO line) by id

get

Return a purchase order line with given {id}

put

Update a purchase order line with given {id}

delete

Delete a purchase order line with given {id}

Return a purchase order line with given {id}

Request
Response

URI Parameters

id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a purchase order line

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "composite purchase order line with dereferenced/expanded orders fields",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID identifying this purchase order line",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "edition": {
      "description": "edition of the material",
      "type": "string"
    },
    "checkinItems": {
      "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
      "type": "boolean",
      "default": false
    },
    "instanceId": {
      "description": "UUID of the instance record this purchase order line is related to",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "agreementId": {
      "description": "UUID of the agreement this purchase order line is related to",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "acquisitionMethod": {
      "description": "the acquisition method for this purchase order line",
      "type": "string",
      "enum": [
        "Approval Plan",
        "Demand Driven Acquisitions (DDA)",
        "Depository",
        "Evidence Based Acquisitions (EBA)",
        "Exchange",
        "Gift",
        "Purchase At Vendor System",
        "Purchase",
        "Technical"
      ]
    },
    "alerts": {
      "description": "alerts associated with this purchase order line",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "an alert record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "id": {
            "description": "UUID of this alert record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "alert": {
            "description": "the alert text",
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "alert"
        ]
      }
    },
    "cancellationRestriction": {
      "description": "whether or not there are cancellation restrictions for this purchase order line",
      "type": "boolean"
    },
    "cancellationRestrictionNote": {
      "description": "free-form notes related to cancellation restrictions",
      "type": "string"
    },
    "claims": {
      "description": "claims associated with this purchase order line",
      "id": "claims",
      "type": "array",
      "items": {
        "description": "a claim record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "claimed": {
            "description": "whether or not this purchase order line has been claimed",
            "type": "boolean",
            "default": false
          },
          "sent": {
            "description": "date a claim was sent",
            "type": "string",
            "format": "date-time"
          },
          "grace": {
            "description": "the number of days after the expected receipt date during which claims should not be processed",
            "type": "integer"
          }
        },
        "additionalProperties": false
      }
    },
    "collection": {
      "description": "whether or not this purchase order line is for a collection",
      "type": "boolean"
    },
    "contributors": {
      "description": "list of contributors to the material",
      "id": "contributors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "contributor to the material",
        "properties": {
          "contributor": {
            "description": "the name of a contributor to the material",
            "type": "string"
          },
          "contributorNameTypeId": {
            "description": "UUID of the contributor type",
            "type": "string",
            "pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "contributorNameTypeId"
        ]
      }
    },
    "cost": {
      "description": "cost details associated with this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "listUnitPrice": {
          "description": "The per-item list price for physical or resources of 'Other' order format",
          "type": "number"
        },
        "listUnitPriceElectronic": {
          "description": "The e-resource per-item list price",
          "type": "number"
        },
        "currency": {
          "description": "An ISO currency code",
          "type": "string"
        },
        "additionalCost": {
          "description": "Lump sum that is added to the total estimated price - not affected by discount",
          "type": "number"
        },
        "discount": {
          "description": "Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost",
          "type": "number"
        },
        "discountType": {
          "description": "Percentage or amount discount type",
          "type": "string",
          "enum": [
            "amount",
            "percentage"
          ],
          "default": "percentage"
        },
        "exchangeRate": {
          "description": "Exchange rate",
          "type": "number"
        },
        "quantityPhysical": {
          "description": "Quantity of physical items or resources of 'Other' order format in this purchase order line",
          "type": "integer"
        },
        "quantityElectronic": {
          "description": "Quantity of electronic items in this purchase order line",
          "type": "integer"
        },
        "poLineEstimatedPrice": {
          "description": "The calculated total estimated price for this purchase order line: list price time quantities minus discount amount plus additional cost",
          "type": "number"
        },
        "fyroAdjustmentAmount": {
          "description": "Adjustment amount if rollover was happen",
          "type": "number"
        }
      },
      "additionalProperties": false,
      "required": [
        "currency"
      ]
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "details about this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "receivingNote": {
          "description": "notes regarding receiving instructions",
          "type": "string"
        },
        "productIds": {
          "description": "a list of product identifiers",
          "id": "productIds",
          "type": "array",
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "Product identifier",
            "type": "object",
            "properties": {
              "productId": {
                "description": "The actual product identifier",
                "type": "string"
              },
              "productIdType": {
                "description": "The type of product identifier",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "qualifier": {
                "description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "subscriptionFrom": {
          "description": "the start date of the subscription",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "subscriptionInterval": {
          "description": "the subscription interval in days",
          "type": "integer"
        },
        "subscriptionTo": {
          "description": "the end date of the subscription",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "eresource-related details of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "activated": {
          "description": "whether or not this resource is activated",
          "type": "boolean",
          "default": false
        },
        "activationDue": {
          "description": "number of days until activation, from date of order placement",
          "type": "integer"
        },
        "createInventory": {
          "description": "Shows what inventory objects need to be created for electronic resource",
          "type": "string",
          "enum": [
            "Instance, Holding, Item",
            "Instance, Holding",
            "Instance",
            "None"
          ]
        },
        "trial": {
          "description": "whether or not this is a trial",
          "type": "boolean",
          "default": false
        },
        "expectedActivation": {
          "description": "expected date the resource will be activated",
          "type": "string",
          "format": "date-time"
        },
        "userLimit": {
          "description": "the concurrent user-limit",
          "type": "integer"
        },
        "accessProvider": {
          "description": "UUID of the access provider",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "license": {
          "description": "License record",
          "type": "object",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "properties": {
            "code": {
              "description": "license code",
              "type": "string"
            },
            "description": {
              "description": "license description",
              "type": "string"
            },
            "reference": {
              "description": "license reference",
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "materialType": {
          "description": "UUID of the material Type",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "resourceUrl": {
          "description": "Electronic resource can be access via this URL",
          "type": "string",
          "pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
        }
      },
      "additionalProperties": false
    },
    "fundDistribution": {
      "description": "the UUIDs of the fund distribution records for this purchase order line",
      "id": "fundDistribution",
      "type": "array",
      "items": {
        "description": "a fund distribution record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "code": {
            "description": "the fund code",
            "type": "string"
          },
          "encumbrance": {
            "description": "UUID of encumbrance record associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "fundId": {
            "description": "UUID of the fund associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "expenseClassId": {
            "description": "UUID of the expense class associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "distributionType": {
            "description": "Percentage or amount type of the value property",
            "type": "string",
            "enum": [
              "amount",
              "percentage"
            ],
            "default": "percentage"
          },
          "value": {
            "description": "The value of the cost to be applied to this fund",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "fundId",
          "distributionType",
          "value"
        ]
      }
    },
    "isPackage": {
      "description": "Indicates that this POL is for a package",
      "type": "boolean",
      "default": false
    },
    "locations": {
      "description": "a list of the location records for this purchase order line",
      "id": "locations",
      "type": "array",
      "items": {
        "description": "The location details",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "locationId": {
            "description": "UUID of the (inventory) location record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "quantity": {
            "description": "combined/total quanitity of physical and electronic items",
            "type": "integer"
          },
          "quantityElectronic": {
            "description": "quantity of electronic items",
            "type": "integer"
          },
          "quantityPhysical": {
            "description": "quantity of physical items",
            "type": "integer"
          }
        },
        "additionalProperties": false,
        "required": [
          "locationId"
        ]
      }
    },
    "orderFormat": {
      "description": "The purchase order line format",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Electronic Resource",
        "P/E Mix",
        "Physical Resource",
        "Other"
      ]
    },
    "packagePoLineId": {
      "description": "UUID referencing the poLine that represents the package that this POLs title belongs to",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "paymentStatus": {
      "description": "The purchase order line payment status",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending",
        "Ongoing"
      ],
      "default": "Pending"
    },
    "physical": {
      "description": "details of this purchase order line relating to physical materials",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "createInventory": {
          "description": "Shows what inventory objects need to be created for physical resource",
          "type": "string",
          "enum": [
            "Instance, Holding, Item",
            "Instance, Holding",
            "Instance",
            "None"
          ]
        },
        "materialType": {
          "description": "UUID of the material Type",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "materialSupplier": {
          "description": "UUID of the material supplier record",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "expectedReceiptDate": {
          "description": "vendor agreed date prior to the Receipt Due date item is expected to be received by",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "receiptDue": {
          "description": "date item should be received by",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "volumes": {
          "description": "list of volumes included to the physical material",
          "type": "array",
          "items": {
            "description": "the identifier of volume",
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "volumes"
      ]
    },
    "poLineDescription": {
      "description": "purchase order line description",
      "type": "string"
    },
    "poLineNumber": {
      "description": "A human readable number assigned to this PO line",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$",
      "readonly": true
    },
    "publicationDate": {
      "description": "date (year) of the material's publication",
      "type": "string",
      "pattern": "^[0-9]{4}$"
    },
    "publisher": {
      "description": "publisher of the material",
      "type": "string"
    },
    "purchaseOrderId": {
      "description": "UUID of this parent purchase order",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "receiptDate": {
      "description": "date the purchase order line was received",
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "receiptStatus": {
      "description": "The purchase order line receipt status",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Awaiting Receipt",
        "Cancelled",
        "Fully Received",
        "Partially Received",
        "Pending",
        "Receipt Not Required",
        "Ongoing"
      ],
      "default": "Pending"
    },
    "reportingCodes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reportingCodes",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "purchase order line reporting code",
        "properties": {
          "id": {
            "description": "UUID of this reporting code record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "code": {
            "description": "a reporting code",
            "type": "string",
            "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z0-9]*$"
          },
          "description": {
            "description": "description of this reporting code",
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "code"
        ]
      }
    },
    "requester": {
      "description": "who requested this purchase order line",
      "type": "string"
    },
    "rush": {
      "description": "whether or not this is a rush order",
      "type": "boolean"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "the source of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "User",
        "API",
        "EDI",
        "MARC"
      ]
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "titleOrPackage": {
      "description": "title of the material",
      "type": "string"
    },
    "vendorDetail": {
      "description": "details related to the vendor of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "instructions": {
          "description": "special instructions for the vendor",
          "type": "string"
        },
        "noteFromVendor": {
          "description": "free-form notes from the vendor",
          "type": "string"
        },
        "refNumber": {
          "description": "a reference number for this purchase order line",
          "type": "string"
        },
        "refNumberType": {
          "description": "the reference number type",
          "type": "string",
          "enum": [
            "Supplier's continuation order",
            "Supplier's unique order line reference number",
            "Agent's unique subscription reference number",
            "Library's continuation order number",
            "Internal vendor number"
          ]
        },
        "vendorAccount": {
          "description": "the accound number on the vendor's end associated with this purchase order line",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "instructions"
      ]
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "acquisitionMethod",
    "cost",
    "orderFormat",
    "source",
    "titleOrPackage"
  ]
}

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "isPackage": false,
  "agreementId": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "acquisitionMethod": "Purchase At Vendor System",
  "alerts": [
    {
      "alert": "Receipt overdue",
      "id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
    }
  ],
  "cancellationRestriction": false,
  "cancellationRestrictionNote": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    {
      "claimed": false,
      "sent": "2018-10-09T00:00:00.000Z",
      "grace": 30
    }
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "exchangeRate": 1.12,
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 18.99,
    "quantityPhysical": 6,
    "quantityElectronic": 1,
    "poLineEstimatedPrice": 165.47
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
        "qualifier": "(paperback)"
      }
    ],
    "subscriptionFrom": "2018-10-09T00:00:00.000Z",
    "subscriptionInterval": 824,
    "subscriptionTo": "2020-10-09T00:00:00.000Z"
  },
  "donor": "ABCDEFGHIJKLM",
  "eresource": {
    "activated": false,
    "activationDue": 10,
    "createInventory": "Instance, Holding",
    "trial": false,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "userLimit": 10,
    "accessProvider": "ba3f3d45-247d-41f6-8dc9-6488adcad329",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "materialType": "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    },
    {
      "code": "GENRL",
      "fundId": "3652829d-a625-4c84-b297-9bd9955d6bc9",
      "percentage": 20.0,
      "encumbrance": "0466cb77-0344-43c6-85eb-0a64aa2934e5"
    }
  ],
  "locations": [
    {
      "locationId": "b241764c-1466-4e1d-a028-1a3684a5da87",
      "quantity": 5,
      "quantityElectronic": 1,
      "quantityPhysical": 4
    },
    {
      "locationId": "fcd64ce1-6995-48f0-840e-89ffa2288371",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "createInventory": "Instance, Holding, Item",
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "materialType": "fde2e5ca-cde3-11e8-a8d5-f2801f1b9fd1",
    "expectedReceiptDate": "2018-10-05T00:00:00.000Z",
    "receiptDue": "2018-10-10T00:00:00.000Z"
  },
  "poLineDescription": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "poLineNumber": "268758-03",
  "publicationDate": "2017",
  "publisher": "Schiffer Publishing",
  "purchaseOrderId": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receiptDate": "2018-10-09T00:00:00.000Z",
  "receiptStatus": "Awaiting Receipt",
  "reportingCodes": [
    {
      "code": "CODE1",
      "id": "5926dcd7-85f5-4504-8283-712595ebc38b",
      "description": "ABCDEF"
    },
    {
      "code": "CODE2",
      "id": "fa316c04-8101-4e72-8aaf-01281bac718f",
      "description": "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    },
    {
      "code": "CODE3",
      "id": "ea68b696-3125-4940-bf91-1d128323473e",
      "description": "ABCDE"
    }
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "User",
  "tags": {
    "tagList": [
     "important"
    ]
  },
  "titleOrPackage": "Kayak Fishing in the Northern Gulf Coast",
  "vendorDetail": {
    "instructions": "ABCDEFG",
    "noteFromVendor": "ABCDEFGHIKJKLMNOP",
    "refNumber": "123456-78",
    "refNumberType": "Supplier's unique order line reference number",
    "vendorAccount": "8910-10"
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"order-line not found"

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Update a purchase order line with given {id}

Request
Response

URI Parameters

id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a purchase order line

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "composite purchase order line with dereferenced/expanded orders fields",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID identifying this purchase order line",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "edition": {
      "description": "edition of the material",
      "type": "string"
    },
    "checkinItems": {
      "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
      "type": "boolean",
      "default": false
    },
    "instanceId": {
      "description": "UUID of the instance record this purchase order line is related to",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "agreementId": {
      "description": "UUID of the agreement this purchase order line is related to",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "acquisitionMethod": {
      "description": "the acquisition method for this purchase order line",
      "type": "string",
      "enum": [
        "Approval Plan",
        "Demand Driven Acquisitions (DDA)",
        "Depository",
        "Evidence Based Acquisitions (EBA)",
        "Exchange",
        "Gift",
        "Purchase At Vendor System",
        "Purchase",
        "Technical"
      ]
    },
    "alerts": {
      "description": "alerts associated with this purchase order line",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "an alert record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "id": {
            "description": "UUID of this alert record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "alert": {
            "description": "the alert text",
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "alert"
        ]
      }
    },
    "cancellationRestriction": {
      "description": "whether or not there are cancellation restrictions for this purchase order line",
      "type": "boolean"
    },
    "cancellationRestrictionNote": {
      "description": "free-form notes related to cancellation restrictions",
      "type": "string"
    },
    "claims": {
      "description": "claims associated with this purchase order line",
      "id": "claims",
      "type": "array",
      "items": {
        "description": "a claim record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "claimed": {
            "description": "whether or not this purchase order line has been claimed",
            "type": "boolean",
            "default": false
          },
          "sent": {
            "description": "date a claim was sent",
            "type": "string",
            "format": "date-time"
          },
          "grace": {
            "description": "the number of days after the expected receipt date during which claims should not be processed",
            "type": "integer"
          }
        },
        "additionalProperties": false
      }
    },
    "collection": {
      "description": "whether or not this purchase order line is for a collection",
      "type": "boolean"
    },
    "contributors": {
      "description": "list of contributors to the material",
      "id": "contributors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "contributor to the material",
        "properties": {
          "contributor": {
            "description": "the name of a contributor to the material",
            "type": "string"
          },
          "contributorNameTypeId": {
            "description": "UUID of the contributor type",
            "type": "string",
            "pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "contributorNameTypeId"
        ]
      }
    },
    "cost": {
      "description": "cost details associated with this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "listUnitPrice": {
          "description": "The per-item list price for physical or resources of 'Other' order format",
          "type": "number"
        },
        "listUnitPriceElectronic": {
          "description": "The e-resource per-item list price",
          "type": "number"
        },
        "currency": {
          "description": "An ISO currency code",
          "type": "string"
        },
        "additionalCost": {
          "description": "Lump sum that is added to the total estimated price - not affected by discount",
          "type": "number"
        },
        "discount": {
          "description": "Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost",
          "type": "number"
        },
        "discountType": {
          "description": "Percentage or amount discount type",
          "type": "string",
          "enum": [
            "amount",
            "percentage"
          ],
          "default": "percentage"
        },
        "exchangeRate": {
          "description": "Exchange rate",
          "type": "number"
        },
        "quantityPhysical": {
          "description": "Quantity of physical items or resources of 'Other' order format in this purchase order line",
          "type": "integer"
        },
        "quantityElectronic": {
          "description": "Quantity of electronic items in this purchase order line",
          "type": "integer"
        },
        "poLineEstimatedPrice": {
          "description": "The calculated total estimated price for this purchase order line: list price time quantities minus discount amount plus additional cost",
          "type": "number"
        },
        "fyroAdjustmentAmount": {
          "description": "Adjustment amount if rollover was happen",
          "type": "number"
        }
      },
      "additionalProperties": false,
      "required": [
        "currency"
      ]
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "details about this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "receivingNote": {
          "description": "notes regarding receiving instructions",
          "type": "string"
        },
        "productIds": {
          "description": "a list of product identifiers",
          "id": "productIds",
          "type": "array",
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "Product identifier",
            "type": "object",
            "properties": {
              "productId": {
                "description": "The actual product identifier",
                "type": "string"
              },
              "productIdType": {
                "description": "The type of product identifier",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "qualifier": {
                "description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "subscriptionFrom": {
          "description": "the start date of the subscription",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "subscriptionInterval": {
          "description": "the subscription interval in days",
          "type": "integer"
        },
        "subscriptionTo": {
          "description": "the end date of the subscription",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "eresource-related details of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "activated": {
          "description": "whether or not this resource is activated",
          "type": "boolean",
          "default": false
        },
        "activationDue": {
          "description": "number of days until activation, from date of order placement",
          "type": "integer"
        },
        "createInventory": {
          "description": "Shows what inventory objects need to be created for electronic resource",
          "type": "string",
          "enum": [
            "Instance, Holding, Item",
            "Instance, Holding",
            "Instance",
            "None"
          ]
        },
        "trial": {
          "description": "whether or not this is a trial",
          "type": "boolean",
          "default": false
        },
        "expectedActivation": {
          "description": "expected date the resource will be activated",
          "type": "string",
          "format": "date-time"
        },
        "userLimit": {
          "description": "the concurrent user-limit",
          "type": "integer"
        },
        "accessProvider": {
          "description": "UUID of the access provider",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "license": {
          "description": "License record",
          "type": "object",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "properties": {
            "code": {
              "description": "license code",
              "type": "string"
            },
            "description": {
              "description": "license description",
              "type": "string"
            },
            "reference": {
              "description": "license reference",
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "materialType": {
          "description": "UUID of the material Type",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "resourceUrl": {
          "description": "Electronic resource can be access via this URL",
          "type": "string",
          "pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
        }
      },
      "additionalProperties": false
    },
    "fundDistribution": {
      "description": "the UUIDs of the fund distribution records for this purchase order line",
      "id": "fundDistribution",
      "type": "array",
      "items": {
        "description": "a fund distribution record",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "code": {
            "description": "the fund code",
            "type": "string"
          },
          "encumbrance": {
            "description": "UUID of encumbrance record associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "fundId": {
            "description": "UUID of the fund associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "expenseClassId": {
            "description": "UUID of the expense class associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "distributionType": {
            "description": "Percentage or amount type of the value property",
            "type": "string",
            "enum": [
              "amount",
              "percentage"
            ],
            "default": "percentage"
          },
          "value": {
            "description": "The value of the cost to be applied to this fund",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "fundId",
          "distributionType",
          "value"
        ]
      }
    },
    "isPackage": {
      "description": "Indicates that this POL is for a package",
      "type": "boolean",
      "default": false
    },
    "locations": {
      "description": "a list of the location records for this purchase order line",
      "id": "locations",
      "type": "array",
      "items": {
        "description": "The location details",
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "properties": {
          "locationId": {
            "description": "UUID of the (inventory) location record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "quantity": {
            "description": "combined/total quanitity of physical and electronic items",
            "type": "integer"
          },
          "quantityElectronic": {
            "description": "quantity of electronic items",
            "type": "integer"
          },
          "quantityPhysical": {
            "description": "quantity of physical items",
            "type": "integer"
          }
        },
        "additionalProperties": false,
        "required": [
          "locationId"
        ]
      }
    },
    "orderFormat": {
      "description": "The purchase order line format",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Electronic Resource",
        "P/E Mix",
        "Physical Resource",
        "Other"
      ]
    },
    "packagePoLineId": {
      "description": "UUID referencing the poLine that represents the package that this POLs title belongs to",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "paymentStatus": {
      "description": "The purchase order line payment status",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending",
        "Ongoing"
      ],
      "default": "Pending"
    },
    "physical": {
      "description": "details of this purchase order line relating to physical materials",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "createInventory": {
          "description": "Shows what inventory objects need to be created for physical resource",
          "type": "string",
          "enum": [
            "Instance, Holding, Item",
            "Instance, Holding",
            "Instance",
            "None"
          ]
        },
        "materialType": {
          "description": "UUID of the material Type",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "materialSupplier": {
          "description": "UUID of the material supplier record",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "expectedReceiptDate": {
          "description": "vendor agreed date prior to the Receipt Due date item is expected to be received by",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "receiptDue": {
          "description": "date item should be received by",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "volumes": {
          "description": "list of volumes included to the physical material",
          "type": "array",
          "items": {
            "description": "the identifier of volume",
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "volumes"
      ]
    },
    "poLineDescription": {
      "description": "purchase order line description",
      "type": "string"
    },
    "poLineNumber": {
      "description": "A human readable number assigned to this PO line",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$",
      "readonly": true
    },
    "publicationDate": {
      "description": "date (year) of the material's publication",
      "type": "string",
      "pattern": "^[0-9]{4}$"
    },
    "publisher": {
      "description": "publisher of the material",
      "type": "string"
    },
    "purchaseOrderId": {
      "description": "UUID of this parent purchase order",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "receiptDate": {
      "description": "date the purchase order line was received",
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "receiptStatus": {
      "description": "The purchase order line receipt status",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "Awaiting Receipt",
        "Cancelled",
        "Fully Received",
        "Partially Received",
        "Pending",
        "Receipt Not Required",
        "Ongoing"
      ],
      "default": "Pending"
    },
    "reportingCodes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reportingCodes",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "purchase order line reporting code",
        "properties": {
          "id": {
            "description": "UUID of this reporting code record",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "code": {
            "description": "a reporting code",
            "type": "string",
            "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z0-9]*$"
          },
          "description": {
            "description": "description of this reporting code",
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "code"
        ]
      }
    },
    "requester": {
      "description": "who requested this purchase order line",
      "type": "string"
    },
    "rush": {
      "description": "whether or not this is a rush order",
      "type": "boolean"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "the source of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "enum": [
        "User",
        "API",
        "EDI",
        "MARC"
      ]
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "titleOrPackage": {
      "description": "title of the material",
      "type": "string"
    },
    "vendorDetail": {
      "description": "details related to the vendor of this purchase order line",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "instructions": {
          "description": "special instructions for the vendor",
          "type": "string"
        },
        "noteFromVendor": {
          "description": "free-form notes from the vendor",
          "type": "string"
        },
        "refNumber": {
          "description": "a reference number for this purchase order line",
          "type": "string"
        },
        "refNumberType": {
          "description": "the reference number type",
          "type": "string",
          "enum": [
            "Supplier's continuation order",
            "Supplier's unique order line reference number",
            "Agent's unique subscription reference number",
            "Library's continuation order number",
            "Internal vendor number"
          ]
        },
        "vendorAccount": {
          "description": "the accound number on the vendor's end associated with this purchase order line",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "instructions"
      ]
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "acquisitionMethod",
    "cost",
    "orderFormat",
    "source",
    "titleOrPackage"
  ]
}

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "isPackage": false,
  "agreementId": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "acquisitionMethod": "Purchase At Vendor System",
  "alerts": [
    {
      "alert": "Receipt overdue",
      "id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
    }
  ],
  "cancellationRestriction": false,
  "cancellationRestrictionNote": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    {
      "claimed": false,
      "sent": "2018-10-09T00:00:00.000Z",
      "grace": 30
    }
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "exchangeRate": 1.12,
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 18.99,
    "quantityPhysical": 6,
    "quantityElectronic": 1,
    "poLineEstimatedPrice": 165.47
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
        "qualifier": "(paperback)"
      }
    ],
    "subscriptionFrom": "2018-10-09T00:00:00.000Z",
    "subscriptionInterval": 824,
    "subscriptionTo": "2020-10-09T00:00:00.000Z"
  },
  "donor": "ABCDEFGHIJKLM",
  "eresource": {
    "activated": false,
    "activationDue": 10,
    "createInventory": "Instance, Holding",
    "trial": false,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "userLimit": 10,
    "accessProvider": "ba3f3d45-247d-41f6-8dc9-6488adcad329",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "materialType": "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    },
    {
      "code": "GENRL",
      "fundId": "3652829d-a625-4c84-b297-9bd9955d6bc9",
      "percentage": 20.0,
      "encumbrance": "0466cb77-0344-43c6-85eb-0a64aa2934e5"
    }
  ],
  "locations": [
    {
      "locationId": "b241764c-1466-4e1d-a028-1a3684a5da87",
      "quantity": 5,
      "quantityElectronic": 1,
      "quantityPhysical": 4
    },
    {
      "locationId": "fcd64ce1-6995-48f0-840e-89ffa2288371",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "createInventory": "Instance, Holding, Item",
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "materialType": "fde2e5ca-cde3-11e8-a8d5-f2801f1b9fd1",
    "expectedReceiptDate": "2018-10-05T00:00:00.000Z",
    "receiptDue": "2018-10-10T00:00:00.000Z"
  },
  "poLineDescription": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "poLineNumber": "268758-03",
  "publicationDate": "2017",
  "publisher": "Schiffer Publishing",
  "purchaseOrderId": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receiptDate": "2018-10-09T00:00:00.000Z",
  "receiptStatus": "Awaiting Receipt",
  "reportingCodes": [
    {
      "code": "CODE1",
      "id": "5926dcd7-85f5-4504-8283-712595ebc38b",
      "description": "ABCDEF"
    },
    {
      "code": "CODE2",
      "id": "fa316c04-8101-4e72-8aaf-01281bac718f",
      "description": "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    },
    {
      "code": "CODE3",
      "id": "ea68b696-3125-4940-bf91-1d128323473e",
      "description": "ABCDE"
    }
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "User",
  "tags": {
    "tagList": [
     "important"
    ]
  },
  "titleOrPackage": "Kayak Fishing in the Northern Gulf Coast",
  "vendorDetail": {
    "instructions": "ABCDEFG",
    "noteFromVendor": "ABCDEFGHIKJKLMNOP",
    "refNumber": "123456-78",
    "refNumberType": "Supplier's unique order line reference number",
    "vendorAccount": "8910-10"
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 204

Item successfully updated

HTTP status code 400

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.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to update order-line -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"order-line not found"

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Delete a purchase order line with given {id}

Request
Response

URI Parameters

id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a purchase order line

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 204

Item deleted successfully

HTTP status code 400

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.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to delete order-line -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"order-line not found"

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Order-lines API documentation version v1

Orders Business Logic API

Purchase Order Lines

Order-lines API documentation version v1

Orders Business Logic API

Purchase Order Lines

/orders/order-lines get post

get /orders/order-lines

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 422

Body

HTTP status code 500

Body

post /orders/order-lines

Query Parameters

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 422

Body

HTTP status code 500

Body

/orders/order-lines/{id} get put delete

get /orders/order-lines/{id}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 422

Body

HTTP status code 500

Body

put /orders/order-lines/{id}

URI Parameters

Query Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 422

Body

HTTP status code 500

Body

delete /orders/order-lines/{id}

URI Parameters

Query Parameters

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 422

Body

HTTP status code 500

Body