Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Transit times API

3 actions 3 updates phrasing extends openapi/sendcloud-transit-times-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['/insights/carriers/transit-times'].get

$.paths['/insights/shipping-methods/transit-times'].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 Transit times API
  version: 1.0.0
extends: openapi/sendcloud-transit-times-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['/insights/carriers/transit-times'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a carrier's average transit time
      effect: read
      questions:
      - How many days on average does a carrier take to deliver?
      - Can I compare a carrier's transit time for a specific destination country?
      instructions:
      - text: Get the average transit time for carrier {carrier_code}.
        slots:
          carrier_code: query.carrier_code
      - text: Show {carrier_code} transit times from {from_country} to {to_country}.
        slots:
          carrier_code: query.carrier_code
          from_country: query.from_country
          to_country: query.to_country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/insights/shipping-methods/transit-times'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping method's average transit time
      effect: read
      questions:
      - How long does a particular shipping method usually take?
      - What is the average delivery time of one shipping method over a date range?
      instructions:
      - text: Get the average transit time for shipping method {shipping_method_code}.
        slots:
          shipping_method_code: query.shipping_method_code
      - text: Show transit times for method {shipping_method_code} between {start_date} and {end_date}.
        slots:
          shipping_method_code: query.shipping_method_code
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'