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.

Attributes

Name Type Description
idpicklist integer Unique Picqer reference
picklistid string Per-account picklist ID
idcustomer integer Linked to resource Customers
idorder integer Linked to resource Orders
idwarehouse integer Linked to resource Warehouse
deliveryname string Defined in Order resource
deliverycontact string Defined in Order resource
deliveryaddress string Defined in Order resource
deliveryaddress2 string Defined in Order resource
deliveryzipcode string Defined in Order resource
deliverycity string Defined in Order resource
deliverycountry string Defined in Order resource, 2-letter ISO country code
emailaddress string Defined in Customer resource
telephone string Defined in Customer resource
reference string Defined in Order resource
assigned_to_iduser integer Linked to User resource that is responsible for this picklist
invoiced boolean Is this picklist invoiced yet
status string What is the status of this picklist: new, closed, snoozed
totalproducts integer Total products on this picklist
totalpicked integer Amount of products that are already picked
created datetime Moment this picklist was created
updated datetime Last moment this picklist was changed
products array Collection of all products in this picklist
products.idproduct integer Linked to Product resource
products.idvatgroup integer Linked to VAT group resource
products.productcode string
products.name string
products.remarks string
products.amount integer Total amount needed
products.amountpicked integer Amount already picked
products.price float Price per product
products.weight integer Weight in grams per product
products.stocklocation string Location name for this product in this warehouse

Get all picklists

GET https://example.picqer.com/api/v1/picklists
HTTP/1.1 200 OK [ { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": null, "invoiced":false, "status":"new", "totalproducts":2, "totalpicked":0, "created":"2014-08-19 12:13:38", "updated":"2014-08-19 12:13:38", "products":[ { "idproduct":147, "idvatgroup":18, "productcode":"502.052.16", "name":"SUNDEROe", "remarks":"", "amount":1, "amountpicked":0, "price":69.95, "weight":10200, "stocklocation":"Plein C" }, { "idproduct":126654, "idvatgroup":18, "productcode":"1318512", "name":"4GB DDR3 PC10600\/1333Mhz REG ECC MEMORY (x4)", "remarks":null, "amount":1, "amountpicked":0, "price":0, "weight":0, "stocklocation":null } ] } ]

Filters

You can filter the picklists with the following parameters. Add these filters as querystring parameters to the URL.

Attribute Description Example
sinceid Get the picklists with later idpicklists then provided.
sincedate Get the picklists with later date time then provided. 2015-01-01 12:00:00
picklistid Get the picklist with the provided picklistid. P2015-90282
assigned_to_iduser Get the picklists that are assigned to this iduser. 28190
status Get the picklists with this status. new or closed

Get single picklist

GET https://example.picqer.com/api/v1/picklists/{idpicklist}
HTTP/1.1 200 OK { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": null, "invoiced":false, "status":"new", "totalproducts":2, "totalpicked":0, "created":"2014-08-19 12:13:38", "updated":"2014-08-19 12:13:38", "products":[ { "idproduct":147, "idvatgroup":18, "productcode":"502.052.16", "name":"SUNDEROe", "remarks":"", "amount":1, "amountpicked":0, "price":69.95, "weight":10200, "stocklocation":"Plein C" }, { "idproduct":126654, "idvatgroup":18, "productcode":"1318512", "name":"4GB DDR3 PC10600\/1333Mhz REG ECC MEMORY (x4)", "remarks":null, "amount":1, "amountpicked":0, "price":0, "weight":0, "stocklocation":null } ] }

Close a picklist

A picklist will be closed automatically when all products are picked. If not all products will be picked, you can close the picklist specifically. Products that are not yet picked, will be converted to backorders.

POST https://example.picqer.com/api/v1/picklists/{idpicklist}/close
HTTP/1.1 200 OK { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": null, "invoiced":false, "status":"closed", "totalproducts":2, "totalpicked":0, "created":"2014-08-19 12:13:38", "updated":"2014-08-19 12:13:38", "products":[ { "idproduct":147, "idvatgroup":18, "productcode":"502.052.16", "name":"SUNDEROe", "remarks":"", "amount":1, "amountpicked":0, "price":69.95, "weight":10200, "stocklocation":"Plein C" }, { "idproduct":126654, "idvatgroup":18, "productcode":"1318512", "name":"4GB DDR3 PC10600\/1333Mhz REG ECC MEMORY (x4)", "remarks":null, "amount":1, "amountpicked":0, "price":0, "weight":0, "stocklocation":null } ] }

Pick a product from the picklist

To notify to Picqer which products are picked, you can send it 'pick' notifies. As parameters the 'product' and 'amount' fields are required.

  • The product parameter expects the productcode, barcode or supplier's productcode of the product you want to pick.
  • 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.
POST https://example.picqer.com/api/v1/picklists/{idpicklist}/pick
{ "product": "502.052.16", "amount": 1 }
HTTP/1.1 200 OK { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": null, "invoiced":false, "status":"new", "totalproducts":2, "totalpicked":1, "created":"2014-08-19 12:13:38", "updated":"2014-08-19 12:13:38", "products":[ { "idproduct":147, "idvatgroup":18, "productcode":"502.052.16", "name":"SUNDEROe", "remarks":"", "amount":1, "amountpicked":1, "price":69.95, "weight":10200, "stocklocation":"Plein C" }, { "idproduct":126654, "idvatgroup":18, "productcode":"1318512", "name":"4GB DDR3 PC10600\/1333Mhz REG ECC MEMORY (x4)", "remarks":null, "amount":1, "amountpicked":0, "price":0, "weight":0, "stocklocation":null } ] }

Pick all products from the picklist

With this one call, you can mark all products from a picklist as picked.

POST https://example.picqer.com/api/v1/picklists/{idpicklist}/pickall
HTTP/1.1 200 OK { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": null, "invoiced":false, "status":"new", "totalproducts":2, "totalpicked":2, "created":"2014-08-19 12:13:38", "updated":"2014-08-19 12:13:38", "products":[ { "idproduct":147, "idvatgroup":18, "productcode":"502.052.16", "name":"SUNDEROe", "remarks":"", "amount":1, "amountpicked":1, "price":69.95, "weight":10200, "stocklocation":"Plein C" }, { "idproduct":126654, "idvatgroup":18, "productcode":"1318512", "name":"4GB DDR3 PC10600\/1333Mhz REG ECC MEMORY (x4)", "remarks":null, "amount":1, "amountpicked":2, "price":0, "weight":0, "stocklocation":null } ] }

Get shipments from picklist

GET https://example.picqer.com/api/v1/picklists/{idpicklist}/shipments
HTTP/1.1 200 OK { "idshipment":45975, "idpicklist":105731, "labelurl":"https:\/\/example.com\/label.pdf", "provider":"Manual", "providername":"Manual", "trackingcode":"3S890371237812", "tracktraceurl":null, "created":"2014-11-21 12:07:01", "updated":"2014-11-21 12:07:01" }

Assign a user to picklist

POST https://example.picqer.com/api/v1/picklists/{idpicklist}/assign
{ "iduser": 2991 }
HTTP/1.1 200 OK { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": 2991, "invoiced":false, ... }

Unassign a user to picklist

POST https://example.picqer.com/api/v1/picklists/{idpicklist}/unassign
HTTP/1.1 200 OK { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliverycountry":"NL", "emailaddress":"YassinevanLingen@mailinator.com", "telephone": null, "reference": "", "assigned_to_iduser": null, "invoiced":false, ... }

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 https://example.picqer.com/api/v1/picklists/{idpicklist}/picklistpdf
HTTP/1.1 200 OK { "idpicklist": 76859, "pdf": "JVBERi0xLjMKMSAwIG9iago8PCAvVHlwZSAvQ2F..." }

Get PDF of packinglist

Same thing applies as with a picklist PDF (see above), but with a different endpoint.

GET https://example.picqer.com/api/v1/picklists/{idpicklist}/packinglistpdf
Read more Purchase Orders