Webhooks

A webhook is an API request that is triggered from our platform, when a specific action is happening. Multiple webhooks are available and you can setup multiple URL’s for each webhook.

You can setup webhooks for your company using our API or with the following URL: https://mijn.pakketdienstqls.nl/company/:companyId/webhook

shipment.status

Does a [POST] request to the given URL if a shipment status changes. Includes all data for the updated shipment.

Possible statuses:

• created

• printed

• pre_transit

• in_transit

• delivered

• returned

→ Information and payload

shipment.created

Does a [POST] request to the given URL if a new shipment is created. Includes all data for the new shipment.

→ Information and payload

return.status V2

Does a [POST] request to the given URL if a return status changes. Includes all data for the updated return.

Possible statuses:

• created

• approved

• rejected

• partially_rejected

• quarantine

• partially_in_quarantine

• incomplete

• more_than_complete

• completed

Note! Switch to V2 in the top right in Swagger

→ Information and payload

purchase_order.status V2

Does a [POST] request to the given URL if a purchase order status changes. Includes all data for the updated purchase_order.

Possible statuses:

• draft

• created

• in_transit

• too_late

• partially_arrived

• arrived

• processing

• cancelled

• exception

• closed

• archived

Note! Switch to V2 in the top right in Swagger

→ Information and payload

fulfillment_purchase_order.status

Does a [POST] request to the given URL if a fulfilment order status changes. Includes all data for the updated fulfilment order.

Possible statuses:

• announced

• partiallyarrived

• arrived

• complete

• incomplete

• overcomplete

→ Information and payload

fulfillment_product.stock

Does a [POST] request to the given URL if a fulfilment product stock changes. Includes all data for the updated fulfilment product.

→ Information and payload

fulfillment_product.modified

Does a [POST] request to the given URL if a fulfilment product changes. Includes all data for the updated fulfilment product.

→ Information and payload

fulfillment_product.created

Does a [POST] request to the given URL if a fulfilment product is created. Includes all data for the new fulfilment product.

→ Information and payload

fulfillment_order.status

Does a [POST] request to the given URL if a fulfilment order is updated. Includes all data for the fulfilment order.

Possible statuses:

• error_validation

• concept

• received

• pending

• partically_sent

• sent

→ Information and payload

fulfillment_order.created

Does a [POST] request to the given URL if a fulfilment order is created. Includes all data for the new fulfilment order.

→ Information and payload

fulfillment_order.completed

Does a [POST] request to the given URL if a fulfilment order is completed/done. Includes all data for the fulfilment order.

→ Information and payload

fulfillment_order.cancelled

Does a [POST] request to the given URL if a fulfilment order is cancelled. Includes all data for the fulfilment order.

→ Information and payload