Skip to content

Add PostNL V4 migration planning docs#313

Open
sal4sup wants to merge 4 commits into
mainfrom
docs/postnl-v4-migration-plan
Open

Add PostNL V4 migration planning docs#313
sal4sup wants to merge 4 commits into
mainfrom
docs/postnl-v4-migration-plan

Conversation

@sal4sup
Copy link
Copy Markdown
Collaborator

@sal4sup sal4sup commented May 12, 2026

Summary

This is a documentation-only draft PR for reviewing the PostNL V4 SDK/API migration plan.

It includes:

  • PostNL V4 SDK/API developer reference
  • Proposed implementation plan and task breakdown
  • SDK vs old-client routing decisions
  • Ready vs blocked flows
  • Required PostNL/Joris inputs
  • Unit, integration, staging, and manual QA checklist
  • Source references used during the analysis

Notes

No production code changes are included in this PR.

The proposed implementation approach is hybrid:

  • use the SDK for V4 flows that are clearly supported
  • keep existing old clients for flows that are not covered yet or still need confirmation

The main remaining blocker for label migration is the product/options to V4 shipmentType / services mapping.

Smart Returns and activatereturn are documented as blocked until PostNL confirms the correct V4 behavior.

Files added

  • docs/postnl-v4-migration/postnl-v4-sdk-api-reference.md
  • docs/postnl-v4-migration/postnl-v4-migration-implementation-plan.md
  • docs/postnl-v4-migration/sources/PostNL-Future-Proof-V4-API.postman_collection.json
  • docs/postnl-v4-migration/sources/sdk-docs/

Review focus

Please review:

  • whether the proposed task split is suitable for small PRs
  • whether the hybrid approach makes sense
  • whether the listed blockers and required inputs are complete
  • whether the testing and QA coverage is enough before implementation starts

@sal4sup sal4sup requested a review from dustinparker May 12, 2026 21:03
sal4sup and others added 3 commits May 13, 2026 00:35
…e PostNL V4 migration.

- Introduce phased implementation plan, technical rationale, and routing model for SDK-backed services.
- Outline per-flow service interface pattern (Legacy and V4 implementations).
- Document folder structure, class hierarchy, request sequence via diagrams.
- Include open questions for PostNL, product mapping details, and test strategy.
- Highlight backward compatibility and staged rollout/rollback options to ensure risk-managed deployment.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants