API Release Notes - Build 0.1.214

Build 0.1.214 · PAR POS v5.15r2 · Version History v4.0 · March 2026

API Change Report: v5.15 → v5.15r2

No Breaking Changes in this Release. All changes are fully backward-compatible. Existing integrations require no code changes.

API Portal & Documentation

Full API documentation — including message examples, schema definitions, and field descriptions — is available on the PAR Developer Portal.

API Best Practices

Request Rate & Batching

Batch requests should be sequential. If end-customer systems allow multi-threaded load, adhere to the recommended Requests Per Minute (RPM) limits below.

Changes should be published and tested on one location first, then cascade to other locations.

If changes are made in parallel at multiple locations, only single-record changes should be executed — bulk/batch operations are not recommended in parallel scenarios.

Changes from one location must not be cascaded to more than 500 locations at once.

Rate Limits (applicable for both EOD and Immediate Publish)

Endpoint Group	Max Batch Size	Max RPM
SaveItems, SaveDestinations, SaveTaxes	100	5
DeleteItems, DeleteDestinations, DeleteTaxes	20	5
SavePriceChange / DeletePriceChange	Not recommended (single record only)	—

API Build 0.1.214 — What’s New

Field Bug Fixes

ID	Description
AS1-3556	IAM Kinesis Firehose authorization error on SOAP API resolved. SOAP API services (Data, Order, and Settings) began throwing AmazonKinesisFirehoseException errors. The Kubernetes node role assumed by the API services was not authorized to perform firehose: PutRecord on the telemetry Firehose delivery stream, causing API telemetry data to fail to log across all SOAP endpoints and the REST monetization services. IAM permissions were corrected to grant the node role the necessary firehose: PutRecord action on the telemetry stream. After the fix was deployed, AmazonKinesisFirehoseException errors were no longer observed, and API requests are confirmed to be logging successfully across all affected services (SOAP Data, SOAP Order, SOAP Settings, REST Data, REST Order, REST Settings, and API monetization). No changes to API request or response structure are required; existing integrations are not affected.

Description

AS1-3556

IAM Kinesis Firehose authorization error on SOAP API resolved. SOAP API services (Data, Order, and Settings) began throwing AmazonKinesisFirehoseException errors. The Kubernetes node role assumed by the API services was not authorized to perform firehose: PutRecord on the telemetry Firehose delivery stream, causing API telemetry data to fail to log across all SOAP endpoints and the REST monetization services. IAM permissions were corrected to grant the node role the necessary firehose: PutRecord action on the telemetry stream. After the fix was deployed, AmazonKinesisFirehoseException errors were no longer observed, and API requests are confirmed to be logging successfully across all affected services (SOAP Data, SOAP Order, SOAP Settings, REST Data, REST Order, REST Settings, and API monetization). No changes to API request or response structure are required; existing integrations are not affected.

API Build 0.1.213 — What’s New

Bug Fixes & Improvements

ID	Description
AS1-3480	New Close Order endpoint added. A new endpoint has been added to the Brink External API, enabling external systems to programmatically close an open order by its ID. POST /v1/orders/{id}/close Response codes: 200 OK (success), 400 Bad Request (order already closed, balance still due, not yet sent to kitchen, or invalid request) 404 Not Found (order not found) 504 Gateway Timeout (no store response) 401/403/500/503 for authentication, authorization, or server errors. Note: attempts to close an order with an outstanding balance or one not yet sent to the kitchen will result in a 400 error; ensure these conditions are resolved before calling the endpoint. Updated binaries for the Store Ordering Service and In-Store service have been deployed.
AS1-3540	Get Orders composite item error resolved. A bug causing the Get Orders API to return a generic UnknownError when retrieving historical orders containing certain composite (combo) menu items has been resolved. Three specific scenarios are now handled correctly: Composite items whose parent has no taxes defined at the parent level Multiple child items sharing the same tax type Child items referencing a non-existent parent. Affected orders are now returned successfully. No changes to the API request or response structure are required; existing integrations benefit from this fix automatically.
AS1-3558	Deleted records no longer returned by Settings API. The Settings Service was incorrectly including deleted employees, jobs, security levels, and permissions in API responses. This has been resolved — only active, non-deleted records are now returned.

Description

AS1-3480

New Close Order endpoint added. A new endpoint has been added to the Brink External API, enabling external systems to programmatically close an open order by its ID.

POST /v1/orders/{id}/close

Response codes:

200 OK (success),
400 Bad Request (order already closed, balance still due, not yet sent to kitchen, or invalid request)
404 Not Found (order not found)
504 Gateway Timeout (no store response)
401/403/500/503 for authentication, authorization, or server errors.

Note: attempts to close an order with an outstanding balance or one not yet sent to the kitchen will result in a 400 error; ensure these conditions are resolved before calling the endpoint.

Updated binaries for the Store Ordering Service and In-Store service have been deployed.

AS1-3540

Get Orders composite item error resolved. A bug causing the Get Orders API to return a generic UnknownError when retrieving historical orders containing certain composite (combo) menu items has been resolved.

Three specific scenarios are now handled correctly:

Composite items whose parent has no taxes defined at the parent level
Multiple child items sharing the same tax type
Child items referencing a non-existent parent.

Affected orders are now returned successfully.

No changes to the API request or response structure are required; existing integrations benefit from this fix automatically.

AS1-3558

Deleted records no longer returned by Settings API. The Settings Service was incorrectly including deleted employees, jobs, security levels, and permissions in API responses. This has been resolved — only active, non-deleted records are now returned.

API Build 0.1.212 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3481	CloseOrder endpoint — Above Store Ordering Service changes. Server-side patch implementing the Above Store Ordering Service changes required to support the new CloseOrder endpoint (AS1-3474). The ordering service has been updated to handle programmatic order closure requests, validating that the Order ID exists and that the order is currently open before updating its status to Closed.
AS1-3540	Admin6 GetOrders failure resolved. A GetOrders API call was returning ResultCode 1 (Unknown error) for a specific business date, preventing order data from being retrieved. The underlying data issue causing the failure has been corrected and GetOrders now returns successfully for the affected business date.

API Build 0.1.211 — What's New

Bug Fixes & Improvements

ID	Description
POG-3154	Indefinite clock-in state resolved. A bug caused certain employees to remain clocked in indefinitely with no clock-out time recorded, causing the Admin Portal to crash when editing affected shifts and disrupting payroll reporting. The shift management service has been updated to handle incomplete clock-in records correctly, preventing crashes during shift editing and eliminating downstream payroll impact. Safeguards have also been added to prevent this scenario from recurring.
AS1-3474	New API endpoint: programmatic order closure. Previously, order closing was controlled entirely by the Auto Close setting in the Settings Editor (Enabled: orders closed on kitchen send; Disabled: manual closure required). A new API endpoint now allows integrators to close orders programmatically. Before processing, the endpoint validates that the Order ID exists and is valid, and that the associated order is currently open. Once both checks pass, the order status is updated to Closed. This gives integrators greater control over order management while preventing invalid or duplicate closure attempts.

Description

POG-3154

Indefinite clock-in state resolved. A bug caused certain employees to remain clocked in indefinitely with no clock-out time recorded, causing the Admin Portal to crash when editing affected shifts and disrupting payroll reporting. The shift management service has been updated to handle incomplete clock-in records correctly, preventing crashes during shift editing and eliminating downstream payroll impact. Safeguards have also been added to prevent this scenario from recurring.

AS1-3474

New API endpoint: programmatic order closure. Previously, order closing was controlled entirely by the Auto Close setting in the Settings Editor (Enabled: orders closed on kitchen send; Disabled: manual closure required). A new API endpoint now allows integrators to close orders programmatically. Before processing, the endpoint validates that the Order ID exists and is valid, and that the associated order is currently open. Once both checks pass, the order status is updated to Closed. This gives integrators greater control over order management while preventing invalid or duplicate closure attempts.

API Build 0.1.210 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3403	Memory optimization for large dataset requests. CloudAPI services previously consumed significant memory when processing large datasets such as Items, Promotions, and Item Groups, impacting performance. Memory utilization has been optimized for these calls, resulting in a consistent 25–30% reduction in allocations across different services and improved stability with large data volumes.

API Build 0.1.209 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3397	Health check readiness improved. CloudAPI health checks previously could report "healthy" while the service was still starting up (before caches were warmed or connections established), contributing to intermittent 5xx/502 errors during rollouts or restarts. Health checks are now tied to a stricter readiness check — the service only reports healthy once fully ready to accept traffic — reducing transient errors during deployments.

Description

AS1-3397

Health check readiness improved. CloudAPI health checks previously could report "healthy" while the service was still starting up (before caches were warmed or connections established), contributing to intermittent 5xx/502 errors during rollouts or restarts. Health checks are now tied to a stricter readiness check — the service only reports healthy once fully ready to accept traffic — reducing transient errors during deployments.

API Build 0.1.208 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3384	SaveItems validation aligned with POS core. SaveItems API requests occasionally failed with errors such as "Modifier Group ID does not exist" because the external API enforced two validations that POS core did not: checking that Included Modifier Groups exist, and checking panel references under an item. The SaveItems validations have been updated to match POS core behavior for both IncludedModifiers checks and panel reference checks, without requiring global data cleanup.

Description

AS1-3384

SaveItems validation aligned with POS core. SaveItems API requests occasionally failed with errors such as "Modifier Group ID does not exist" because the external API enforced two validations that POS core did not: checking that Included Modifier Groups exist, and checking panel references under an item. The SaveItems validations have been updated to match POS core behavior for both IncludedModifiers checks and panel reference checks, without requiring global data cleanup.

API Build 0.1.207 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3286	Orphaned SQS queues and SNS subscriptions cleaned up. Containerized Cloud API solutions (SOAP and REST) created a new SQS queue per container subscribed to an SNS topic. When containers were downscaled, queues were not deleted, leaving orphaned SNS subscriptions that caused repeated failures and false monitoring alarms. Containers now properly remove associated SQS queues and SNS subscriptions on shutdown.
AS1-3287	SubmitOrder request logging added. Successful SubmitOrder requests are now written to an accessible S3 bucket to support machine learning model development and easier debugging of production online-ordering issues. Logging is controlled by a configuration flag and can be enabled or disabled to manage storage usage.

Description

AS1-3286

Orphaned SQS queues and SNS subscriptions cleaned up. Containerized Cloud API solutions (SOAP and REST) created a new SQS queue per container subscribed to an SNS topic. When containers were downscaled, queues were not deleted, leaving orphaned SNS subscriptions that caused repeated failures and false monitoring alarms. Containers now properly remove associated SQS queues and SNS subscriptions on shutdown.

AS1-3287

SubmitOrder request logging added. Successful SubmitOrder requests are now written to an accessible S3 bucket to support machine learning model development and easier debugging of production online-ordering issues. Logging is controlled by a configuration flag and can be enabled or disabled to manage storage usage.

API Build 0.1.199 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3231	Ordering Service OOM errors resolved. Ordering Service pods were failing with Out of Memory errors, causing Ordering APIs (including SubmitOrder) to fail. An extraneous group database call in the CalculateOrder flow was adding unnecessary memory consumption and load. The call has been removed and the issue should no longer occur.
AS1-3253	GetOrderBumpTimes performance overhaul. GetOrderItemBumpTimes and GetOrderBumpTimes were causing heavy performance issues and OOM errors/timeouts, especially during overnight data pulls. Both endpoints have been refactored to be exponentially more memory- and performance-efficient.
AS1-3278	AWS SDK for .NET upgraded to v4. v5.15r2 previously used AWS SDK for .NET which ceases receiving updates after June 1, 2026. This patch upgrades to AWS SDK for .NET v4 to ensure continued access to important SDK updates.

API Build 0.1.196 — What's New

Bug Fixes & Improvements

ID	Description
AS1-3200	Background process shutdown improved. The API now shuts down background tasks more cleanly when the POS application stops unexpectedly, ensuring smoother operation and reducing unnecessary resource usage.
AS1-3203	Kitchen instructions separated from orders. Integrators previously used SubmitOrder to send kitchen instructions to the KDS, which interfered with accurate check counts. Kitchen instructions are now sent separately. SubmitOrder accepts only open, non-revenue items ($0) for kitchen instructions, clearly separating them from regular orders and increasing check count accuracy.

Version History

Version	Date	Updates
1.0	3/6/26	Initial Release
2.0	3/30/26	April Menu Maintenance Patch
3.0	5/15/26	Added bug fix AS1-3540
4.0	5/15/26	Added API Build 0.1.212 section with AS1-3481 and AS1-3540
5.0	5/29/26	Added API Build 0.1.213 section with AS1-3480, AS1-3540, and AS1-3558
6.0	7/9/26	Added API Build 0.1.214 section with AS1-3556

Overview

API Release Notes - Build 0.2.145