Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Labels Customs Documents Download API

3 actions 3 updates phrasing extends openapi/sendcloud-customs-documents-download-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['/customs_declaration/normal_printer/{parcel_id}'].get

$.paths['/customs_declaration/normal_printer'].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 Labels Customs Documents Download API
  version: 1.0.0
extends: openapi/sendcloud-customs-documents-download-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['/customs_declaration/normal_printer/{parcel_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a parcel's customs declaration PDF
      effect: read
      questions:
      - How do I get the customs declaration for one parcel as a PDF?
      - Can I print a single parcel's customs paperwork on a normal printer?
      instructions:
      - text: Download the customs declaration PDF for parcel {parcel_id}.
        slots:
          parcel_id: path.parcel_id
      - text: Get printable customs documents for parcel {parcel_id}.
        slots:
          parcel_id: path.parcel_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customs_declaration/normal_printer'].get
  update:
    x-apievangelist-phrasing:
      intent: Download customs declarations for many parcels
      effect: read
      questions:
      - Can I download customs declarations for several parcels in one PDF?
      - Where on the page does a bulk customs document print start from?
      instructions:
      - text: Download customs declarations for parcels {ids} starting at position {start_from}.
        slots:
          ids: query.ids
          start_from: query.start_from
      - text: Get one combined customs PDF for parcels {ids}, start position {start_from}.
        slots:
          ids: query.ids
          start_from: query.start_from
      method: generated
      generated: '2026-10-01'