REL documentation
orders pickjobs (http://api.3plcentral.com/rels/orders/pickjobs)
Resource:
Collection: of pickjob
C# Rel Const:
Rels.OrderSvc.PickJobs
URI template:
pickjobs{?pgsiz,pgnum,rql,sort,loadout}
Obtain URI from:
Billboard , /rels/orders/pickcandidates
job-centric, multi-order pick information (see pickcandidates for order-centric)
Success status: 200
Name Data Type Description
pgsiz int must be positive; limit 1000, specifying more is an error; default 100; max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
loadout bool
Type Description
TotalResults int
ResourceList IList<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
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_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
        }
      }
    ]
  }
}
create new pick job
all orders must be for same customer and facility
all orders must be in a state of eventually pickable
Success status: 201; ETag response header supplied
none
Type Description
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
Sample content-type: application/hal+json
 
{
  "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
  }
}
Type Description
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
Sample accept: application/hal+json
{
  "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
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.