Document line details

Inventory tracking details including serial number, aisle, bin, and row per line item.

Create and maintain document line details by creating and updating the trackingDetail in the owning document line objects.

List document line detail objects

get/objects/order-entry/document-line-detail

Returns a collection with a key, ID, and link for each Order Entry document line detail object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned.

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/order-entry/document-line-detail/{key}

Returns detailed information for a specified Order Entry document line detail object.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the document line detail object.

Example: 17
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "15",
    • "key": "15",
    • "orderEntryDocumentLine": {
      • "id": "772",
      • "key": "772",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry-document-line::Sales%20Order/772"
      },
    • "item": {
      • "id": "Hose Clamp",
      • "key": "147",
      • "href": "/objects/item/147"
      },
    • "quantity": "1",
    • "serialNumber": "SMR 617",
    • "lotNumber": "1890",
    • "aisle": {
      • "key": "2",
      • "id": "A2",
      • "href": "/objects/inventory-control/aisle/2"
      },
    • "row": {
      • "key": "3",
      • "id": "R3",
      • "href": "/objects/inventory-control/row/3"
      },
    • "bin": {
      • "key": "12",
      • "id": "B12",
      • "href": "/objects/inventory-control/bin/12"
      },
    • "expirationDate": "2024-12-31",
    • "audit": {
      • "createdDateTime": "2024-06-13T00:00:00Z",
      • "modifiedDateTime": "2024-06-26T05:51:05Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "href": "/objects/order-entry/document-line-detail/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}