Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Labels API

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

$.paths['/labels'].post

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 API
  version: 1.0.0
extends: openapi/sendcloud-labels-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['/labels/{parcel_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get label download links for a parcel
      effect: read
      questions:
      - Where do I get the label download URLs for a parcel I created?
      - Does a parcel's label come in both normal and label printer formats?
      instructions:
      - text: Get the label URLs for parcel {parcel_id}.
        slots:
          parcel_id: path.parcel_id
      - text: Fetch printable label links for parcel {parcel_id}.
        slots:
          parcel_id: path.parcel_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Request labels for multiple parcels
      effect: write
      questions:
      - How do I request shipping labels for a batch of parcels at once?
      - Can I get bulk label download URLs for an array of parcels?
      instructions:
      - text: Request labels for parcels {label}.
        slots:
          label: requestBody.label
      - text: Bulk print labels for the parcels in {label}.
        slots:
          label: requestBody.label
      method: generated
      generated: '2026-10-01'