|
Type |
Description |
| TotalResults |
int
|
|
| ResourceList |
IList<Order.Models.PickCandidate>
|
|
| OrderId |
int
|
each candidate is one order; see pickjobs for multi-order
|
| CustomerId |
int
|
|
| IsClosed |
bool
|
|
| PickDoneDate |
DateTime?
|
Stored and displayed in warehouse time
|
| LoadOutDoneDate |
DateTime?
|
|
| FullyAllocated |
bool
|
|
| PickJobId |
int?
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| PickJob |
Order.Models.PickJob
|
null if order not yet assigned to a pick job; see pickjobs link for creating pick job
|
| ReadOnly |
Order.Models.PickJobReadOnly
|
|
| PickJobId |
int
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| NOrders |
int
|
# of orders in this pick job; convenience for counting OrderIdentifiers
|
| CreatedBy |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| CreationDateUtc |
DateTime
|
|
| LastUpdatedBy |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| LastUpdateDateUtc |
DateTime
|
|
| AssignedDateUtc |
DateTime?
|
|
| DoneDateUtc |
DateTime?
|
|
| DoneIncomplete |
bool
|
true if operator closed job with remaining items to pick
|
| ReasonForIncomplete |
string
|
specify reason if operator completes a job with remaining items to pick
|
| MispickExplanations |
string
|
updated automatically when mispicked
|
| Priority |
int
|
any number, uninterpreted by system, used solely for sorting by user
|
| PickInstructions |
string
|
|
| PickerId |
int?
|
for use in candidate searches only; ignored for all other purposes
|
| Picker |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| OrderIdentifiers |
IEnumerable<Generic.Models.OrderIdentifier>
|
which orders are in this job
|
| Id |
int
|
|
| LoadOutLocation |
Generic.Models.LocationIdentifier
|
Location used to stage inventory for load out
|
| NameKey |
Generic.Models.LocationNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
edit |
|
|
-
/rels/orders/picklist
|
|
|
-
/rels/customers/customer
|
|
|
-
/rels/orders/startpick
|
|
|
-
/rels/orders/pickjobpause
|
|
| PickList |
IEnumerable<Order.Models.CandidatePickItem>
|
information for only the given order; is not consolidated across orders if order part of multi-order job
|
| Qty |
decimal
|
Ī£OrderItem.Qty
|
| LocationIdentifier |
Generic.Models.LocationIdentifier
|
|
| NameKey |
Generic.Models.LocationNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| LocationSort |
Order.Models.LocationSort
|
|
| Field1 |
string
|
|
| Field2 |
string
|
|
| Field3 |
string
|
|
| Field4 |
string
|
|
| ItemTraits |
Generic.Models.ItemTraits
|
unique identifying characteristics of an item in a location
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
|
| Sku |
string
|
|
| Id |
int
|
|
| Qualifier |
string
|
|
| LotNumber |
string
|
|
| SerialNumber |
string
|
|
| Cost |
decimal?
|
|
| ExpirationDate |
DateTime?
|
|
| PalletIdentifier |
Generic.Models.PalletIdentifier
|
|
| NameKey |
Generic.Models.PalletNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| UnitIdentifier |
Generic.Models.UnitOfMeasureIdentifier
|
for convenience, referenced item's primary inventory unit
|
| Name |
string
|
|
| Id |
int
|
|
| SecondaryUnitIdentifier |
Generic.Models.UnitOfMeasureIdentifier
|
for convenience, referenced item's secondary inventory unit if defined
|
| Name |
string
|
|
| Id |
int
|
|
| SecondaryQty |
decimal?
|
|
| IsOrderQtySecondary |
bool
|
|
| PickPath |
int?
|
|
| CustomerName |
string
|
|
| CustomerDeactivated |
bool
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/orders/pickjobs
|
create pick job for order; link present only if not already a pick job |
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
next |
|
|
-
prev |
|
Sample accept: application/hal+json
{
"totalResults": 1,
"_embedded": {
"item": [
{
"orderId": 1,
"customerId": 2,
"isClosed": true,
"pickDoneDate": "2016-12-25T23:00:00",
"loadOutDoneDate": "2016-12-25T23:00:00",
"fullyAllocated": true,
"pickJobId": 1,
"facilityIdentifier": {
"name": "str",
"id": 2
},
"pickList": [
{
"qty": 1.0,
"locationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"locationSort": {
"field1": "str",
"field2": "str",
"field3": "str",
"field4": "str"
},
"itemTraits": {
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"lotNumber": "str",
"serialNumber": "str",
"cost": 1.0,
"expirationDate": "2016-12-25T23:00:00",
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
},
"unitIdentifier": {
"name": "str",
"id": 2
},
"secondaryUnitIdentifier": {
"name": "str",
"id": 2
},
"secondaryQty": 1.0,
"isOrderQtySecondary": true,
"pickPath": 1
}
],
"customerName": "str",
"customerDeactivated": true,
"_embedded": {
"http://api.3plCentral.com/rels/orders/pickjob": {
"readOnly": {
"pickJobId": 1,
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"facilityIdentifier": {
"name": "str",
"id": 2
},
"nOrders": 2,
"createdBy": {
"name": "str",
"id": 2
},
"creationDateUtc": "2016-12-25T23:00:00",
"lastUpdatedBy": {
"name": "str",
"id": 2
},
"lastUpdateDateUtc": "2016-12-25T23:00:00",
"assignedDateUtc": "2016-12-25T23:00:00",
"doneDateUtc": "2016-12-25T23:00:00",
"doneIncomplete": true,
"reasonForIncomplete": "str",
"mispickExplanations": "str"
},
"priority": 1,
"pickInstructions": "str",
"pickerId": 1,
"picker": {
"name": "str",
"id": 2
},
"orderIdentifiers": [
{
"id": 1
}
],
"loadOutLocation": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
}
}
}
]
}
}
REL documentation