Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reporting API

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

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 Reporting API
  version: 1.0.0
extends: openapi/sendcloud-reporting-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['/reporting/parcels'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a parcels CSV report
      effect: write
      questions:
      - How do I export my outgoing parcels to a CSV file?
      - Which fields and filters can I use in a parcels report?
      instructions:
      - text: Create a parcels report with fields {fields} and filters {filters}.
        slots:
          fields: requestBody.fields
          filters: requestBody.filters
      - text: Generate a CSV of parcels matching {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reporting/parcels/{report_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a parcels report
      effect: read
      questions:
      - Is my parcels report ready to download yet?
      - Where do I get the download link for a report I requested?
      instructions:
      - text: Get the download URL for report {report_id}.
        slots:
          report_id: path.report_id
      - text: Check the status of parcels report {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-10-01'