Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics User Carriers and Shipping Methods API

3 actions 3 updates phrasing extends openapi/sendcloud-user-carriers-and-shipping-methods-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sendcloud's API. It is a proposal applied on top of the contract, not a document Sendcloud publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/analytics/shipping-methods'].get

$.paths['/analytics/carriers'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Analytics User Carriers and Shipping Methods API
  version: 1.0.0
extends: openapi/sendcloud-user-carriers-and-shipping-methods-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/analytics/shipping-methods'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping methods I have used
      effect: read
      questions:
      - Which shipping methods have I ever used?
      - What delivery methods appear in my shipping history?
      instructions:
      - text: List every shipping method I have used.
      - text: Show the shipping methods in my history.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/carriers'].get
  update:
    x-apievangelist-phrasing:
      intent: List carriers I have used
      effect: read
      questions:
      - Which carriers have I shipped with?
      - What carriers appear in my shipping history?
      instructions:
      - text: List every carrier I have used.
      - text: Show the carriers I have shipped with.
      method: generated
      generated: '2026-10-01'