Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Labels Label Download API

5 actions 5 updates phrasing extends openapi/sendcloud-label-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 5

$.info

$.paths['/labels/normal_printer/{parcel_id}'].get

$.paths['/labels/normal_printer'].get

$.paths['/labels/label_printer/{parcel_id}'].get

$.paths['/labels/label_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 Label Download API
  version: 1.0.0
extends: openapi/sendcloud-label-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: 4
- target: $.paths['/labels/normal_printer/{parcel_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a parcel's label for a normal printer
      effect: read
      questions:
      - How do I print one parcel's shipping label on a regular A4 printer?
      - Can I choose where on the A4 sheet a single label is printed?
      instructions:
      - text: Download the A4 PDF label for parcel {parcel_id} starting at position {start_from}.
        slots:
          parcel_id: path.parcel_id
          start_from: query.start_from
      - text: Get the normal-printer label of parcel {parcel_id}, position {start_from}.
        slots:
          parcel_id: path.parcel_id
          start_from: query.start_from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/normal_printer'].get
  update:
    x-apievangelist-phrasing:
      intent: Download labels for many parcels for a normal printer
      effect: read
      questions:
      - Can I get labels for several parcels in one PDF for an office printer?
      - What does the start position mean when bulk printing labels on A4?
      instructions:
      - text: Download A4 labels for parcels {ids} starting at position {start_from}.
        slots:
          ids: query.ids
          start_from: query.start_from
      - text: Combine normal-printer labels for parcels {ids} into one PDF, position {start_from}.
        slots:
          ids: query.ids
          start_from: query.start_from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/label_printer/{parcel_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a parcel's label for a label printer
      effect: read
      questions:
      - How do I get one parcel's label formatted for a thermal label printer?
      - Is there a label-printer PDF for a single parcel?
      instructions:
      - text: Download the label-printer PDF for parcel {parcel_id}.
        slots:
          parcel_id: path.parcel_id
      - text: Get the thermal printer label of parcel {parcel_id}.
        slots:
          parcel_id: path.parcel_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/label_printer'].get
  update:
    x-apievangelist-phrasing:
      intent: Download labels for many parcels for a label printer
      effect: read
      questions:
      - Can I bulk download labels for several parcels sized for a label printer?
      - What's the way to print a batch of labels on my thermal printer?
      instructions:
      - text: Download label-printer labels for parcels {ids}.
        slots:
          ids: query.ids
      - text: Get one thermal-printer PDF with the labels of parcels {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-10-01'