Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Parcel Tracking API

3 actions 3 updates phrasing extends openapi/sendcloud-parcel-tracking-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['/parcels/tracking/{tracking_number}'].get
$.paths['/parcels/tracking'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Parcel Tracking API
  version: 1.0.0
extends: openapi/sendcloud-parcel-tracking-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['/parcels/tracking/{tracking_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Track a parcel by tracking number
      effect: read
      questions:
      - Where is my parcel right now?
      - What are the latest tracking events for a tracking number?
      instructions:
      - text: Track parcel {tracking_number}.
        slots:
          tracking_number: path.tracking_number
      - text: Show the current status of tracking number {tracking_number}.
        slots:
          tracking_number: path.tracking_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/parcels/tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an external parcel for tracking
      effect: write
      questions:
      - Can Sendcloud track a parcel I shipped outside of Sendcloud?
      - What do I need to register an external shipment for tracking?
      instructions:
      - text: Register tracking number {tracking_number} shipped with {ship_with} for tracking.
        slots:
          tracking_number: requestBody.tracking_number
          ship_with: requestBody.ship_with
      - text: Add external parcel {tracking_number} from {from_address} to {to_address} to tracking.
        slots:
          tracking_number: requestBody.tracking_number
          from_address: requestBody.from_address
          to_address: requestBody.to_address
      method: generated
      generated: '2026-10-01'