# Envoi Integration Platform

Envoi is a same-day and next-day parcel delivery carrier operating in Canada, serving the Greater Toronto Area and other service areas. This site documents every way to integrate with Envoi: the REST API, webhooks, SFTP file exchange, the Shopify app, rate-shop integrator platforms, and 3PL-mediated setups. All examples use one consistent fictional dataset (retailer "Maple & Main", order `MM-10042`) so you can follow a single order end to end.

## Who these docs are for

These docs are for integrators: retailer engineering teams, 3PLs, and platform partners. Start with the [Quickstart](docs/getting-started/quickstart.md) to create and track an order on staging in about 15 minutes, then use [Choose Your Pathway](docs/getting-started/choose-your-pathway.md) to pick the integration model that fits your stack. Your Envoi solution engineer works from a companion internal handbook and will configure the Envoi-side settings referenced throughout these pages.

## Documentation map

- **Getting Started** — [Quickstart](docs/getting-started/quickstart.md), [Choose Your Pathway](docs/getting-started/choose-your-pathway.md), [Environments](docs/getting-started/environments.md), [Authentication](docs/getting-started/authentication.md)
- **API Conventions** — [Envelope, pagination, errors, rate limits](docs/api/conventions.md)
- **API Reference: Orders** — [The Order Object](docs/api/orders/object.md), [Create](docs/api/orders/create.md), [List](docs/api/orders/list.md), [Get / Update / Cancel](docs/api/orders/get-update-cancel.md)
- **API Reference: Tracking** — [Shipment Tracking](docs/api/tracking/shipment-tracking.md), [Statuses & Reason Codes](docs/api/tracking/statuses.md), [Simulate Tracking Events](docs/api/tracking/simulate.md)
- **API Reference: Service Areas & Rates** — [Validate & Rate](docs/api/service-areas/validate.md), [Service Area Lookups](docs/api/service-areas/lookup.md)
- **API Reference: More** — [Shipping Labels](docs/api/labels.md), [Multi-Package Orders](docs/api/multi-package.md), [Ingestion Endpoints](docs/api/ingestion-endpoints.md)
- **Webhooks** — [Overview](docs/webhooks/overview.md), [Event Payload](docs/webhooks/payload.md), [Verifying HMAC Signatures](docs/webhooks/verify-hmac.md)
- **SFTP** — [Inbound Order Files](docs/sftp/inbound-orders.md), [Outbound Tracking Files](docs/sftp/outbound-tracker.md)
- **Integration Pathways** — [Direct API](docs/pathways/direct-api.md), [Rate-Shop Integrators](docs/pathways/rate-shop-integrators.md), [SFTP](docs/pathways/sftp.md), [3PL](docs/pathways/3pl.md), [Shopify](docs/pathways/shopify.md)

## Tools and machine-readable docs

> **Postman collection** — Import the ready-made collection and staging/production environments and run an end-to-end order flow without writing code. See [Postman Collection](docs/tools/postman.md).

> **OpenAPI specification** — Every public endpoint is described in [`machine/openapi.yaml`](machine/openapi.yaml). Use it to generate clients or validate requests. See [OpenAPI Specification](docs/tools/openapi.md).

> **AI / LLM tooling** — Point Claude, Cursor, or any LLM harness at `llms.txt` and `llms-full.txt`, plus the JSON Schemas, enums, and canonical examples under `machine/`. See [Using These Docs with AI Tools](docs/tools/llm-usage.md).

## Base URLs

| Environment | API | Dashboard |
|---|---|---|
| Production | `https://api.yourenvoi.com` | `https://app.yourenvoi.com` |
| Staging | `https://api.staging.yourenvoi.com` | `https://app.staging.yourenvoi.com` |

Public tracking pages live at `https://app.yourenvoi.com/tracking/<envoiTrackingCode>`.

Questions or no test account yet? Email your Envoi contact or marcello@envoinow.com.