Introducing API Version 2

by Adam Gibbons | Feb 5, 2019 | Engineering

Veho API Version 2 is live.

Today, we’re excited to release Veho API Version 2 (V2).

In this version, we’ve introduced an Orders object. An Order instructs Veho to pick up a Package from you and deliver it to a customer. When you create an Order, Veho immediately generates labels and ratings, then computes logistics around pickup, sorting, and delivery of the Package(s) associated with your Order.

An Order has a one-to-many relationship with the Package object, meaning each Order can have many packages (and unique labels) associated with it. An Order contains other top-level information, including service class, rate, destination, and customer. The Package object holds a foreign key to an Order and has item-specific information, e.g. weight and dimensions, declared value, barcode, and shipping labels.

Now, instead of creating a Package, you’ll create an Order. If your Order has just one package, the only new piece of information you need to specify is packageCount: 1. If, on the other hand, you want to create several Packages, you can either just increase packageCount, or you can provide specific information for any or all Packages in your Order. Once you’ve created an Order, querying it will also return a list of its Packages. Alternatively, you can query a specific package.

This helps with situations where an Order may have one part that is ready for shipping today, and another that won’t be ready until tomorrow. Because the Package is separate, we can scan it at pickup and delivery separately from its sibling packages, without needing you to create an extra Order or use some other workaround. Or course, you can still just create a single Order for each Package if that’s easiest for you.

We encourage all of our clients to begin using V2 as soon as you’re able to do so. V2 is backwards-compatible, meaning that Packages you created using Veho API Version 1 (V1) are a) accessible using V2 endpoints, and b) have a foreign key pointing toward a corresponding Order that we created for you. We will continue to maintain V1, but we’ll no longer be actively developing new features or functionality.

Please give us your feedback!

We developed V2 based on developer feedback and the growing needs of our clients. We’ll continue to improve this new version and introduce new features and functionality, so take it for a spin and let us know what you think!

Let's Get in Touch