Webhook Examples

Back to webhooks

orders.*

All orders.* webhooks will give you a complete order object as "data" payload.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "orders.allocated", "event_triggered_at":"2013-07-17 16:02:14", "data": { "idorder": 6576, "idcustomer": 5633, "orderid": "20130012", "deliveryname": "Triangle B.V.", "deliverycontactname": "Jos Triepels", "deliveryaddress": "Koppeling 15", "deliveryaddress2": null, "deliveryzipcode": "6983 HX", "deliverycity": "Doesburg", "deliveryregion": null, "deliverycountry": "NL", "invoicename": "Triangle B.V.", "invoicecontactname": "Crediteurenadministratie", "invoiceaddress": "Koppeling 15", "invoiceaddress2": null, "invoicezipcode": "6983 HX", "invoicecity": "Doesburg", "invoiceregion": null, "invoicecountry": "NL", "reference": "", "partialdelivery": true, "discount": 15.60, "status": "concept", "public_status_page": "https://example.picqer.com/s/eB1KLYRIN41p5xt2", "created": "2013-07-17 16:01:42", "updated": "2013-07-17 16:02:14", "products": [ { "idproduct": 633, "idvatgroup": 18, "productcode": "6531-RB-7-9", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 64.46, "amount": 1, "weight": 9828 }, { "idproduct": 653, "idvatgroup": 18, "productcode": "6531-RE", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 164.46, "amount": 1, "weight": 1821 } ], "tags": { "TopWebshop": { "idtag": 1075, "title": "TopWebshop", "color": "#5993be", "inherit": true, "textColor": "#000000" }, "SummerProducts": { "idtag": 1156, "title": "SummerProducts", "color": "#c7b4f6", "inherit": true, "textColor": "#000000" } }, "orderfields": [ { "idorderfield": 35, "title": "Klantreferentie", "value": "1029371980276" } ] } }
HTTP/1.1 200 OK

orders.notes.created

When a note is created, you get the order object and the order note as payload.

This is only triggered on notes/comments, not on other types of order logs.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "orders.notes.created", "event_triggered_at":"2017-10-12 12:00:43", "data": { "order": { "idorder": 6576, "idcustomer": 5633, "orderid": "20130012", "deliveryname": "Triangle B.V.", "deliverycontactname": "Jos Triepels", "deliveryaddress": "Koppeling 15", "deliveryaddress2": null, "deliveryzipcode": "6983 HX", "deliverycity": "Doesburg", "deliveryregion": null, "deliverycountry": "NL", "invoicename": "Triangle B.V.", "invoicecontactname": "Crediteurenadministratie", "invoiceaddress": "Koppeling 15", "invoiceaddress2": null, "invoicezipcode": "6983 HX", "invoicecity": "Doesburg", "invoiceregion": null, "invoicecountry": "NL", "reference": "", "partialdelivery": true, "discount": 15.60, "status": "concept", "public_status_page": "https://example.picqer.com/s/eB1KLYRIN41p5xt2", "created": "2013-07-17 16:01:42", "updated": "2013-07-17 16:02:14", "products": [ { "idproduct": 633, "idvatgroup": 18, "productcode": "6531-RB-7-9", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 64.46, "amount": 1, "weight": 9828 }, { "idproduct": 653, "idvatgroup": 18, "productcode": "6531-RE", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 164.46, "amount": 1, "weight": 1821 } ] }, "note": { "idorder_log":31, "iduser":424, "idorder":349470, "idpicklist":null, "type":"comment", "action":null, "description":"This customer needs special attention", "details":null, "created_at":"2017-10-12 12:00:43" } } }
HTTP/1.1 200 OK

picklists.created, picklists.closed, picklists.snoozed and picklists.unsnoozed

These webhooks will give you a complete picklist object as "data" payload.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "picklists.created", "event_triggered_at":"2014-08-19 12:13:38", "data": { "idpicklist":76859, "picklistid":"20140095", "idcustomer":5621, "idorder":119087, "idwarehouse":18, "deliveryname":"Desmonds Formal Wear", "deliverycontact":"", "deliveryaddress":"Emmerikseweg 57", "deliveryaddress2":"", "deliveryzipcode":"7077 AP", "deliverycity":"Netterden", "deliveryregion":null, "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, "amount_picked":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, "amount_picked":0, "price":0, "weight":0, "stocklocation":null } ] } }
HTTP/1.1 200 OK

picklists.shipments.created

This webhook will give you a special "picklist shipment" object as "data" payload.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "picklists.shipments.created", "event_triggered_at":"2016-05-20 12:32:22", "data": { "idshipment": 8467299, "idpicklist": 7839816, "idorder": 6929712, "idshippingprovider": 2, "idcompany_shippingprovider": 928, "labelurl": "https://examples.com/labels/label_982878.pdf", "provider": "PostNL", "providername": "PostNL", "public_providername": "PostNL", "trackingcode": "3SPICQ019283726", "trackingurl": "https://example.com/postnl/tracking/3SPICQ019283726", "tracktraceurl": "https://example.com/postnl/tracking/3SPICQ019283726", "created": "2016-05-20 12:32:22", "updated": "2016-05-20 12:32:22" } }
HTTP/1.1 200 OK

products.stock_changed

The products.stock_changed gives a "data" payload with a product object in the "product" key, and the stock change details in the "product_stock_history" key.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "products.stock_changed", "event_triggered_at":"2018-05-07 10:17:48", "data": { "product": { "idproduct": 633, "idvatgroup": 18, "idsupplier":null, "productcode": "6531-RB-7-9", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "price": 54.46, "fixedstockprice": 0, "productcode_supplier": "", "deliverytime": null, "description": "", "barcode": "857825001442", "type": "normal", "unlimitedstock": false, "weight": 200, "minimum_purchase_quantity": 0, "purchase_in_quantities_of": 0, "hs_code": null, "country_of_origin": null, "active": true, "productfields": [ { "idproductfield": 11, "title": "Eenheid", "value": "liter" } ], "images": [ "https:\/\/link-to-image.com/image2867\/original", "https:\/\/link-to-image.com/image2867\/original", "https:\/\/link-to-image.com/image2867\/original", "https:\/\/link-to-image.com/image2867\/original" ], "stock": [ { "idwarehouse": 18, "stock": 112, "reserved": 0, "reservedbackorders": 0, "reservedpicklists": 0, "reservedallocations": 0, "freestock": 112, "freepickablestock": 112 } ] }, "product_stock_history": { "idproduct_stock_history": 8, "idproduct": 633, "idwarehouse": 18, "iduser": 2, "old_stock": 115, "stock_change": -3, "new_stock": 112, "reason": "No reason given", "change_type": "manual", "changed_at": "2018-05-07 10:17:48" } } }
HTTP/1.1 200 OK

products.*

All other products.* webhooks will give you a complete product object as "data" payload.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "products.free_stock_changed", "event_triggered_at":"2018-05-07 10:17:48", "data": { "idproduct": 633, "idvatgroup": 18, "idsupplier":null, "productcode": "6531-RB-7-9", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "price": 54.46, "fixedstockprice": 0, "productcode_supplier": "", "deliverytime": null, "description": "", "barcode": "857825001442", "type": "normal", "unlimitedstock": false, "weight": 200, "minimum_purchase_quantity": 0, "purchase_in_quantities_of": 0, "hs_code": null, "country_of_origin": null, "active": true, "productfields": [ { "idproductfield": 11, "title": "Eenheid", "value": "liter" } ], "images": [ "https:\/\/link-to-image.com/image2867\/original", "https:\/\/link-to-image.com/image2867\/original", "https:\/\/link-to-image.com/image2867\/original", "https:\/\/link-to-image.com/image2867\/original" ], "stock": [ { "idwarehouse": 18, "stock": 112, "reserved": 0, "reservedbackorders": 0, "reservedpicklists": 0, "reservedallocations": 0, "freestock": 112, "freepickablestock": 112 } ], "tags": { "SummerProducts": { "idtag": 1156, "title": "SummerProducts", "color": "#c7b4f6", "inherit": true, "textColor": "#000000" } } } }
HTTP/1.1 200 OK

purchase_orders.receipts.created

This webhook will give a purchase order receipt object as "data" payload.

POST http(s)://example.com/your-endpoint
{ "idhook": 228, "name": "Your name for this hook", "event": "purchase_orders.receipts.created", "event_triggered_at":"2016-07-25 13:21:28", "data": { "idpurchaseorder_receipt": 2934, "idpurchaseorder": 18393, "iduser": 424, "purchaseorder_receiptid": "PO2016-1005-2", "remarks": null, "received_at": "2016-07-25 13:21:28", "products": [ { "idpurchaseorder_product": 18287, "idproduct": 1105248, "amount": 2 } ] } }
HTTP/1.1 200 OK
Want to know more about Picqer?
We are ready to give you a personal demonstration
Book a demonstration