Enhancements
Enhanced Pickup Create API: Streamlined Validation and Service Alignment
4 November 2024
release-featured-image

Overview:

An enhancement has been introduced to the Pickup Create API, enabling the acceptance of two additional parameters: service type and reference number list. This improvement ensures precise and validated pickup request inputs, enhancing operations' consistency and accuracy. The functionality also includes mandatory validation for these parameters and introduces new conditions to streamline pickup request creation.

Key Capabilities:

  • Service Type Parameter: The field is now mandatory when sending pickup requests to carriers. This setting must be enabled in the operations dashboard under customer configuration -> pickup configuration, and the parameter must be explicitly provided in every API request to ensure service alignment.

  • Reference Number Validation: This field is also mandatory when sending pickup requests to carriers. It validates that all provided consignment numbers (CNs) belong to the specified service type. The setting must be enabled in the operations dashboard under customer configuration -> pickup configuration.

  • Enabling Pickup Requests to Carriers: The system requires that the "Send Pickup Request to Carriers" option be set to "ON" for pickup requests to be processed successfully.

Benefits:

  • Enhanced Data Validation: Mandating service type and ensuring CNs belong to the same service type in the reference number list eliminate discrepancies and improve the accuracy of pickup requests.

  • Optimized Carrier Communication: The "Send Pickup Request to Carriers" condition ensures that requests are only processed when carrier communication is enabled, avoiding unnecessary operations.

  • Consistent Service Management: The addition of service type improves service categorization, making it easier to track and manage pickups based on service levels.

  • Reduced Errors in Processing: Validating the reference number list against the specified service type reduces rejections due to mismatches, saving time and effort.

  • Seamless API Integration: The enhanced API structure supports easier integration with client systems while maintaining strict adherence to operational rules.