The PagedShipmentResult JSON object defines a page of Shipment JSON Object results in the DSCO system.
- Make sure you're familiar with JSON before continuing.
- The JSON objects are defined using Orderly. Optional attrs end with a "?" all others are required.
- isodate fields use one of these ISO 8601 format: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
- Dsco reserves the right to add new attributes at any time so Partners should ensure their validators won't break should this happen
Definition
Object
{
int pageNum; # Page number of this page of results
int pageSize; # The max number of objects per page of results
int pageCount; # The number of total pages in the results
array{ref Shipment} shipments; # Shipments in current page of results
};
Example
{
"pageNum": 2,
"pageSize": 100,
"pageCount": 18,
"shipments":
[
<Shipment>,
<Shipment>
]
}
Comments
Please sign in to leave a comment.