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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for [BETA] Service Points API
version: 1.0.0
extends: openapi/sendcloud-service-points-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: 3
- target: $.paths['/service-points'].get
update:
x-apievangelist-phrasing:
intent: Find service points near a location
effect: read
questions:
- Where are the nearest pickup points in a postal code?
- Can I search for service points within a radius of coordinates?
instructions:
- text: Find service points in {country_code} near {address}.
slots:
country_code: query.country_code
address: query.address
- text: List {carrier_code} service points in {country_code} within {radius} meters of {latitude},{longitude}.
slots:
carrier_code: query.carrier_code
country_code: query.country_code
radius: query.radius
latitude: query.latitude
longitude: query.longitude
method: generated
generated: '2026-10-01'
- target: $.paths['/service-points/{service_point_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a service point
effect: read
questions:
- How do I get the address and opening hours of one service point?
- What details are stored for a particular service point?
instructions:
- text: Show service point {service_point_id}.
slots:
service_point_id: path.service_point_id
- text: Get the details of service point {service_point_id}.
slots:
service_point_id: path.service_point_id
method: generated
generated: '2026-10-01'
- target: $.paths['/service-points/{service_point_id}/check-availability'].post
update:
x-apievangelist-phrasing:
intent: Check if a service point is available
effect: read
questions:
- Is a given service point open and accepting parcels right now?
- Can I confirm a pickup point is still available before shipping to it?
instructions:
- text: Check availability of service point {service_point_id}.
slots:
service_point_id: path.service_point_id
- text: Confirm service point {service_point_id} is currently available.
slots:
service_point_id: path.service_point_id
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.