| Name
(* = required)
|
Data Type | Description |
| id
*
|
int |
order id |
| labelFormat
|
Common.Enum.LabelFormatType |
specify which label format to request. (default: zpl) |
| - Zpl | |
| - Png | |
| - Pdf | |
|
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
|
| 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": [
{}
]
}