Getting started with iVoy GraphQL API

On this documentation there will be found all the information needed on how to create guides, how to obtain the labels and the different methods on how to track them

We use a GraphQL API due to its more flexible for our clients as well as it’s more precise with the selected information, allowing multiple requests in a single endpoint.


Requirements:

  1. iVoy API is available in GraphQL. There’s no REST API for iVoy API.

  2. This documentation expose a staging (pre-production) environment you need to request the production.environment and credentials when you finish your tests.

  3. Understand the different types of shipments (On Demand, Same Day and Next Day).

  4. Correctly configure the account depending on the necessary Business Rules.

  5. Use the API Key and send it on each petition done.

  6. Test on each environment staging and production.


Steps to integrate this API:

  1. Understanding the documentation.

  2. Create different tests on the staging environment.

  3. Request for the endpoint and credentials for production environment to the next email: integraciones@ivoy.mx.

  4. Testing on the production environment.


Deliveries types:

iVoy has three delivery ways for all of our clients:

  • On demand – A messenger is sent to collect one or more packages to the client’s store and then to deliver them to the final client. It’s charged depending on the distance traveled by the messenger.

  • Same day – A messenger is sent to collect one or more packages to the client’s Store and then travels to our Warehouse. Then, we create the routes that our messengers are going to follow on the same day. It is charged depending on the commercial contract.

  • Next day – A messenger is sent to collect one or more packages to the client’s Store and then travels to our Warehouse. We create routes and deliver the packages on the next available day. It is charged depending on the commercial contract.


Creation guide flow:

The common flow for guide creation is the following:

  1. Setup your API Keys.

  2. Create your first store.

  3. Create a delivery.

  4. Get the guide label.


Tracking guides:

Once the guide has been created it’s possible to track it through:

  1. Querying status through GraphQL API

  2. Updating status on client’s server through webhooks

  3. Using our tracking url

  4. Using the web admin for clients

  5. Using the Google Search widget

Next steps

Here are some quick links to get you up and running with the GraphQL API.