Changelog

A record of notable GoTab API changes, additions, and deprecations.

This page tracks notable changes to the GoTab API. Breaking changes and deprecations are always called out explicitly.

API Changelog

Versioned history of changes to the GoTab REST API. We use Semantic Versioning:

Major (X.0.0) — Breaking changes: removed endpoints, renamed/removed response fields, schema changes
Minor (x.Y.0) — New endpoints, new response fields, non-breaking additions
Patch (x.y.Z) — Bug fixes, no new routes or response fields

POST /loc/subscribe — subscribes one or more locations to the integration associated with the bearer token. Intended for integrator-driven location mapping: after an end user selects locations in the integrator’s UI, post the chosen location_uuids. The integration is resolved from the token, and the token’s user must have access to every requested location — if any location fails the access check, no locations are subscribed
Loyalty API — customers can now be looked up by name or phone number. The lookup still resolves to a phone number as the lookup value
Loyalty API — customer_handles array on the INQUIRE event when the name/phone lookup type is used, containing all phone numbers and emails on file for the customer

POST /loc/{location}/tabs/{tab_uuid}/refund — refunds are issued against a single payment on the tab. paymentId is optional when the tab has exactly one refundable payment. Provide either amount (in cents) for an open refund or items for an itemized refund, but not both; each items entry requires an itemId and a positive integer quantity, with an optional reason. The top-level reason defaults to "Refund"

Webhook event: OPTION_GROUP_UPDATED — fired whenever an option group is created or updated at a location

Bulk product create/update endpoints now accept accountingStreamId. API-driven product creation can explicitly associate products with an accounting stream, resolving an issue where OPEN products defaulted to “Open Items”

Verification API — POST /v2/verification/challenge and GET /v2/verification/verify
GoTab Wallet — JWT payment_session_token on payment sessions