Generated by API Evangelist
Written by API Evangelist tooling for Envia.com's API. It is a proposal applied on top of the contract, not a document Envia.com publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Envia Queries Shipments API
version: 1.0.0
extends: openapi/envia-shipments-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-20'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/guide/{MM}/{YYYY}'].get
update:
x-apievangelist-phrasing:
intent: List shipments for a month
effect: read
questions:
- How many shipments did I create last month?
- Can I get a summary of all my shipments in a given calendar month?
instructions:
- text: List my shipments for {MM} {YYYY}.
slots:
MM: path.MM
YYYY: path.YYYY
- text: Show every shipment created under my account in {MM} {YYYY}.
slots:
MM: path.MM
YYYY: path.YYYY
method: generated
generated: '2026-11-20'
- target: $.paths['/guide/{tracking_number}'].get
update:
x-apievangelist-phrasing:
intent: Look up a single shipment
effect: read
questions:
- What is the current status of a specific shipment?
- Can I see the full details of one tracking number?
instructions:
- text: Get the shipment with tracking number {tracking_number}.
slots:
tracking_number: path.tracking_number
- text: Show the origin, destination and tracking history for {tracking_number}.
slots:
tracking_number: path.tracking_number
method: generated
generated: '2026-11-20'
- target: $.paths['/shipments/labels-bulk'].post
update:
x-apievangelist-phrasing:
intent: Download labels for many shipments
effect: read
questions:
- Can I print labels for a batch of shipments at once?
- Does the bulk label download return a ZIP if I include non-PDF files?
instructions:
- text: Download labels for shipments {shipments}.
slots:
shipments: requestBody.shipments
- text: Download labels for {shipments} including {additional_files} and a {with_report} report.
slots:
shipments: requestBody.shipments
additional_files: requestBody.additional_files
with_report: requestBody.with_report
method: generated
generated: '2026-11-20'
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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.