| Name
(* = required)
|
Data Type | Description |
| id
*
|
int |
Id of the specified asynchronous operation |
Returns status object that can will eventually have the results of the specified operation
|
Type |
Description |
| AsyncOperationStatusId |
int?
|
|
| OrderHoldsAttempted |
int?
|
|
| OrdersHeld |
int?
|
|
| OrderHoldResults |
Order.Models.OrderHoldResults
|
|
| HeldOrderIds |
Int32[]
|
|
| Exceptions |
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
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/orders/orderholder
|
may be polled until the operation is complete or fails |
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/orders/orderholderasyncstatus
|
may be polled until the operation is complete or fails |
Sample accept: application/hal+json
{
"asyncOperationStatusId": 1,
"orderHoldsAttempted": 1,
"ordersHeld": 1,
"_embedded": {
"http://api.3plCentral.com/rels/orders/orderholder": {
"heldOrderIds": [
1
],
"exceptions": {
"message": "ListException: Faults [{EntryNumber 1, }]",
"faults": [
{
"entryNumber": 1,
"entryInfo": "str"
}
],
"data": {},
"helpLink": "str",
"source": "str",
"hResult": 3
}
}
}
}