ERP Template - Sample Interface Design Doc (IDD) & Test Script

Interface Design Document — BC–UPS Courier Integration  DOCX

ERP_Sherpas_IDD_BC_UPS_Interface.docx

A comprehensive Interface Design Document (IDD) covering an example scenario for the point-to-point REST API integration between Microsoft Dynamics 365 Business Central and the UPS Shipping API, enabling warehouse operatives to retrieve a UPS shipping label and tracking number directly from the BC Warehouse Shipment record without leaving the system. The document covers business context, architecture, OAuth 2.0 authentication design, the full process flow including error handling, functional requirements (12 requirements), full data mapping for shipper, ship-to, and package fields, technical design including all AL extension objects required, security model, and eleven test scenarios.

For a PM, an IDD at this level of completeness removes the most common source of integration project failure: ambiguity between the business's expectation and the developer's interpretation of what the interface should do.

SIT Test Script — BC–UPS Courier Integration  DOCX

ERP_Sherpas_SIT_Test_Script_BC_UPS_Integration.docx

A landscape-format SIT test script covering 56 steps across 10 test phases for the Business Central–UPS Shipping API integration, directly derived from the Interface Design Document. Phases cover environment and setup verification, domestic and international happy-path scenarios, mandatory field validation, OAuth authentication failure, UPS API 400 and timeout error handling, printer failure and reprint functionality, interface log completeness, and BC permission set controls. Each step includes scenario reference, detailed navigation and test data instructions, and expected result.

For a PM, this document bridges the gap between a design specification and executable test evidence — ensuring the integration is tested systematically against every scenario the IDD defines, rather than informally by a developer doing a quick smoke test before declaring it ready for UAT.