| Name
|
Data Type | Description |
| selectTop
|
int |
the first order to return from the sorted list; null = don't trim top |
| selectBottom
|
int |
the last order to return from the sorted list; null = don't trim bottom |
| rql
|
string |
refers to OrderDigest model properties;
see RQL documentation
|
| sort
|
string |
refers to OrderDigest model properties;
see RQL documentation
|
| markforlistid
|
int |
match orders containing "MarkForID" saved element in given MarkForList |
| skulist
|
string |
comma-delim list of skus, match any order with a line item for any given sku |
| skucontains
|
string |
single partial sku, match any order with a line item for given partial sku |
|
Type |
Description |
| ResourceList |
IList<Order.Models.OrderDigestBrief>
|
|
| OrderId |
int
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| IsClosed |
bool
|
|
| BatchIdentifier |
Generic.Models.BatchIdentifier
|
|
| NameKey |
Generic.Models.BatchNameKey
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| BatchCreationDate |
DateTime?
|
|
| Id |
int
|
|
| FullyAllocated |
bool
|
|
| ScacCode |
string
|
|
| TotPackages |
decimal?
|
|
| TotWeightMetric |
decimal?
|
|
| TotVolumeMetric |
decimal?
|
|
| TotWeightImperial |
decimal?
|
|
| TotVolumeImperial |
decimal?
|
|
| CanConfirm |
bool
|
order must be open, have line items, and be fully allocated
|
| CanUnconfirm |
bool
|
order must be closed but not cancelled
|
| CanComplete |
bool
|
order must be open and in a deferred notification state
|
| CanCancel |
bool
|
order must be open
|
| CanAllocate |
bool
|
order must be open, have line items, and not already by fully allocated
|
| CanDeallocate |
bool
|
order must be open and have allocations
|
| CanSplit |
bool
|
order must be open, have allocations but not fully allocated
|
| ParcelLabelType |
Common.Enum.ParcelLabelType
|
|
|
- 0: None |
|
|
- 1: Pdf |
|
|
- 2: Zpl |
|
| CanParcelExportTmw |
bool
|
order must not be exported to tmw
|
| CanRegenPkgs |
bool
|
order must be open, have no asn sent, and have not already smallparcel shipped
|
| PickJobId |
int?
|
Null if not in a pick job
|
| IsPickDone |
bool
|
order has been picked already
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/orders/order
|
The full order. |
|
-
/rels/orders/batch
|
Batch containing order. |
Sample accept: application/hal+json
{
"_embedded": {
"item": [
{
"orderId": 1,
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"facilityIdentifier": {
"name": "str",
"id": 2
},
"isClosed": true,
"batchIdentifier": {
"nameKey": {
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"name": "str"
},
"batchCreationDate": "2016-12-25T23:00:00",
"id": 1
},
"fullyAllocated": true,
"scacCode": "str",
"totPackages": 1.0,
"totWeightMetric": 1.0,
"totVolumeMetric": 1.0,
"totWeightImperial": 1.0,
"totVolumeImperial": 1.0,
"canConfirm": true,
"canUnconfirm": true,
"canComplete": true,
"canCancel": true,
"canAllocate": true,
"canDeallocate": true,
"canSplit": true,
"parcelLabelType": 0,
"canParcelExportTmw": true,
"canRegenPkgs": true,
"pickJobId": 1,
"isPickDone": true
}
]
}
}
REL documentation