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

# Changelog

> Changes to the stable API contract and corrections to returned values

This page lists, by date, changes to the stable API contract and corrections to returned values. Fields and parameters whose description starts with `Preview:` in the API reference may change without an entry here.

## 2026-11-22

### Documents

The document `type` model now includes public values for customer-visible document types. Examples include `hbl_telex` for a telex release, `bl_draft` for a draft bill of lading, `booking_confirmation` for a booking confirmation, and `origin_certificate` for a certificate of origin. See the [Document model](https://apidoc.ovrsea.com/models/Document.md).

Documents of the newly typed kinds previously came back without a `type` key. They now carry a public value.

An arrival notice is now returned as `arrival_notice`. It was previously returned as `proof_of_delivery`.

### Shipments

Added the preview `include_cancelled` query parameter to `GET /v1/shipments`. It defaults to `false`, so callers that do not send it continue to receive the existing list without cancelled shipments.

Added the preview `master_airway_bill` and `house_airway_bill` fields under `booking_information.air_booking`. They return the master and house air waybill numbers when available.

### Tracking

Added the preview `type`, `mode_of_transport`, and `is_from_consolidation` fields to each tracking event. `type` and `mode_of_transport` use documented values, and `is_from_consolidation` indicates whether the event was copied from the parent consolidation shipment.

Added the top-level tracking `status` to the response. Previously, this field was always left out. It is now filled with the shipment's `status`, using the same values as the shipment resource. It remains left out when the shipment resource has no `status`. This top-level field is distinct from the `status` carried by each tracking event.

## 2026-11-20

### Invoices

Invoices now have these preview fields. `recipient` is an object whose `name` is the name written on the invoice. The `recipient` field is left out when the invoice has no recipient. `total_excluding_tax`, `total_including_tax`, and `amount_paid` are amounts in the major unit of the invoice currency. `amount_paid` is present while an invoice is partially paid. `payment_date` gives the date on which the invoice was fully paid. `link` is a temporary signed URL to the invoice file. It is valid for three hours, and anyone holding the URL can open it. `shipment_ids` lists the readable shipments the invoice covers. Each invoice line also has a preview `amount` in the major unit of the currency. The historical line field `price` is unchanged and remains in cents.

An invoice covering several shipments no longer returns the placeholder text `BILLING_REF_TODO` as its `reference`. The field is left out when the platform holds no reference.


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