# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Sendcloud Integrations API version: 1.0.0 extends: openapi/sendcloud-integrations-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: 12 - target: $.paths['/integrations'].get update: x-apievangelist-phrasing: intent: List connected shop integrations effect: read questions: - Which webshops are connected to my Sendcloud account? - Can I sort my shop integrations list? instructions: - text: List all my shop integrations. - text: List my shop integrations ordered by {ordering}. slots: ordering: query.ordering method: generated generated: '2026-10-01' - target: $.paths['/integrations/{id}'].get update: x-apievangelist-phrasing: intent: Get one shop integration effect: read questions: - How do I see the settings of a single shop integration? - Is service point delivery switched on for one of my shops? instructions: - text: Show shop integration {id}. slots: id: path.id - text: Get the settings of integration {id}. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/integrations/{id}'].put update: x-apievangelist-phrasing: intent: Replace a shop integration's settings effect: write questions: - How do I overwrite all of a shop integration's settings in one go? - Can I set a new shop name and URL with a full update of an integration? instructions: - text: Replace the settings of integration {id} with shop name {shop_name} and URL {shop_url}. slots: id: path.id shop_name: requestBody.shop_name shop_url: requestBody.shop_url - text: Do a full update of integration {id}. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/integrations/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a shop integration effect: destructive questions: - How do I disconnect a webshop from Sendcloud? - Can I remove a shop integration I no longer use? instructions: - text: Delete shop integration {id}. slots: id: path.id - text: Disconnect integration {id} from my account. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/integrations/{id}'].patch update: x-apievangelist-phrasing: intent: Change selected shop integration settings effect: write questions: - Can I turn on the webhook for a shop without resending all its settings? - How do I enable service points for just one integration? instructions: - text: Set the webhook URL of integration {id} to {webhook_url}. slots: id: path.id webhook_url: requestBody.webhook_url - text: 'Turn service points on for integration {id}: {service_point_enabled}.' slots: id: path.id service_point_enabled: requestBody.service_point_enabled method: generated generated: '2026-10-01' - target: $.paths['/integrations/logs'].get update: x-apievangelist-phrasing: intent: List all integration exception logs (v2) effect: read questions: - Where can I see every error my shop integrations have logged? - Do any of my integrations have connection problems right now? instructions: - text: List exception logs across all integrations. - text: Show every integration connection issue logged so far. method: generated generated: '2026-10-01' - target: $.paths['/integrations/{id}/logs'].get update: x-apievangelist-phrasing: intent: List exception logs for one integration (v2) effect: read questions: - What went wrong with one particular shop integration? - How do I view the connection issue log of a single shop? instructions: - text: Show the exception logs of integration {id}. slots: id: path.id - text: List connection issues logged for shop integration {id}. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/integrations/{id}/logs'].post update: x-apievangelist-phrasing: intent: Record an integration exception log (v2) effect: write questions: - How does my integration add an entry to the merchant's connection issue log? - What request and response details can an exception log entry hold? instructions: - text: Create an exception log for integration {id} for a call to {base_url}. slots: id: path.id base_url: requestBody.base_url - text: Log exception {exception} for integration {id} at {base_url}. slots: id: path.id exception: requestBody.exception base_url: requestBody.base_url method: generated generated: '2026-10-01' - target: $.paths['/shop-order-statuses'].get update: x-apievangelist-phrasing: intent: List shop order statuses for an integration effect: read questions: - Which order statuses does my Prestashop integration know about? - Can I fetch shop order statuses in another language or include deleted ones? instructions: - text: List shop order statuses for integration {integration_id}. slots: integration_id: query.integration_id - text: Get the order statuses of integration {integration_id} in {language}. slots: integration_id: query.integration_id language: query.language method: generated generated: '2026-10-01' - target: $.paths['/shop-order-statuses'].post update: x-apievangelist-phrasing: intent: Create or overwrite shop order statuses effect: write questions: - How do I push my shop's custom order statuses into Sendcloud? - Will sending custom statuses replace the ones already stored? instructions: - text: Save custom order statuses {statuses} for integration {integration_id}. slots: integration_id: requestBody.integration_id statuses: requestBody.statuses - text: Overwrite the shop order statuses of integration {integration_id}. slots: integration_id: requestBody.integration_id method: generated generated: '2026-10-01' - target: $.paths['/shop-order-statuses/mapping'].get update: x-apievangelist-phrasing: intent: Get an integration's order status mapping effect: read questions: - How are my shop's order statuses mapped to Sendcloud status categories? - Which internal category does each custom shop status map to? instructions: - text: Show the status mapping for integration {integration_id}. slots: integration_id: query.integration_id - text: Get how integration {integration_id} maps shop statuses to Sendcloud categories. slots: integration_id: query.integration_id method: generated generated: '2026-10-01' - target: $.paths['/shop-order-statuses/mapping'].post update: x-apievangelist-phrasing: intent: Set an integration's order status mapping effect: write questions: - Can I change which Sendcloud category a custom shop status maps to? - How do I upsert the status mapping for an integration? instructions: - text: Update the status mapping of integration {integration_id} to {mapping}. slots: integration_id: requestBody.integration_id mapping: requestBody.mapping - text: Map shop statuses to Sendcloud categories for integration {integration_id}. slots: integration_id: requestBody.integration_id method: generated generated: '2026-10-01'