Changelog

This document records changes to the API that integrators can see, newest first. Each entry states the date, the kind of change (added, changed, or deprecated), the endpoints affected, what changed, and what callers must do. Additive changes are backward compatible and need no caller action. A change that cannot be made additively is announced here in advance, with the date it takes effect, before it takes effect. This is the authoritative record of API changes for the reference (API Reference).

Entry format

## YYYY-MM-DD: added | changed | deprecated
**Affects:** the endpoints or documents changed
**Change:** what changed, in integrator-visible terms
**Caller action:** what to do, or "None"

2026-10-12: added

Affects: Veterinary and Pharmacy Endpoints

Change: Pharmacy partners can now report a prescription as on_hold with a note stating what is needed, and can read the hold state back on the prescription. on_hold was added to the pharmacy_status values in Data Types and Enums.

Caller action: None. Pharmacy clients should carry a default branch for new status values, as Data Types and Enums directs.

2026-09-28: added

Affects: Webhook Event Schemas, Payments Endpoints

Change: New event payout.paid, fired when a payout is sent, with payout_id, net, currency, and the period bounds in its payload. The event is available for subscription in the Seller Center.

Caller action: None. Subscribe in the Seller Center if your accounting flow needs payout notice without polling.

2026-09-15: added

Affects: Pricing Endpoints

Change: Scheduled price changes. POST /pricing/{variant_id}/schedule and DELETE /pricing/schedules/{id} let an account set a future price, with automatic reversion where an end time is given.

Caller action: None. Existing price writes are unchanged.

2026-08-24: changed

Affects: Rate Limit Headers, all endpoints

Change: Responses now carry X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on every response, and 429 responses carry Retry-After. The limits themselves are unchanged.

Caller action: Update clients to pace on the headers and to honor Retry-After, if they do not already.

2026-08-03: added

Affects: Idempotency Keys, all write endpoints

Change: The Idempotency-Key header is accepted on every write endpoint, with the recorded-result behavior and the idempotency_conflict error specified in Idempotency Keys and Error Codes.

Caller action: Send a key on every create and every value-moving write, as Idempotency Keys directs. Writes without a key continue to work but are not protected against duplicate application on retry.

2026-07-20: added

Affects: Franchise Endpoints

Change: Franchise accounts can read their locations, the agreement in force for each location, and fee and royalty statements through the API.

Caller action: None for other account types.

2026-06-29: changed

Affects: OpenAPI Spec

Change: The machine-readable description of the API is issued per account tier and carries a publication date and document version, so a generated client can be traced to the description it was built from.

Caller action: Request a fresh copy from the Seller Center or support@aapawz.com when regenerating a client, and record its version with your release.

2026-06-08: added

Affects: Glossary, Analytics Endpoints

Change: Reporting endpoints for sales summaries, product and category performance, and inventory and fulfillment indicators, as specified in Analytics Endpoints. Terms used by the reports were added to the Glossary.

Caller action: None.

Deprecations

No endpoint, field, or event is under a deprecation notice at the date of this entry. When a deprecation is announced, this section will name the element, the date it stops working, and what replaces it, and the announcement will appear here at least 90 days before that date.

OpenAPI Spec

Glossary