Skip to main content

Order API Authentication Update

How to update your order API keys and endpoints

P
Written by Pamela Crandall
Updated yesterday

Important updates to the MyCarrier Order API may require your action as part of our efforts to improve performance and security.

All API customers must have their order API endpoints and keys moved over to the following format by September 1, 2025:

Update #1: New Order API Endpoint

New Endpoint URL: https://api.mycarriertms.com/api/v1/orders

📌 Note: If you're already using this endpoint, no action is needed.

Update #2: Authentication Method Update

We have switched from Basic Authentication to API Key Authentication and introduced API Key generation directly within the MyCarrier UI for easier access and management.

New Authentication Details:

  • Send the API key in the Header

    • Key: X-MC-Api-Key

API A

  • Value: Use either the newly generated UI key or your existing API Password (formally used in the “Basic Auth” method)

    • Please refer to screenshots below showing how to access new UI-generated keys

API B

API C-1

📌 Note: Existing API keys remain supported—transitioning to UI-generated keys is optional.

Benefits to moving to new API Endpoint:

  • We have made several improvements to our backend architecture that will improve performance, security and stability.

  • Improved documentation for new endpoint(s) - https://developer.mycarrier.io/reference/uploadorder

  • Any future features and functionality will be deployed to this new endpoint

Benefits of switching from Basic Authentication to API Key Authentication

  • Improved Security

    • API Keys avoid the need to share or store actual passwords in systems, reducing risk of exposure.

  • Easier Key Generation and Management

    • Key creation and management can now all be handled within the MyCarrier UI

    • Improved Auditing and Logging

Did this answer your question?