| Name
(* = required)
|
Data Type | Description |
| id
*
|
int |
order id |
| labelFormat
|
Common.Enum.LabelFormatType |
specify which label format to request. (default: zpl) |
| - Zpl | |
| - Png | |
| - Pdf | |
| includeReturnLabels
|
bool |
include return label along with shipping label |
|
Type |
Description |
| OrderId |
int
|
|
| ParcelResponseId |
int
|
|
| ParcelResponseDetailIds |
IEnumerable<int>
|
|
| ShipDate |
DateTime?
|
|
| VoidDate |
DateTime?
|
|
| ContentType |
string
|
mime type of browser-downloadable format (ie. pdf, csv, png, etc.) for all labels tied to an order
|
| Contents |
IList<Object>
|
list of zpl printer (string) or browser-downloadable label (byte[]) objects, based on the ContentType
|
| Documents |
IList<Order.Models.ParcelDocument>
|
Documents whose rendered format differs from and therefore
could not be merged into . Null or empty when every document
matches the label format. Consumers must route each entry by its own ContentType.
|
|
Order.Models.ParcelDocument |
A rendered document (packing slip, UCC128, etc.) that travels alongside the labels in
but carries its own content type.
|
| DocType |
string
|
"packingSlip" or "ucc128". Matches PAPI docType / legacy report role.
|
| Source |
string
|
"papi" or "legacy".
|
| ContentType |
string
|
"application/pdf" or "text/plain" (ZPL). Independent of .
|
| Scope |
string
|
"shipment" (one per order) or "package" (one per carton).
|
| Content |
Byte[]
|
PDF bytes, or UTF-8 encoded ZPL bytes when ContentType is "text/plain".
|
| DocumentWarnings |
IList<Order.Models.ParcelDocumentWarning>
|
Documents requested on ship that PAPI did not return. Not printed.
|
| DocType |
string
|
|
| TemplateId |
string
|
|
| Reason |
string
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/orders/order
|
|
Sample accept: application/hal+json
{
"orderId": 1,
"parcelResponseId": 2,
"parcelResponseDetailIds": [
1
],
"shipDate": "2016-12-25T23:00:00",
"voidDate": "2016-12-25T23:00:00",
"contentType": "str",
"contents": [
{}
],
"documents": [
{
"docType": "str",
"source": "str",
"contentType": "str",
"scope": "str",
"content": "QA=="
}
],
"documentWarnings": [
{
"docType": "str",
"templateId": "str",
"reason": "str"
}
]
}
REL documentation