Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Orders API

6 actions 6 updates phrasing extends openapi/sendcloud-orders-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 6

$.info

$.paths['/orders'].get

$.paths['/orders'].post

$.paths['/orders/{id}'].get

$.paths['/orders/{id}'].delete

$.paths['/orders/{id}'].patch

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 Orders API
  version: 1.0.0
extends: openapi/sendcloud-orders-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: 5
- target: $.paths['/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders
      effect: read
      questions:
      - Which orders came in from a specific shop integration this week?
      - Can I filter orders by status and creation date?
      - How do I look up orders by order number?
      instructions:
      - text: List orders from integration {integration}.
        slots:
          integration: query.integration
      - text: Find orders with status {status} created after {order_created_at_min}.
        slots:
          status: query.status
          order_created_at_min: query.order_created_at_min
      - text: Find the order with number {order_number}.
        slots:
          order_number: query.order_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update orders in batch
      effect: write
      questions:
      - How do I import orders from my own system into a Sendcloud API integration?
      - Can I insert many orders at once and update existing ones?
      instructions:
      - text: Insert a batch of orders into my API integration.
      - text: Upsert these orders into Sendcloud.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order
      effect: read
      questions:
      - What are all the details of one particular order?
      - What shipping address is stored on a particular order?
      instructions:
      - text: Show order {id}.
        slots:
          id: path.id
      - text: Get the full details of order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order
      effect: destructive
      questions:
      - Can I remove an order that was cancelled in my shop?
      - Is deleting an order from Sendcloud permanent?
      instructions:
      - text: Delete order {id}.
        slots:
          id: path.id
      - text: Remove order {id} from Sendcloud.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order
      effect: write
      questions:
      - Can I fix the shipping address on an order after import?
      - Is it possible to change just a few fields of an order?
      instructions:
      - text: Change the shipping address of order {id} to {shipping_address}.
        slots:
          id: path.id
          shipping_address: requestBody.shipping_address
      - text: 'Update the customer details on order {id}: {customer_details}.'
        slots:
          id: path.id
          customer_details: requestBody.customer_details
      method: generated
      generated: '2026-10-01'