Navigating MyCarrier's API Documentation

Overview

The goal of MyCarrier's API documentation is to provide our customers with comprehensive and detailed overviews of our API endpoints, both from a business use-case perspective and a technical perspective. To achieve this, we've broken the information down into two distinct sections:

• Guides: This section will contain overviews of what the API endpoints do, how they can fit into your business workflow, and possible use cases. Additionally, the guides will also contain extra instructions for what fields may be required and how to use them
• API Reference: The API reference contains our technical documentation that shows the API payloads, responses, required fields, data types for each object, and enumerated fields.

Click on the section you wish to explore from the navigation bar which appears on the top left of your screen:

Versions

MyCarrier is continually looking to improve our APIs' performance and usability while adding new functionality to meet the needs of our customers. As new updates are released, we may also move to new versions which necessitate changes to our documentation. You can view the different versions by clicking the version dropdown on the top left navigation bar and selecting the API version you wish to view:

Note: Even when our APIs are updated, we will continue to support previous versions and you will still be able to interface with the MyCarrier system. If any changes do require action, our team will provide advanced notice and work with you to ensure a smooth transition to new API versions.