Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. Version 2.1.0

• /api/rates/list and /api/rates/buy-label: Added the enum value usps_hazmat_820 to options.hazmat_code, for shipping USPS Class 9 lithium batteries in an unmarked package. Shipments to or from U.S. offshore destinations (such as Guam, Puerto Rico) generally require this value in order to ship lithium batteries. The existing dhlecs_* values are unchanged. As before, hazmat_code only takes effect when options.require_hazmat is true.

• Added Spanish documentation support, allowing users to view the ShipSaving API documentation in Spanish.

• Added a downloadable Postman collection (ZIP) to the Quick Start Guide, including the API collection and environment files (Sandbox & Production) for quick testing.

• Added support for bilingual documentation (English / Chinese), allowing users to switch languages when viewing the ShipSaving API documentation.

• Moved reference tables into a dedicated Appendix section under the Legacy API (v1) documentation to clearly scope enum definitions to v1.
• Deprecated the top-level Appendix page and retained it as a compatibility entry point, redirecting users to the Legacy API (v1) Appendix without breaking existing links.

• Added UPS Canada–specific service_type and predefined_package enum values to the Appendix section.

• Introduced the request_id parameter to the /api/rates/list and /api/rates/buy-label endpoints, allowing each request to be uniquely identified for tracking and troubleshooting.

• Introduced the hazmat_code parameter to the /api/rates/list and /api/rates/buy-label endpoints, enabling support for different classes of hazardous materials.

• Introduced GOFO EXPRESS as a new carrier, along with its service codes, in Carrier Service Types Table.

• Introduced Canada Post as a new carrier, along with its service codes, in Carrier Service Types Table.
• Introduced the label_type parameter to the /api/rates/list and /api/rates/buy-label endpoints, enabling users to specify the desired label format.

• Introduced the /api/carrier-account/list endpoint, allowing users to fetch all carrier accounts linked to their API credentials.

• Added /api/balance endpoint to retrieve real-time account balance in USD.

• Initial release of updated API documentation highlighting key features including order management, rate retrieval, label purchase/voiding, SCAN form generation, and account/carrier access.
• Added support for carrier-specific rate queries in the /api/rates/list and /api/rates/buy-label endpoints.

• Migrated API base domain to a new host, improving performance, scalability, and security.
• Standardized and optimized error response formats across all endpoints for consistency and better developer experience.