Northbeam · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Northbeam Orders API v2

3 actions 3 updates update extends openapi/northbeam-orders-v2-openapi.yml

Derived by API Evangelist Built from the contracts Northbeam publishes. Northbeam did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-slugx-apievangelist-tagsx-apievangelist-notex-apievangelist-spec-sourcex-apievangelist-artifactsx-apievangelist-idempotency

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Northbeam Orders API v2
  version: 1.0.0
extends: openapi/northbeam-orders-v2-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: apis.yml + repo artifacts
actions:
- target: $.info
  update:
    x-apievangelist-slug: northbeam
    x-apievangelist-tags:
    - Orders
    - Attribution
    - E-Commerce
    x-apievangelist-note: Current order-ingestion surface. Writes are natural-key upserts on order_id; PATCH is a strict partial update that fails the whole batch on any unknown order_id.
    x-apievangelist-spec-source: https://dash.readme.com/api/v1/api-registry/ (ReadMe registry @northbeam-customer-sucess/v2.2)
- target: $.info
  update:
    x-apievangelist-artifacts:
      authentication: authentication/northbeam-authentication.yml
      conventions: conventions/northbeam-conventions.yml
      errors: errors/northbeam-problem-types.yml
      lifecycle: lifecycle/northbeam-lifecycle.yml
      rate_limits: rate-limits/northbeam-rate-limits.yml
      sandbox: sandbox/northbeam-sandbox.yml
      data_model: data-model/northbeam-data-model.yml
      conformance: conformance/northbeam-conformance.yml
      mcp: mcp/northbeam-mcp.yml
- target: $.info
  update:
    x-apievangelist-idempotency:
      mechanism: natural-key upsert
      key: order_id
      header: null
      note: POST /orders is an upsert on order_id, so replays are safe. PATCH /orders is NOT — it requires every order_id to already exist and fails the entire batch otherwise.

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/northbeam-orders-v2-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.

GitHub Google LinkedIn

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