> ## Documentation Index
> Fetch the complete documentation index at: https://docs.replo.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Version 2026-11-17

## Carrier tracking events in order histories

An order's `events` can now include three kinds that come from the carrier's tracking updates:

| `metadata.kind` | Meaning | Extra fields |
| - | - | - |
| `shipmentInTransit` | The carrier picked up the package. | `trackingCarrier`, `location` (both optional) |
| `shipmentOutForDelivery` | The package is out for delivery. | none |
| `shipmentException` | Delivery was attempted, the package is returning to the sender, or delivery failed. | `shipmentStatus` (`attemptedDelivery`, `returnToSender` or `failure`), `message` (optional) |

Each also carries `fulfillmentOrderId` and `fulfillmentId`, like the other shipment events.

## Shipping and webhooks (beta)

These routes are new and marked beta. They need the new scopes below on a project API key.

| Route | Scope | What it does |
| - | - | - |
| `GET /v1/orders` | `orders.read` | Takes two new filters: `fulfillmentStatus` (`unfulfilled`, `partial`, `fulfilled`, `cancelled`) and `updatedSince` (ISO 8601). Both filter before paging, so cursors stay exact. |
| `GET /v1/orders/{orderId}/fulfillments` | `orders.read` | Lists every package of an order, from any tool. |
| `POST /v1/orders/{orderId}/fulfillments` | `orders.write` | Marks items shipped with tracking. Safe to repeat: the same tracking number and carrier returns the package already recorded. |
| `PATCH /v1/fulfillments/{fulfillmentId}` | `orders.write` | Corrects a package's carrier, tracking number or link. |
| `GET`, `POST /v1/shipping/packages`, `PATCH`, `DELETE /v1/shipping/packages/{shippingPackageId}` | `shipping.read`, `shipping.write` | Lists and changes the boxes the store ships in. |
| `GET`, `PATCH /v1/shipping/settings` | `shipping.read`, `shipping.write` | Reads and changes the store's shipping settings, including when the shipped email goes out. |
| `GET`, `POST /v1/shipping/options`, `PATCH`, `DELETE /v1/shipping/options/{shippingOptionId}` | `shipping.read`, `shipping.write` | Lists and changes the shipping and pickup options buyers choose from at checkout. |
| `GET`, `POST /v1/shipping/profiles`, `PATCH`, `DELETE /v1/shipping/profiles/{shippingProfileId}` | `shipping.read`, `shipping.write` | Lists and changes groups of products with their own checkout options. |
| `POST /v1/orders/{orderId}/label-rates` | `shipping.read` | Quotes postage for one package and returns a `shipmentId` with the rates. |
| `POST /v1/orders/{orderId}/labels` | `shipping_labels.write` | Buys one rate from a quote, charged to the store's card. Safe to repeat: the same rate returns the same label. |
| `GET /v1/shipping/labels`, `GET /v1/shipping/labels/{shippingLabelId}` | `shipping.read` | Lists and reads labels, each with a short-lived link to its PDF. |
| `POST /v1/shipping/labels/{shippingLabelId}/void` | `shipping_labels.write` | Asks the carrier to refund an unused label. |
| `POST /v1/shipping/label-batches`, `GET /v1/shipping/label-batches/{shippingLabelBatchId}` | `shipping_labels.write`, `shipping.read` | Buys labels for many orders in the background. |
| `GET`, `POST /v1/webhook-endpoints`, `GET`, `PATCH`, `DELETE /v1/webhook-endpoints/{webhookEndpointId}` | `webhooks.read`, `webhooks.write` | Manages the URLs Replo sends signed events to. The create response carries the signing secret once. |
| `POST /v1/webhook-endpoints/{webhookEndpointId}/rotate-secret` | `webhooks.write` | Makes a new signing secret and returns it once. |
| `GET /v1/webhook-endpoints/{webhookEndpointId}/deliveries` | `webhooks.read` | Lists an endpoint's deliveries, newest first. |
| `POST /v1/webhook-deliveries/{webhookDeliveryId}/redeliver` | `webhooks.write` | Sends one delivery again now. |

New scopes: `orders.write`, `shipping.read`, `shipping.write`, `shipping_labels.write` (buying and voiding labels, which spends the store's money), `webhooks.read` and `webhooks.write`.

See [Webhooks](https://docs.replo.app/api-reference/webhooks.md) for event types, payloads and signature checks, and [Shipping from your own tool](https://docs.replo.app/developers/shipping.md) for a walkthrough.

## Migration

Requests pinned to `2026-11-14` or earlier don't receive the carrier tracking events; the rest of the order history is unchanged. They also can't send `fulfillmentStatus` or `updatedSince` to `GET /v1/orders`; pin `2026-11-17` to use them.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.