Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(API-1552): Add order_id and shipment_reference_identifier to ShipmentStatusChangeEvent #124

Merged
merged 1 commit into from
Dec 23, 2024
Merged

feat(API-1552): Add order_id and shipment_reference_identifier to ShipmentStatusChangeEvent #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/api-reference/11.webhook-object-definitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ApiLink to="13_A">Order</ApiLink>.

### 11.B.2 Reference

We send the following headers to your environment:
Expand All @@ -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"
}
```

Expand All @@ -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"
}
]
}
Expand Down
Loading