From b97e95a75c542b35888dd4f97d74f3a7dd2de1b3 Mon Sep 17 00:00:00 2001 From: Nick Kraakman Date: Tue, 26 Nov 2024 14:18:12 +0100 Subject: [PATCH] feat(API-1552): Add `order_id` and `shipment_reference_identifier` to `ShipmentStatusChangeEvent` --- .../11.webhook-object-definitions.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/api-reference/11.webhook-object-definitions.md b/src/api-reference/11.webhook-object-definitions.md index 333c56f9..16088085 100644 --- a/src/api-reference/11.webhook-object-definitions.md +++ b/src/api-reference/11.webhook-object-definitions.md @@ -100,6 +100,14 @@ The shipment status. Data type: [string] This is the shipment barcode. +**shipment_reference_identifier** +Data type: [string] +This is the shipment reference identifier, which can contain the webshop order reference. + +**order_id** +Data type: [string] +This is the MyParcel order UUID to which the shipment belongs. Only present if the shipment is part of an Order. + ### 11.B.2 Reference We send the following headers to your environment: @@ -119,7 +127,9 @@ We send the following headers to your environment: "account_id": 7003, "shop_id": 1897, "status": 2, - "barcode": "3SMYPA749883621" + "barcode": "3SMYPA749883621", + "shipment_reference_identifier": "Bol.com nr: 4161412988", + "order_id": "db610547-7434-4f6d-9e13-178b686a94d6" } ``` @@ -134,7 +144,9 @@ The above is an example of the ShipmentStatusChangeEvent Object. However, the fo "account_id": 7003, "shop_id": 1897, "status": 2, - "barcode": "3SMYPA749883621" + "barcode": "3SMYPA749883621", + "shipment_reference_identifier": "Bol.com nr: 4161412988", + "order_id": "db610547-7434-4f6d-9e13-178b686a94d6" } ] }