> For the complete documentation index, see [llms.txt](https://docs.peakcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.peakcommerce.com/developers/changelog.md).

# Changelog

The PeakCommerce **Agent API** is versioned so your integrations stay stable as the platform evolves. The current version is **v1**, served under `/api/v1`.

## How versioning works

* **Additive, backward-compatible changes** ship continuously within v1 — new endpoints, new optional request fields, new response fields, new event types, and new `nextActions`. These never require a change on your side.
* **Breaking changes** would be introduced under a new version path (for example a future `/api/v2`), not applied to v1 in place, so existing integrations keep working.

## Track what your tenant supports

Rather than reading a static list, query the live shape of the API:

* **`GET /api/v1/manifest`** returns the capabilities your tenant currently exposes, including `capabilities.eventTypes` — the complete, live list of webhook events.
* The [API Reference](https://docs.peakcommerce.com/developers/api-reference/api-reference.md) and the [OpenAPI spec](https://api.peakcommerce.app/api/v1/openapi.json) always reflect the current contract.

## Build defensively

Because v1 changes are additive, integrations that **ignore unknown fields, avoid hard-coded enum lists, and follow `nextActions` rather than constructing URLs by hand** absorb new capabilities automatically — no code change needed when the API grows.

## Related

* [API Reference](https://docs.peakcommerce.com/developers/api-reference/api-reference.md)
* [Webhooks overview](https://docs.peakcommerce.com/developers/api-reference/webhooks-overview.md)
* [SDKs & Tooling](https://docs.peakcommerce.com/developers/sdks.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.peakcommerce.com/developers/changelog.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
