# Shipments

## Operations

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/v1/shipments` | [List shipments](../listshipments.md) |
| `POST` | `/v1/shipments` | [Create a shipment](../createshipment.md) |
| `DELETE` | `/v1/shipments/{shipment_id}` | [Cancel a shipment before handoff](../cancelshipment.md) |
| `GET` | `/v1/shipments/{shipment_id}` | [Retrieve a shipment](../retrieveshipment.md) |
| `PATCH` | `/v1/shipments/{shipment_id}` | [Update delivery instructions](../updateshipment.md) |

## Related pages

- [Buy and render a shipping label](../createlabel.md)
- [Cancel a pickup](../cancelpickup.md)
- [Cancel a shipment before handoff](../cancelshipment.md)
- [Create a shipment](../createshipment.md)
- [Delete a webhook endpoint](../deletewebhookendpoint.md)
- [Labels](./labels.md)
- [List scheduled pickups](../listpickups.md)
- [List shipments](../listshipments.md)
- [List tracking events for a shipment](../listshipmentevents.md)
- [List webhook endpoints](../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`.