MyCarrier · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the MyCarrier Order Public API

4 actions 4 updates update extends ../openapi/mycarrier-order-public-api-openapi.json
Derived by API Evangelist Built from the contracts MyCarrier publishes. MyCarrier did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

contactx-documentationx-idempotency429

Targets 4

$.info
$.servers
$.paths./api/Orders.post
$.paths.*.*.responses

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the MyCarrier Order Public API
  version: 1.0.0
extends: ../openapi/mycarrier-order-public-api-openapi.json
x-generated: '2026-08-26'
x-method: derived
x-source: 'openapi/mycarrier-order-public-api-openapi.json,
  https://developer.mycarrier.io/docs/api-environments,
  https://developer.mycarrier.io/docs/api-rate-limits'
x-note: 'The Order contract is the healthiest MyCarrier ships — it already declares
  BasicAuth and applies it globally. These actions add the documented sandbox server,
  the undeclared 429, and the idempotent-by-reference-ID semantics that are only stated
  in prose.'
actions:
- target: $.info
  description: Add contact and documentation links.
  update:
    contact:
      name: MyCarrier API Support
      email: support@mycarrier.io
      url: https://developer.mycarrier.io/
    x-documentation: https://developer.mycarrier.io/docs/order-management
- target: $.servers
  description: Record the documented sandbox host alongside production.
  update:
  - url: https://order-public-api.api.mycarriertms.com
    description: Production
  - url: https://order-public-api.preprod.mycarrier.dev
    description: Sandbox
- target: $.paths./api/Orders.post
  description: Record that order upload is an upsert keyed on the caller-supplied
    reference ID, and is therefore idempotent by natural key.
  update:
    x-idempotency:
      mechanism: natural-key
      key: referenceId
      note: 'Re-sending the same payload with the same reference ID updates the existing
        order rather than creating a duplicate. No Idempotency-Key header exists.'
- target: $.paths.*.*.responses
  description: Declare the documented but undeclared 429 response.
  update:
    '429':
      description: 'Too Many Requests. Rate limits are enforced per account and per
        endpoint. Retry with a progressively increasing delay.'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/mycarrier-order-public-api-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.