Skip to main content
All CollectionsMyIntegrationsCustomer BuildsAPI Documentation
MyCarrier API FAQ
MyCarrier API FAQ
Colissa avatar
Written by Colissa
Updated over 2 months ago

Table of Contents

  1. What is the MyCarrier API?

  2. What are the benefits of using the MyCarrier API?

  3. How can I get started with the MyCarrier API?

  4. What is a Sandbox Environment, and why is it important?

  5. How do I authenticate my API requests?

  6. What programming languages and tools are supported?

  7. What types of webhooks are available?

  8. Where can I find more information and detailed documentation?

1. What is the MyCarrier API?

The MyCarrier API is a RESTful API that allows MyCarrier shipping customers to programmatically manage their freight shipments. This includes functionalities like creating and managing orders, receiving real-time shipment updates, and managing invoices.

2. What are the benefits of using the MyCarrier API?

The API offers numerous advantages, including:

  • Streamlined Freight Shipment Management: Automate processes from quote requests to tender submissions.

  • Flexibility and Integration: Integrate MyCarrier functionalities into your existing systems.

  • Real-time Updates: Stay informed about shipment statuses through webhook notifications.

  • Efficiency: Combine the power of the API with the user-friendliness of the MyCarrier UI.

3. How can I get started with the MyCarrier API?

To start using the MyCarrier API:

  1. Sign up for a MyCarrier Account: Contact MyCarrier to set up your account.

  2. Access the Sandbox Environment: Use the provided sandbox environment for safe testing without affecting live data.

  3. Utilize Tools like Postman: Use tools like Postman or cURL for making API calls.

4. What is a Sandbox Environment, and why is it important?

The Sandbox Environment is a testing environment that mirrors the live MyCarrier system but uses test data. It allows developers to experiment with the API, test integrations, and troubleshoot without impacting live operations or data.

5. How do I authenticate my API requests?

Detailed instructions for authentication, including how to obtain and use your API key, are provided in the MyCarrier Developer Guide. This guide covers setting up Postman, importing the collection, and configuring environment variables.

6. What programming languages and tools are supported?

The MyCarrier API follows RESTful principles and uses standard HTTPS methods. You can use any programming language or tool that can make HTTPS requests, such as Python, JavaScript, cURL, or Postman.

7. What types of webhooks are available?

MyCarrier provides various webhooks to keep you informed about key events related to your shipments. These include:

  • Shipment Created

  • Shipment Update

  • Shipment Canceled

  • Shipment Tracking

  • Invoice Auto-Approved

  • Invoice Approved

8. Where can I find more information and detailed documentation?

The MyCarrier Developer Guide is your comprehensive resource for detailed information, API specifications, code examples, and best practices. It provides a step-by-step guide to getting started and effectively using the MyCarrier API.

Did this answer your question?