Common Errors
Carriyo performs basic validation when a shipment booking is requested, which may result in data validation errors. Below are some of the most common validation issues and how to address them:
1. References
- Partner Order Reference : The mandatory order reference is typically the customer-facing order number.
- Partner Shipment Reference : This is the unique shipment reference provided by the merchant for each shipment. Carriyo rejects shipments with duplicate shipment references, so ensure each reference is unique.
2. Payment Information
You are required to provide the total monetary value for the shipment. Additionally, under the payment section, it is crucial to specify the payment mode, particularly if the payment is Cash on Delivery (COD).
3. Pickup & Dropoff Details
The pickup and dropoff addresses must include the following fields:
- Contact Name : First and last name.
- Contact Phone : You can configure your account to make the phone number optional. However, if provided, it must be a valid phone number in E.164 format .
- Contact Email : You can configure your account to make the email address optional. However, if provided, it must be a valid email as per the RFC 5322 standard .
- Address Lines : At least Address Line 1 (street address) is required, with Address Line 2 being optional.
- City : The city or town of the address. This is a free-text field, but for certain countries, Carriyo maintains a geo-list of cities and areas. It is recommended to use Carriyo’s list for these countries to meet carrier requirements.
- State (optional) : The state can be derived from the city and is not always required. It represents the first level of the geographic or political hierarchy within a country.
- Country : The country must be identified using the 2-letter ISO country code (e.g., "US" for the United States).
4. Item / SKU Details
Although item or SKU-level details are not mandatory for domestic shipments, they are required for cross-border shipments. Carriyo enforces the submission of at least one item or SKU for each shipment booking. The following fields are mandatory when providing item details:
- SKU : The SKU ID of the item.
- Item Price : The final sale price of the item after applying all discounts.
- Item Quantity : The number of units of the SKU included in the shipment.
5. Parcel Details
Although Carriyo does not require parcel details for shipment bookings, most carriers do require parcel information. It's important to include the following fields for each parcel:
- Parcel Weight : The weight of the parcel in kilograms.
- Parcel Dimensions : The height, width, and depth of the parcel in centimeters.
By ensuring that these fields are correctly populated, you can avoid common validation errors and ensure smooth shipment processing with Carriyo.