What endpoints should I integrate for a simple Shipment integration with Carriyo?
Typically, you will only need to integrate two touch points with Carriyo - The POST /shipments endpoint to Create Shipments in Carriyo, along with the webhook to receive key status updates such as shipped, delivered and returned.
What are draft shipments and when should I use them?
Draft shipments allow you to create shipments in advance, and confirm them once the they are packed. You only need to create draft shipments if you wish to view unconfirmed shipments in Carriyo.
What are prebooked shipments and when should I use them?
Prebooked shipments are booked outside Carriyo. Carriyo skips the booking process when you create prebooked shipments. You will use prebooked shipments if you are only using Carriyo for tracking shipments and for CX features such as customer notifications, or tracking / feedback pages.
How can I automate the label printing process with Carriyo?
To automate the label printing process, you will setup your carrier accounts in Carriyo for the carriers you plan to use and setup the automation rules to assign shipments to the correct carrier accounts as per your requirements. Once this is setup, you can setup a webook in Carriyo to automatically notify you when a label is generated. You will typically use the "Default Label Generated" even as the webhook trigger to be notified upon label generation.
What are the most common validation errors when booking shipments?
The most common validation errors when booking shipments occur due to invalid data. You may also encounter an error when no carrier account is assigned to a shipment, which usually occurs if no matching automation rule can be applied for a given shipment.