# Parcel Events Sandbox API

A fictional logistics API used only to exercise generated SDK publication. Every company, identifier, address, tracking event, and URL in this corpus is synthetic.

Version `2026-09-04`

Servers: `https://api.parcel-events.example`, `https://sandbox.parcel-events.example`

## Operations

| Method | Path | Operation |
| --- | --- | --- |
| `POST` | `/v1/labels` | [Buy and render a shipping label](./api/operations/createlabel.md) |
| `GET` | `/v1/labels/{label_id}` | [Retrieve label metadata and download URL](./api/operations/retrievelabel.md) |
| `GET` | `/v1/pickups` | [List scheduled pickups](./api/operations/listpickups.md) |
| `POST` | `/v1/pickups` | [Schedule a carrier pickup](./api/operations/createpickup.md) |
| `DELETE` | `/v1/pickups/{pickup_id}` | [Cancel a pickup](./api/operations/cancelpickup.md) |
| `GET` | `/v1/pickups/{pickup_id}` | [Retrieve a pickup](./api/operations/retrievepickup.md) |
| `POST` | `/v1/rates/quote` | [Quote available shipping services](./api/operations/quoterates.md) |
| `GET` | `/v1/shipments` | [List shipments](./api/operations/listshipments.md) |
| `POST` | `/v1/shipments` | [Create a shipment](./api/operations/createshipment.md) |
| `DELETE` | `/v1/shipments/{shipment_id}` | [Cancel a shipment before handoff](./api/operations/cancelshipment.md) |
| `GET` | `/v1/shipments/{shipment_id}` | [Retrieve a shipment](./api/operations/retrieveshipment.md) |
| `PATCH` | `/v1/shipments/{shipment_id}` | [Update delivery instructions](./api/operations/updateshipment.md) |
| `GET` | `/v1/shipments/{shipment_id}/events` | [List tracking events for a shipment](./api/operations/listshipmentevents.md) |
| `GET` | `/v1/tracking/{tracking_number}` | [Retrieve a public tracking timeline](./api/operations/retrievetrackingtimeline.md) |
| `GET` | `/v1/webhook-endpoints` | [List webhook endpoints](./api/operations/listwebhookendpoints.md) |
| `POST` | `/v1/webhook-endpoints` | [Register a webhook endpoint](./api/operations/createwebhookendpoint.md) |
| `DELETE` | `/v1/webhook-endpoints/{endpoint_id}` | [Delete a webhook endpoint](./api/operations/deletewebhookendpoint.md) |
| `PATCH` | `/v1/webhook-endpoints/{endpoint_id}` | [Update a webhook endpoint](./api/operations/updatewebhookendpoint.md) |
| `POST` | `shipmentStatusChanged` | [Shipment status changed](./api/operations/shipmentstatuschanged.md) |

## Related pages

- [Buy and render a shipping label](./api/operations/createlabel.md)
- [Cancel a pickup](./api/operations/cancelpickup.md)
- [Cancel a shipment before handoff](./api/operations/cancelshipment.md)
- [Create a shipment](./api/operations/createshipment.md)
- [Delete a webhook endpoint](./api/operations/deletewebhookendpoint.md)
- [Labels](./api/operations/tags/labels.md)
- [List scheduled pickups](./api/operations/listpickups.md)
- [List shipments](./api/operations/listshipments.md)
- [List tracking events for a shipment](./api/operations/listshipmentevents.md)
- [List webhook endpoints](./api/operations/listwebhookendpoints.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.