|
Type |
Description |
| TotalResults |
int
|
|
| ResourceList |
IList<Order.Models.OrderDigest>
|
|
| FacilityTimeZoneName |
string
|
|
| ImportChannelIdentifier |
Generic.Models.ChannelIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Status |
Common.Enum.WarehouseTransactionApiStatus
|
For rql, this property is reliable only for "Canceled" status; otherwise use the IsClosed property.
|
|
- 0: Open |
Has not yet been confirmed |
|
- 1: Closed |
Has been confirmed |
|
- 2: Canceled |
Has been canceled |
| ReferenceNum |
string
|
|
| PoNum |
string
|
|
| Description |
string
|
|
| RouteSent |
bool
|
|
| AsnSentDate |
DateTime?
|
|
| AsnSent |
bool
|
|
| Notes |
string
|
|
| DeferNotification |
bool
|
|
| PickDoneDate |
DateTime?
|
Stored and displayed in warehouse time
|
| PackDoneDate |
DateTime?
|
Stored and displayed in warehouse time
|
| PickTicketPrintDate |
DateTime?
|
Stored in server time, displayed in warehouse time
|
| ProcessDate |
DateTime?
|
|
| ShipCancelDate |
DateTime?
|
|
| CreationDate |
DateTime
|
|
| EarliestShipDate |
DateTime?
|
|
| EndOfDayDate |
DateTime?
|
|
| BillOfLading |
string
|
|
| LoadNumber |
string
|
|
| MasterBillOfLadingId |
string
|
|
| PickupDate |
DateTime?
|
|
| TrackingNumber |
string
|
|
| TrackingUrl |
string
|
|
| BillingCode |
string
|
|
| Carrier |
string
|
|
| Source |
Common.Enum.WarehouseTransactionSourceType
|
how the transaction entered the system
|
|
- 0: Unknown |
|
|
- 1: UiManual |
|
|
- 2: UiImport |
|
|
- 3: AutomatedImport |
|
|
- 4: ExternalSoapApi |
|
|
- 5: QuickBooksSoapApi |
|
|
- 6: AutomatedSystemCharge |
|
|
- 7: RestApi |
|
| LoadOutPercentage |
int?
|
percentage of order's qty marked as loaded out (scanner app allows operator to specify a picked item is loaded out)
|
| LoadOutDoneDate |
DateTime?
|
Stored and displayed in warehouse time
|
| SmallParcelShipDate |
DateTime?
|
|
| SmallParcelHvpBatchId |
string
|
|
| SmallParcelHvpBatchName |
string
|
|
| ShipTo |
Generic.Models.ContactInfo
|
in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
|
| ContactId |
int?
|
for identifying: if known specify only this; other fields are ignored
|
| CompanyName |
string
|
|
| Name |
string
|
|
| Title |
string
|
|
| Address1 |
string
|
|
| Address2 |
string
|
|
| City |
string
|
|
| State |
string
|
|
| Zip |
string
|
|
| Country |
string
|
|
| PhoneNumber |
string
|
|
| Fax |
string
|
|
| EmailAddress |
string
|
|
| Dept |
string
|
|
| IsAddressResidential |
bool
|
|
| Code |
string
|
for identifying: if known specify only this; if other fields also specified it is not used to identify
|
| AddressStatus |
Common.Enum.AddressStatusType
|
confirmation status
|
|
- 0: Unconfirmed |
|
|
- 1: Confirmed |
|
|
- 2: UserAccepted |
|
| ShipToRetailerIdentifier |
Generic.Models.RetailerIdentifier
|
|
| NameKey |
Generic.Models.RetailerNameKey
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Number |
string
|
|
| Id |
int
|
|
| SavedElements |
IEnumerable<Generic.Models.SavedElement>
|
|
| Name |
string
|
|
| Value |
string
|
|
| MarkForLists |
IEnumerable<Generic.Models.MarkForListIdentifier>
|
|
| Name |
string
|
|
| Id |
int
|
|
| OrderItemInfos |
IEnumerable<Order.Models.OrderItemInfo>
|
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
|
| Sku |
string
|
|
| Id |
int
|
|
| PrimaryInvQty |
decimal
|
|
| HasAllocations |
bool
|
|
| ShipService |
string
|
|
| CreatedByIdentifier |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| CanMarkForAsn |
bool
|
order's asn must not have already been sent
|
| CanGenerateBol |
bool
|
order must be open
|
| CustomerDeactivated |
bool
|
|
| PickerIdentifier |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| ShippingNotes |
string
|
|
| ShipDate |
DateTime?
|
|
| 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/orderfilesummaries
|
Info on files attached to order. |
|
-
/rels/customers/customer
|
|
|
-
/rels/properties/facility
|
|
|
-
/rels/orders/items
|
|
|
-
/rels/orders/batch
|
Batch containing order. |
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
next |
|
|
-
prev |
|
Sample accept: application/hal+json
{
"totalResults": 1,
"_embedded": {
"item": [
{
"facilityTimeZoneName": "str",
"importChannelIdentifier": {
"name": "str",
"id": 2
},
"status": 0,
"referenceNum": "str",
"poNum": "str",
"description": "str",
"routeSent": true,
"asnSentDate": "2016-12-25T23:00:00",
"asnSent": true,
"notes": "str",
"deferNotification": true,
"pickDoneDate": "2016-12-25T23:00:00",
"packDoneDate": "2016-12-25T23:00:00",
"pickTicketPrintDate": "2016-12-25T23:00:00",
"processDate": "2016-12-25T23:00:00",
"shipCancelDate": "2016-12-25T23:00:00",
"creationDate": "2016-12-25T23:00:00",
"earliestShipDate": "2016-12-25T23:00:00",
"endOfDayDate": "2016-12-25T23:00:00",
"billOfLading": "str",
"loadNumber": "str",
"masterBillOfLadingId": "str",
"pickupDate": "2016-12-25T23:00:00",
"trackingNumber": "str",
"trackingUrl": "str",
"billingCode": "str",
"carrier": "str",
"source": 0,
"loadOutPercentage": 1,
"loadOutDoneDate": "2016-12-25T23:00:00",
"smallParcelShipDate": "2016-12-25T23:00:00",
"smallParcelHvpBatchId": "str",
"smallParcelHvpBatchName": "str",
"shipTo": {
"contactId": 1,
"companyName": "str",
"name": "str",
"title": "str",
"address1": "str",
"address2": "str",
"city": "str",
"state": "str",
"zip": "str",
"country": "str",
"phoneNumber": "str",
"fax": "str",
"emailAddress": "str",
"dept": "str",
"isAddressResidential": true,
"code": "str",
"addressStatus": 0
},
"shipToRetailerIdentifier": {
"nameKey": {
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"name": "str",
"number": "str"
},
"id": 1
},
"savedElements": [
{
"name": "str",
"value": "str"
}
],
"markForLists": [
{
"name": "str",
"id": 2
}
],
"orderItemInfos": [
{
"itemIdentifier": {
"sku": "str",
"id": 2
},
"primaryInvQty": 1.0
}
],
"hasAllocations": true,
"shipService": "str",
"createdByIdentifier": {
"name": "str",
"id": 2
},
"canMarkForAsn": true,
"canGenerateBol": true,
"customerDeactivated": true,
"pickerIdentifier": {
"name": "str",
"id": 2
},
"shippingNotes": "str",
"shipDate": "2016-12-25T23:00:00",
"orderId": 25,
"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