Document line details

List of warehouse inventory details including serial number, aisle, bin, and row per item.

List document line details

get/objects/purchasing/document-line-detail

Returns a collection with a key, ID, and link for each purchasing document line details.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "value": {
    • "ia::result": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "ia::meta": {
      • "totalCount": 3,
      • "start": 1,
      • "pageSize": 100
      }
    }
}
Get a document line detail object
get/objects/purchasing/document-line-detail/{key}
Returns detailed information for a specified purchasing document line detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the document line detail object.


 
 Example:  96
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "11",
    • "key": "11",
    • "purchasingDocumentLine": {
      • "id": "883",
      • "key": "883",
      • "documentType": "Purchase Order",
      • "href": "/objects/purchasing/document-line::Purchase%20Order/883"
      },
    • "item": {
      • "id": "Battery",
      • "key": "258",
      • "href": "/objects/item/258"
      },
    • "quantity": "1",
    • "serialNumber": "SLX 728",
    • "lotNumber": "1981",
    • "aisle": {
      • "key": "1",
      • "id": "A1",
      • "href": "/objects/inventory-control/aisle/1"
      },
    • "row": {
      • "key": "1",
      • "id": "R1",
      • "href": "/objects/inventory-control/row/1"
      },
    • "bin": {
      • "key": "1",
      • "id": "B1",
      • "href": "/objects/inventory-control/bin/1"
      },
    • "expirationDate": "2023-12-31",
    • "audit": {
      • "createdDateTime": "2023-12-14T04:58:04Z",
      • "modifiedDateTime": "2023-12-14T04:58:04Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/purchasing/document-line-detail/11"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query document line details
post/services/core/query
Use the query service to find document line details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}