The VoyageOne API is an open application programming interface to the VoyageOne Platform. The VoyageOne API enables vendors to easily integrate with the VoyageOne Platform to create and update product listings, control inventory and fulfill orders.
Note: This website is intended as a developer's guide for developers building application integrations to the VoyageOne API. For information about VoyageOne, please visit https://www.voyageone.com.
Getting started with the VoyageOne API is quick and convenient. Begin with browsing through the API documentation to familiarize yourself with how it is organized and to see what kind of possibilities the VoyageOne API provides. After registering as a developer, start developing against the VoyageOne API.
Browse Through the API Documentation
First, to assist you in your application integration, here is a quick overview and some advice for finding the material you need to get started:
- The sidebar on the left serves as a directory to the many aspects of the VoyageOne API.
- Core API Concepts – provides a basic introduction to standard architectural principles defined by Representational State Transfer (REST) such as how a standard API request is constructed.
- Working with API Resources – describes how to make API requests to the various VoyageOne API web services and how to work with API responses.
- Testing and Validation Process – provides guidance as to what you should expect to successfully complete your integration. Additionally, you can find a detailed list of test cases that will be used for final verification of your application integration with the VoyageOne API.
- Product API Endpoints – provides complete details of all available product API endpoints supported by the VoyageOne API.
- Order API Endpoints – provides complete details of all available product API endpoints supported by the VoyageOne API.
- API Glossary – provides a list of the most common terms and acronyms related to APIs and web services.
Register as a Developer
Second, register yourself as a developer to have us setup a sandbox account. We will provide you with sandbox API credentials for accessing our API testing server. Get your sandbox API credentials by emailing us at email@example.com or contacting your existing VoyageOne business contact. Once you are ready to go live, be sure to switch from your sandbox API credentials to production.
To start developing, refer to Working with API Resources while developing your application integration and to make your first API request.
Following are several tips to help make your application integration perform as expected:
- Use the VoyageOne API filtering and paging parameters when available and appropriate. Only use single record or single result calls when necessary. See Filtering and Pagination for more information.
- Avoid making concurrent API requests if your use case does not benefit from it.
- Use exponential backoff to retry API requests which fail due to concurrency limits or other network errors.
Perform Testing and Validation
Once you have completed initial development, you will need to perform various tests to validate the API requests your application integration will make and to validate the expected responses from the VoyageOne API. Refer to Testing and Validation Process for recommendations on how to perform testing, suggested test cases and how to prepare for the final verification step required to go live.
When you are ready to release your application integration to the production environment, please contact us at firstname.lastname@example.org to obtain production API credentials and to schedule final verification with the VoyageOne integration team.
Important:Your sandbox account will not be linked to your production account in any way. Nothing created in the sandbox environment will transfer to production. Your API credentials will also be different. Once you have received your production API credentials, you will need to update your application integration to use the new credentials. You will also need to change the API's base URL from sandbox to production.
If you still require help after reviewing the API documentation or you need to get in touch for any other reason, you can open a support ticket at email@example.com and someone from our team will assist you. We work to respond to all emails as quickly as we can.
Found a bug or have a feature request?
We welcome your feedback which you can send to firstname.lastname@example.org. If you are reporting a bug or error, please include what happened, what you expected to happen, how we can reproduce the problem and any additional information you can provide.