API docs

Webhooks

How to receive order status change notifications, and how to verify their signature.

You can set callback URLs in your application settings under Settings > API > Webhooks.

Status update URL

Triggered whenever an order changes its status.

  • Method: POST
  • Content: application/json
  • Signature: the SHA-256 encoded value of secretKey + order_id — the same scheme used for the Order payment secret. See Authentication.

Payload

{
  "signature": "4bf65a3ffc022f0070babee6540048dfc1a3faad270f62f8084fe66f94ebf8fd",
  "order_id": "1234",
  "order_reference": "LL1123",
  "old_status": "IN_PRODUCTION",
  "new_status": "SHIPPED",
  "tracking_code": "XXXXXXX1234",
  "tracking_url": "https://nolp.dhl.de/nextt-online-public/en/search?piececode=XXXXXXX1234"
}

old_status and new_status are order statuses. tracking_code and tracking_url are only present once the order has shipped.

Postman collection

You can access our Postman collection here: Download Postman Collection.