mod-orders (v4)

http://github.com/folio-org/mod-orders-storage

Table of contents

PO Line

This module implements the CRUD interface. This API is intended for internal use only. Please use the /orders/order-lines API provided by mod-orders instead.

/orders-storage/po-lines

Collection of po-line items.

GET /orders-storage/po-lines

Get list of po lines

GET /orders-storage/po-lines
Query Parameters
  • 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.

    with valid searchable fields: for example code

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    ["code", "MEDGRANT", "="]
    
  • 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
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of po-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",
        "$ref": "po_line.json"
      }
    },
    "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",
        "agreementId": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
        "acquisitionMethod": "Purchase At Vendor System",
        "alerts": [
          "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
        ],
        "cancellationRestriction": false,
        "cancellationRestrictionRote": "ABCDEFGHIJKLMNOPQRSTUVW",
        "claims": [
          {
            "claimed": false,
            "sent": "2018-10-09T00:00:00.000Z",
            "grace": 30
          }
        ],
        "collection": false,
        "contributors": [
          {
            "contributor": "Ed Mashburn",
            "contributorType": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
          }
        ],
        "cost": {
          "additionalCost": 4.99,
          "currency": "USD",
          "discount": 10,
          "discountType": "percentage",
          "listUnitPriceElectronic": 24.99,
          "quantityElectronic": 2,
          "poLineEstimatedPrice": 49.97
        },
        "description": "ABCDEFGH",
        "details": {
          "receivingNote": "ABCDEFGHIJKL",
          "productIds": [
            {
              "productId": "9780764354113",
              "productIdType": "ISBN"
            }
          ],
          "materialTypes": [
            "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
          ],
          "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": true,
          "expectedActivation": "2018-10-09T00:00:00.000Z",
          "license": {
            "code": "Code 1",
            "description": "License Agreement 1"
          },
          "trial": false,
          "userLimit": 10
        },
        "fundDistribution": [
          {
            "code": "HIST",
            "percentage": 80.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",
        "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
        "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": {
          "code": "Code1",
          "description": ""
        },
        "tags": [
          "ABCDEFGHIJKLMNOPQRSTU",
          "ABCDEFG",
          "ABCDEFGHIJKLMNOPQRSTU",
          "ABCDEFGHIJKLMNO"
        ],
        "title": "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
}

Response 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: text/plain

Type: any

Example:

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list po-lines -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /orders-storage/po-lines

Create a new po-line item.

POST /orders-storage/po-lines
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": "purchase order line",
  "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"
    },
    "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": "an array of alert record IDs",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "UUID of an 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}$"
      }
    },
    "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",
        "$ref": "claim.json"
      }
    },
    "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",
        "$ref": "contributor.json"
      }
    },
    "cost": {
      "description": "cost record",
      "type": "object",
      "$ref": "cost.json"
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "details record",
      "type": "object",
      "$ref": "details.json"
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "eresource record",
      "type": "object",
      "$ref": "eresource.json"
    },
    "fundDistribution": {
      "description": "Fund distribution records for this purchase order line",
      "id": "fundDistribution",
      "type": "array",
      "items": {
        "description": "fund distribution record",
        "type": "object",
        "$ref": "fund_distribution.json"
      }
    },
    "locations": {
      "description": "Location records for this purchase order line",
      "id": "locations",
      "type": "array",
      "items": {
        "description": "location record",
        "type": "object",
        "$ref": "location.json"
      }
    },
    "orderFormat": {
      "description": "The purchase order line format",
      "type": "object",
      "$ref": "order_format.json"
    },
    "owner": {
      "description": "the owner of this purchase order line",
      "type": "string"
    },
    "paymentStatus": {
      "description": "The purchase order line payment status",
      "type": "string",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending"
      ]
    },
    "physical": {
      "description": "UUID of the physical (details) record",
      "type": "object",
      "$ref": "physical.json"
    },
    "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]{5,16}-[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",
      "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",
      "$ref": "receipt_status.json"
    },
    "reportingCodes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reportingCodes",
      "type": "array",
      "items": {
        "description": "UUID of the reporting code",
        "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"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "source record",
      "type": "object",
      "$ref": "source.json"
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "title of the material",
      "type": "string"
    },
    "vendorDetail": {
      "description": "Vendor detail record",
      "type": "object",
      "$ref": "vendor_detail.json"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "source"
  ]
}

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "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",
      "contributorType": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 14.99,
    "quantityElectronic": 1,
    "quantityPhysical": 2,
    "poLineEstimatedPrice": 66.71
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "ISBN"
      }
    ],
    "materialTypes": [
    "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
    ],
    "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": true,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "trial": false,
    "userLimit": 10
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "percentage": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    }
  ],
  "locations": [
    {
      "locationId": "eb2d063a-5b4c-4cab-8db1-5fc5c5941df6",
      "quantity": 1,
      "quantityElectronic": 1,
      "quantityPhysical": 0
    },
    {
      "locationId": "53cf956f-c1df-410b-8bea-27f712cca7c0",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "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": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": {
    "code": "Code1",
    "description": ""
  },
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "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"
  }
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created po-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",
  "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",
      "contributorType": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 14.99,
    "quantityElectronic": 1,
    "quantityPhysical": 2,
    "poLineEstimatedPrice": 66.71
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "ISBN"
      }
    ],
    "materialTypes": [
    "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
    ],
    "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": true,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "trial": false,
    "userLimit": 10
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "percentage": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    }
  ],
  "locations": [
    {
      "locationId": "eb2d063a-5b4c-4cab-8db1-5fc5c5941df6",
      "quantity": 1,
      "quantityElectronic": 1,
      "quantityPhysical": 0
    },
    {
      "locationId": "53cf956f-c1df-410b-8bea-27f712cca7c0",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "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": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": {
    "code": "Code1",
    "description": ""
  },
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "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"
  }
}

Response 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: text/plain

Type: any

Example:

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create po-lines -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /orders-storage/po-lines/{id}

Retrieve po-line item with given {po-lineId}

GET /orders-storage/po-lines/{id}
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 PO Line

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "purchase order line",
  "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"
    },
    "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": "an array of alert record IDs",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "UUID of an 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}$"
      }
    },
    "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",
        "$ref": "claim.json"
      }
    },
    "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",
        "$ref": "contributor.json"
      }
    },
    "cost": {
      "description": "cost record",
      "type": "object",
      "$ref": "cost.json"
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "details record",
      "type": "object",
      "$ref": "details.json"
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "eresource record",
      "type": "object",
      "$ref": "eresource.json"
    },
    "fundDistribution": {
      "description": "Fund distribution records for this purchase order line",
      "id": "fundDistribution",
      "type": "array",
      "items": {
        "description": "fund distribution record",
        "type": "object",
        "$ref": "fund_distribution.json"
      }
    },
    "locations": {
      "description": "Location records for this purchase order line",
      "id": "locations",
      "type": "array",
      "items": {
        "description": "location record",
        "type": "object",
        "$ref": "location.json"
      }
    },
    "orderFormat": {
      "description": "The purchase order line format",
      "type": "object",
      "$ref": "order_format.json"
    },
    "owner": {
      "description": "the owner of this purchase order line",
      "type": "string"
    },
    "paymentStatus": {
      "description": "The purchase order line payment status",
      "type": "string",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending"
      ]
    },
    "physical": {
      "description": "UUID of the physical (details) record",
      "type": "object",
      "$ref": "physical.json"
    },
    "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]{5,16}-[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",
      "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",
      "$ref": "receipt_status.json"
    },
    "reportingCodes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reportingCodes",
      "type": "array",
      "items": {
        "description": "UUID of the reporting code",
        "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"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "source record",
      "type": "object",
      "$ref": "source.json"
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "title of the material",
      "type": "string"
    },
    "vendorDetail": {
      "description": "Vendor detail record",
      "type": "object",
      "$ref": "vendor_detail.json"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "source"
  ]
}

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "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",
      "contributorType": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 14.99,
    "quantityElectronic": 1,
    "quantityPhysical": 2,
    "poLineEstimatedPrice": 66.71
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "ISBN"
      }
    ],
    "materialTypes": [
    "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
    ],
    "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": true,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "trial": false,
    "userLimit": 10
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "percentage": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    }
  ],
  "locations": [
    {
      "locationId": "eb2d063a-5b4c-4cab-8db1-5fc5c5941df6",
      "quantity": 1,
      "quantityElectronic": 1,
      "quantityPhysical": 0
    },
    {
      "locationId": "53cf956f-c1df-410b-8bea-27f712cca7c0",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "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": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": {
    "code": "Code1",
    "description": ""
  },
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "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"
  }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"po-line not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /orders-storage/po-lines/{id}

Delete po-line item with given {po-lineId}

DELETE /orders-storage/po-lines/{id}
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 PO Line

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 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: text/plain

Type: any

Example:

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"po-line not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /orders-storage/po-lines/{id}

Update po-line item with given {po-lineId}

PUT /orders-storage/po-lines/{id}
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 PO 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": "purchase order line",
  "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"
    },
    "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": "an array of alert record IDs",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "UUID of an 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}$"
      }
    },
    "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",
        "$ref": "claim.json"
      }
    },
    "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",
        "$ref": "contributor.json"
      }
    },
    "cost": {
      "description": "cost record",
      "type": "object",
      "$ref": "cost.json"
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "details record",
      "type": "object",
      "$ref": "details.json"
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "eresource record",
      "type": "object",
      "$ref": "eresource.json"
    },
    "fundDistribution": {
      "description": "Fund distribution records for this purchase order line",
      "id": "fundDistribution",
      "type": "array",
      "items": {
        "description": "fund distribution record",
        "type": "object",
        "$ref": "fund_distribution.json"
      }
    },
    "locations": {
      "description": "Location records for this purchase order line",
      "id": "locations",
      "type": "array",
      "items": {
        "description": "location record",
        "type": "object",
        "$ref": "location.json"
      }
    },
    "orderFormat": {
      "description": "The purchase order line format",
      "type": "object",
      "$ref": "order_format.json"
    },
    "owner": {
      "description": "the owner of this purchase order line",
      "type": "string"
    },
    "paymentStatus": {
      "description": "The purchase order line payment status",
      "type": "string",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending"
      ]
    },
    "physical": {
      "description": "UUID of the physical (details) record",
      "type": "object",
      "$ref": "physical.json"
    },
    "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]{5,16}-[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",
      "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",
      "$ref": "receipt_status.json"
    },
    "reportingCodes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reportingCodes",
      "type": "array",
      "items": {
        "description": "UUID of the reporting code",
        "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"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "source record",
      "type": "object",
      "$ref": "source.json"
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "title of the material",
      "type": "string"
    },
    "vendorDetail": {
      "description": "Vendor detail record",
      "type": "object",
      "$ref": "vendor_detail.json"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "source"
  ]
}

Example:

{
  "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "edition": "First edition",
  "checkinItems": false,
  "instanceId": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "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",
      "contributorType": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": {
    "additionalCost": 4.99,
    "currency": "USD",
    "discount": 5,
    "discountType": "percentage",
    "listUnitPrice": 24.99,
    "listUnitPriceElectronic": 14.99,
    "quantityElectronic": 1,
    "quantityPhysical": 2,
    "poLineEstimatedPrice": 66.71
  },
  "description": "ABCDEFGH",
  "details": {
    "receivingNote": "ABCDEFGHIJKL",
    "productIds": [
      {
        "productId": "9780764354113",
        "productIdType": "ISBN"
      }
    ],
    "materialTypes": [
    "f7e72403-2a13-43a4-a069-aaabe6c9dea8"
    ],
    "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": true,
    "expectedActivation": "2018-10-09T00:00:00.000Z",
    "license": {
      "code": "Code 1",
      "description": "License Agreement 1"
    },
    "trial": false,
    "userLimit": 10
  },
  "fundDistribution": [
    {
      "code": "HIST",
      "percentage": 80.0,
      "encumbrance": "eb506834-6c70-4239-8d1a-6414a5b08ac3"
    }
  ],
  "locations": [
    {
      "locationId": "eb2d063a-5b4c-4cab-8db1-5fc5c5941df6",
      "quantity": 1,
      "quantityElectronic": 1,
      "quantityPhysical": 0
    },
    {
      "locationId": "53cf956f-c1df-410b-8bea-27f712cca7c0",
      "quantity": 2,
      "quantityElectronic": 0,
      "quantityPhysical": 2
    }
  ],
  "orderFormat": "P/E Mix",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "paymentStatus": "Awaiting Payment",
  "physical": {
    "volumes": [
      "vol. 1"
    ],
    "materialSupplier": "73d14bc5-d131-48c6-b380-f8e62f63c8b6",
    "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": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": {
    "code": "Code1",
    "description": ""
  },
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "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"
  }
}

Response 204

Item successfully updated

Response 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: text/plain

Type: any

Example:

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"po-line not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator