Introducing Shipment API & Documentation Enhancements
· 2 min read
We are excited to announce a major update to the Shipping Channels API, introducing a brand new Shipment Model and significant enhancements across our documentation!
New Shipment Model
Our new Shipment Model provides comprehensive functionality for managing your shipping operations directly through the API. You can now:
- Create Shipments: Define detailed shipment information, including sender/recipient contacts, origin/destination addresses, and parcel specifics.
- Manage Shipments: Retrieve, update (limited fields), and delete shipments.
- Generate Labels: Programmatically generate shipping labels for your created shipments.
- Download Labels: Access and download generated shipping labels.
- Query Shipping Channels & Statuses: Easily retrieve available shipping channels and all possible shipment statuses.
This new model streamlines the process of preparing and managing your parcels for shipping, offering greater automation and control.
Documentation Enhancements
To support the new Shipment Model and improve overall clarity, we have made extensive updates to our API documentation:
- Comprehensive Shipment API Reference: Detailed documentation for all new Shipment endpoints, including request/response structures and examples.
- Updated Existing API References: Reviewed and corrected existing API documentation for Shipping Channels, Tracking Parcels, and Webhook Subscriptions to ensure accuracy and consistency with the current API implementation.
- New Guides:
- Shipments Guide: A step-by-step guide on how to use the new Shipment API.
- Error Handling Guide: A comprehensive guide to understanding and responding to API errors.
- Tracking Parcel Status Updates Guide: Explains the automatic tracking process and how to configure check frequencies.
- New FAQ Page: A dedicated section answering frequently asked questions about the API.
These updates aim to provide a more accurate, comprehensive, and user-friendly experience for all developers integrating with the Shipping Channels API.
Stay tuned for more exciting updates!