La Poste Groupe · OpenAPI Overlay 1.0.0

API Evangelist enhancements for La Poste Suivi v2

5 actions 5 updates documentation
Derived by API Evangelist Built from the contracts La Poste Groupe publishes. La Poste Groupe did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdcontacttermsOfServicex-rate-limitx-partial-successx-per-item-status-field

Targets 4

$.info
$.paths['/idships/{idship}'].get
$.paths['/idships/{idship}'].options
$.paths['/idships/{idship}'].get.responses['207']

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for La Poste Suivi v2
  version: 1.0.0
x-generated: '2026-09-02'
x-method: generated
x-source: openapi/la-poste-groupe-suivi-openapi.json
x-note: >-
  Applies to openapi/la-poste-groupe-suivi-openapi.json. Every action below is a
  correction or an addition grounded in something La Poste itself publishes - the
  catalog entry at developer.laposte.fr/catalog-apis/suivi@2, the status page, or a
  live gateway response observed on 2026-09-02. Nothing here invents behaviour, and
  the original document is never modified.
x-extends: openapi/la-poste-groupe-suivi-openapi.json
actions:
- target: $.info
  description: >-
    Add the contact and documentation the portal publishes but the spec omits, and
    correct a license block whose url is an empty string.
  update:
    contact:
      name: La Poste Developer (Okapi)
      url: https://developer.laposte.fr/catalog-apis/suivi@2
    termsOfService: https://developer.laposte.fr/cgu
- target: $.paths['/idships/{idship}'].get
  description: >-
    operationId is "1.0", a version number rather than an identifier. Replace it
    with a stable, descriptive one so generated clients and agent tools get a usable
    method name.
  update:
    operationId: getShipmentTracking
- target: $.paths['/idships/{idship}'].options
  description: operationId is "1.1"; same correction.
  update:
    operationId: preflightShipmentTracking
- target: $.paths['/idships/{idship}'].get
  description: >-
    Record the plan quota the portal publishes for the only Suivi plan, so a client
    can pace itself without reading the portal - 10 calls per second, and the plan
    is private (access on request).
  update:
    x-rate-limit:
      plan: free
      privacy: private
      limit: 10
      window_seconds: 1
      source: https://developer.laposte.fr/catalog-apis/suivi@2
- target: $.paths['/idships/{idship}'].get.responses['207']
  description: >-
    Flag the trap in this contract - a 207 body is an array of per-shipment
    envelopes each carrying its own returnCode, so HTTP status alone does not tell a
    caller whether a given tracking number resolved.
  update:
    x-partial-success: true
    x-per-item-status-field: returnCode

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/la-poste-groupe-suivi-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.