API ReferenceReceiving Documents

List Receiving Documents

Retrieves a paginated list of receiving documents from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, customer ID, site ID, and receiving document type ID.

Authentication

Impilo-API-Keystring
API Key authentication via header

Query Parameters

createdAfterstringOptionalformat: "date-time"
completedAfterstringOptionalformat: "date-time"
itemIdslist of longsOptional
deviceIdslist of longsOptional
returnMerchAuthIdlongOptional
siteIdlongOptional
receivingDocumentTypeenumOptional
Allowed values:
pageintegerOptionalDefaults to 1
sizeintegerOptionalDefaults to 15

Response

OK
contentlist of objects or null
The content of the page, consisting of a list of objects.
firstboolean or null
True if this is the first page, false otherwise.
lastboolean or null
True if this is the last page, false otherwise.
pageinteger or null
The current page number. The first page has value 1.
sizeinteger or null
The current page size. Default 15, maximum 250.
totalinteger or null
The number of objects matching the request.