Name
Data Type Description
labelFormat
Common.Enum.LabelFormatType
specify which label format to request. (default: zpl)
- Zpl
- Png
- Pdf
specify the orders to be canceled
Sample content-type: application/hal+json
Copy to clipboard
copied
{
"orderIdentifiers": [
{
"id": 1
}
]
}
Type
Description
FaultedOrders
Generic.Models.Exceptions.ListException
container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message
string
Faults
IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber
int
1-indexed position in the source list
EntryInfo
string
optional info about the entry in the source list, such as id, sku, ref#, etc.
WmsException
Generic.Models.Exceptions.WmsExceptionBase
for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode
string
could have been a number, but is a short string for human readability; not to be localized
Hint
string
helpful word or two if the thrower happens to know more things; not to be localized
Message
string
InnerException
System.Exception
ResourceList
IList<Order.Models.Parcel>
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
{
"faultedOrders": {
"message": "ListException: Faults [{EntryNumber 1, }]" ,
"faults": [
{
"entryNumber": 1 ,
"entryInfo": "str"
}
],
"data": {},
"helpLink": "str" ,
"source": "str" ,
"hResult": 3
},
"_embedded": {
"http://api.3plCentral.com/rels/orders/orderparcelshippinglabel": [
{
"orderId": 1 ,
"parcelResponseId": 2 ,
"parcelResponseDetailIds": [
1
],
"shipDate": "2016-12-25T23:00:00" ,
"voidDate": "2016-12-25T23:00:00" ,
"contentType": "str" ,
"contents": [
{}
]
}
]
}
}