Picklists
Picklists are generated by Picqer when an order is closed or when backorders are processed. Picklists are orders that need to be collected in the warehouse and be send to the customer.
We have a seperate page about picklist batches in the API.
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
| idpicklist | integer | generated | Unique Picqer reference |
| picklistid | string | generated | Per-account picklist ID |
| idcustomer | integer | optional | Linked to resource Customers |
| idorder | integer | optional | Linked to resource Orders |
| idreturn | integer | optional | Linked to resource Returns |
| idwarehouse | integer | required | Linked to resource Warehouse |
| idtemplate | integer | required | Linked to resource Templates |
| idpicklist_batch | integer | optional | Linked to resource Picklist Batches |
| idshippingprovider_profile | integer | optional | Optional. The preferred shipping provider profile for this picklist |
| deliveryname | string | required | Defined in Order resource |
| deliverycontact | string | optional | Defined in Order resource |
| deliveryaddress | string | optional | Defined in Order resource |
| deliveryaddress2 | string | optional | Defined in Order resource |
| deliveryzipcode | string | optional | Defined in Order resource |
| deliverycity | string | optional | Defined in Order resource |
| deliveryregion | string | optional | Defined in Order resource |
| deliverycountry | string | required | Defined in Order resource, 2-letter ISO country code |
| telephone | string | optional | |
| emailaddress | string | optional | |
| reference | string | optional | Defined in Order resource |
| assigned_to_iduser | integer | optional | Linked to User resource that is responsible for this picklist |
| invoiced | boolean | required | Is this picklist invoiced yet |
| urgent | boolean | required | Is this picklist marked as urgent |
| preferred_delivery_date | date | optional | If the customer requested a preferred delivery date |
| status | string | required | What is the status of this picklist: new, paused, closed, snoozed, cancelled |
| paused_reason | string | optional | A string with the reason why the picklist is paused, null if the picklist is not paused |
| totalproducts | integer | required | Amount of products on this picklist |
| totalpicked | integer | required | Amount of products that are already picked |
| weight | integer | required | Total weight of picklist |
| snoozed_until | datetime | optional | If a picklist is snoozed, it will be unsnoozed at this moment |
| closed_by_iduser | integer | optional | If picklist is closed, which User closed it |
| closed_at | datetime | optional | Moment this picklist was closed |
| created | datetime | required | Moment this picklist was created |
| updated | datetime | required | Last moment the core elements of the picklist were changed (for example, the assignment to a user). However, this field does not update when changes are made to the picklist products. |
| idfulfilment_customer | integer | optional | Only for Picqer Fulfilment: Linked to belonging fulfilment customer |
| products | array | required | Collection of all products in this picklist |
| products.idproduct | integer | generated | Linked to Product resource |
| products.idorder_product | integer | optional | Linked to the order line that resulted in this picklist line. Can be null if this picklist is from a return |
| products.idreturn_product_replacement | integer | optional | Linked to the product replacement of a return that resulted in this picklist line. Can be null if this picklist is from a order |
| products.idvatgroup | integer | required | Linked to VAT group resource |
| products.productcode | string | required | |
| products.name | string | required | |
| products.remarks | string | optional | |
| products.amount | integer | required | Total amount needed |
| products.amount_picked | integer | required | Amount already picked |
| products.price | float | required | Price per product |
| products.weight | integer | optional | Weight in grams per product |
| products.stock_location | string | deprecated | Location name for this product in this warehouse |
| products.pick_locations | array | required | Collection of locations where the product should be picked |
| products.pick_locations.idpicklist_product_location | integer | generated | Linked to the PicklistProductLocation resource |
| products.pick_locations.idlocation | integer|null | generated | Linked to Location resource that contains the stock that should be picked. Can be null if the stock is allocated on no specific location. |
| products.pick_locations.name | string | required | The name of the linked location |
| products.pick_locations.amount | amount | required | The amount that should be picked from the location |
| products.pick_locations.amount_picked | amount_picked | required | The amount that is picked on the location for this picklist |
| products.pick_locations.lot_number | string|null | generated | Lot number recorded when this location was picked. Historical values can remain available after traceability is switched off. |
| products.pick_locations.expiration_date | date|null | generated | Expiration date recorded when this location was picked, in Y-m-d format. Historical values can remain available after traceability is switched off. |
A note about pick locations: The pick locations are automatically determined by Picqer when a picklist is created. The pick locations assigned to a picklist product can however change when stock is moved between locations.
It is also possible that the sum of the products.pick_locations.amount does not equal the amount of a product itself. This happens when some stock for a product is not registered on a specific location.
At this moment the idpicklist_product_location and amount_picked are behind a feature flag. We're enabling this feature gradually over the coming week. See the changelog for updates.
Get all picklists
Filters
You can filter the picklists with the following parameters. Add these filters as querystring parameters to the URL.
| Attribute | Description | Example |
|---|---|---|
| sinceid | Get picklists after this idpicklist | 266672 |
| beforeid | Get picklists with a smaller idpicklist than given | 366672 |
| sincedate | Get picklists created after this datetime | 2018-01-01 12:00:00 |
| untildate | Get picklists created before this datetime | 2018-01-01 12:00:00 |
| closed_after | Get picklists closed after this datetime | 2018-01-01 12:00:00 |
| closed_before | Get picklists closed before this datetime | 2018-01-01 12:00:00 |
| picklistid | Get picklist with the provided picklistid. | P2015-90282 |
| assigned_to_iduser | Get picklists that are assigned to this iduser. | 28190 |
| idwarehouse | Get picklists for this idwarehouse. | 28190 |
| status | Get picklists with this status. | new, paused, closed, snoozed or cancelled |
| idfulfilment_customer | Get picklists for this fulfilment customer. | 623 |
| tag | Get the picklists that have the given tag name associated with them. | summer |
Get single picklist
Update picklist
At this moment you can only update these fields of picklists.
- urgent
- invoiced
- idshippingprovider_profile
Close a picklist
A picklist is closed automatically when a shipment is created while all products are picked. If you want to close a picklist without creating a shipment, you can use this endpoint for closing the picklist manually.
Pick a product from the picklist
To let Picqer know which products are picked, you can send 'pick' requests. As parameters idpicklist_product, idpicklist_product_location or product and amount are required.
To undo a pick action, use idpicklist_product to specify which picklist line should be 'unpicked' and enter a negative amount.
- The product parameter expects the productcode, barcode or supplier's productcode of the product you want to pick. This can involve several picklist lines as it is technically possible to have a product on a picklist multiple times. Only products that have not been fully picked yet will be found.
- The idpicklist_product parameter specifies the picklist product line. This will yield a maximum of one line.
- The idpicklist_product_location parameter specifies the picklist product pick location line. This will yield a maximum of one line.
- The amount parameter can be a number or the text 'all' to indicate you want to pick the total amount of products with this productcode.
Pick all products from the picklist
With this one call, you can mark all products from a picklist as picked.
Change pick locations on the picklist
With this call, you can change the pick locations for a single product row (picklist product) on a picklist.
You can provide multiple locations for one picklist product. The total amount across all locations must be equal to the amount to be picked.
The provided locations must be linked to the product and have sufficient stock available.
| Name | Type | Description |
|---|---|---|
| idlocation | integer | Linked to resource Locations |
| amount | integer | Amount to be picked from this location |
Shipments
More information about shipments and creating a shipment, can be found on the Picklist Shipments page.
Assign a user to picklist
Unassign a user to picklist
Get packaging advice for a picklist
When there is no packaging advice for the picklist, all fields are still returned in the response, but with null values.
Set packaging advice for a picklist
Get PDF of picklist
PDF of a picklist can be retrieved as a base64 encoded document in JSON, or as a direct PDF document.
If the header Accept: application/json is given in the request, we will give you a response as shown below. Otherwise we will send you the PDF document directly with an Content-Type: application/pdf header as response.
Get PDF of packinglist
Same thing applies as with a picklist PDF (see above), but with a different endpoint.
Snooze picklist
You can snooze open picklists. This picklist will be hidden from the list of picklists and will reappear on the given moment.
You can 'unsnooze' a snoozen picklist by posting "snooze_until" with null.
Pause picklist
You can pause picklists with the status new. This means, among other things, that this picklist is detached from, and no longer available for, batches. Also, the assigned user is unlinked, shipments can no longer be created, and the picklist cannot be closed.
A reason for pausing is required. Read more about pausing in this support article
Resume picklist
Paused picklists, that are part of an order that is not paused, can be individually resumed. This will put the status back to the status 'new' and will, among other things, make the picklist available for batches and make it possible to create shipments again. Read more about pausing and resuming here
Cancel a product from the picklist
Cancel (part of) a single product line on a picklist that is not yet closed. Only the amount that has not been picked yet can be cancelled. The cancelled amount is turned into a backorder.
Cancelling the last remaining product(s) on a picklist cancels the whole picklist.
Specify the product to cancel with either idpicklist_product or product. When both are given, idpicklist_product takes priority.
| Name | Type | Description |
|---|---|---|
| idpicklist_product | integer | The picklist product line to cancel. Takes priority over product. |
| product | string | The productcode of the product to cancel. When the product appears on the picklist more than once, the first line that still has an unpicked amount is used. |
| amount | integer | The amount to cancel. Optional, defaults to 1. Must be a positive number and cannot be higher than the unpicked amount of the line. |
| idlocation | integer | Cancel the amount from this pick location only. Optional. When omitted, the amount is spread across the product's locations, starting with the amount that has no location, then the oldest locations first. Linked to resource Locations. |
An individual part of a composition cannot be cancelled on its own. Cancel the composition itself instead. A composition can only be cancelled while none of its parts have been picked yet. Unlimited stock products cannot be cancelled.
Cancel picklist
This cancels a picklist. Picklist products will be converted into backorders.
Warning: Cancelling an already closed picklist will re-add product to the stock and remove any shipments attached to this picklist.
Comments
Comments are supported for picklists.
