Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ship an Order API

3 actions 3 updates phrasing extends openapi/sendcloud-ship-an-order-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['/orders/create-labels-async'].post
$.paths['/orders/create-label-sync'].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 Ship an Order API
  version: 1.0.0
extends: openapi/sendcloud-ship-an-order-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['/orders/create-labels-async'].post
  update:
    x-apievangelist-phrasing:
      intent: Create labels for orders asynchronously
      effect: write
      questions:
      - Can I create shipping labels for many orders in one go?
      - What happens if some orders in a bulk label request fail?
      instructions:
      - text: Create labels for orders {orders} from integration {integration_id}.
        slots:
          orders: requestBody.orders
          integration_id: requestBody.integration_id
      - text: Queue labels for orders {orders} in integration {integration_id} shipping with {ship_with}.
        slots:
          orders: requestBody.orders
          integration_id: requestBody.integration_id
          ship_with: requestBody.ship_with
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/create-label-sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a label for one order and wait
      effect: write
      questions:
      - Can I get the label for a single order back in the same response?
      - How do I ship one order and receive its documents immediately?
      instructions:
      - text: Create a label now for order {order} in integration {integration_id}.
        slots:
          order: requestBody.order
          integration_id: requestBody.integration_id
      - text: Ship order {order} from integration {integration_id} using sender address {sender_address_id}.
        slots:
          order: requestBody.order
          integration_id: requestBody.integration_id
          sender_address_id: requestBody.sender_address_id
      method: generated
      generated: '2026-10-01'