Changelog

API version history and release notes

This document tracks all notable changes to the PartsSource APIs.

---

Versioning Policy

• Current Version: 1.0

• Version Header: X-Api-Version: 1.0

Deprecation Policy

Timeline	Action
6 months	Advance notice before deprecating endpoints
12 months	Support period after deprecation announcement
-	Deprecation notices via email and documentation

---

Version 1.0

Release Date: October 2025

Initial Release

The initial release of the PartsSource InternalApi and CustomerApi includes:

Authentication

• JWT Bearer token authentication via AWS Cognito

• OAuth 2.0 Client Credentials flow for M2M integration

• 1-hour token expiration

Customer Management

• Customer lookup by ID or username

• Customer search with filters and pagination

• Company information retrieval with addresses and contacts

Catalog

• Catalog search with text queries and facet filtering

• Product detail retrieval with pricing options

• Support for multiple conditions (New, Refurbished, Exchange)

Orders

• Order creation with idempotency support

• Order retrieval by ID

• Quote items with custom fields

Core Features

• Offset-based pagination (up to 10,000 records per page)

• Idempotency for order creation (24-hour cache)

• Rate limiting (1,000 RPS standard tier)

• Correlation IDs for request tracking

• RFC 7807 Problem Details error responses

Multi-Tenancy (CustomerApi)

• Automatic tenant isolation based on client credentials

• Company-scoped data access

• No cross-tenant access permitted

Health Monitoring

• Liveness probe (/health/live)

• Readiness probe (/health/ready) with DB2 connectivity check

Documentation

• OpenAPI 3.0.1 specifications

• Interactive API documentation

---

Upcoming Changes

The following features are planned for future releases. Dates are tentative and subject to change.

Planned Features

Feature	Target	Status
Webhook notifications	TBD	Planning
Order status updates	TBD	Planning
Batch operations	TBD	Evaluation

---

Migration Guides

No migrations are currently required. This section will be updated when breaking changes are introduced in future versions.

---

Support

For questions about API changes:

• Email: [email protected]

• Include: Correlation ID, environment, and affected endpoints