Type	Description
PickItemId	string	Identifies an item in jid's pick list (it's an opaque value, don't try to concoct one or crack it)

Sample content-type: application/hal+json

Copy to clipboard

copied

{
  "pickItemId": "str"
}

	Type	Description
PickJob	Order.Models.PickJob
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
ResourceList	IList<Order.Models.ConsolidatedPickItem>
PickItem	Order.Models.PickItem
PickedQty	decimal	convenience; ΣOrderPickQty.PickedQty
Qty	decimal	convenience; ΣOrderPickQty.Qty
WeightImperial	decimal	ΣReceiveItem.WeightImperial
WeightMetric	decimal	ΣReceiveItem.WeightMetric
IsOnLoadableMu	bool	A bool representing whether a MU is Loadable
Supplier	string	The supplier name, if one is applicable
RefNums	List<string>	The Order Reference number associated with a pickitem
IsInsert	bool
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? ...
Picker	Generic.Models.UserIdentifier
Name	string
Id	int
OrderPickQtys	IEnumerable<Order.Models.OrderPickQty>	breakdown by order; use for binning, otherwise safely ignore
OrderId	int
OrderItemIds	List<int>
Qty	decimal
PickedQty	decimal
Bin	string
Loaded	bool
SourceData	IEnumerable<Order.Models.PickSource>
ReceiveItemId	int
Qty	decimal
PickItemId	string
Links	IList<WebApi.Hal.Link>
	- /rels/orders/pick
	- /rels/orders/mispick
	- /rels/orders/unpick
	- /rels/orders/load
	- /rels/orders/pickitemassign
	- /rels/orders/pickitem
Links	IList<WebApi.Hal.Link>
	- /rels/orders/pickjobcomplete
	- /rels/orders/pickjobload

Sample accept: application/hal+json

{
  "_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
      }
    },
    "item": [
      {
        "pickItem": {
          "pickedQty": 1.0,
          "qty": 2.0,
          "weightImperial": 3.0,
          "weightMetric": 4.0,
          "isOnLoadableMu": true,
          "supplier": "str",
          "refNums": [
            "str"
          ],
          "isInsert": true,
          "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
        },
        "picker": {
          "name": "str",
          "id": 2
        },
        "orderPickQtys": [
          {
            "orderId": 1,
            "orderItemIds": [
              1
            ],
            "qty": 2.0,
            "pickedQty": 3.0,
            "bin": "str",
            "loaded": true
          }
        ],
        "sourceData": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "pickItemId": "str"
      }
    ]
  }
}