PAR POS™ | API Release Notes

Build 0.3.127 · PAR POS v5.17 · Release date TBD

API Change Report: v5.16r5 → v5.17

✅ 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 POS Developer Portal:

https://developers.partech.com/

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.3.127 — What’s New

New Features

ID Description
AS1-3318 SavePromotions API hardening (PMP/RSI integration). The SavePromotions REST endpoints (POST /settings/v1/promotions to create and PUT /settings/v1/promotions to update) and the SOAP SavePromotions operation were introduced in 5.16r2. This release completes that work with additional validations on promotion saves, fixes to validation issues found in REST and SOAP testing, and SOAP SavePromotions documentation on the API Portal. The MarketingCampaigns data type must still be explicitly requested in the GetSettings call. Integrators should review the API Portal documentation and confirm that the promotion payloads they submit pass the validations.
AS1-3316 Cancel future orders that have been sent to the kitchen or are on the KDS (Burger King request). The request is to extend the CancelOrder API so that an order that has already been sent can be cancelled and voided, with the void source reported as API. This capability is not active in 5.17. The POS-side portion of the work is not complete in this release, so the Order Service check that rejects already-sent orders was restored. CancelOrder continues to behave as it did in 5.16r5, and returns ResultCode 102 for orders already sent to the kitchen.

Performance & Reliability

These changes reduce memory use and protect the External API from cache-related failures during heavy traffic. They do not change request or response contracts, and no integrator action is required.

ID Description
AS1-3738 Cache stampede handling and memory optimization. A set of changes that reduce per-request memory use on the External API and prevent System.OutOfMemoryException errors on large accounts. The individual changes are listed below.
AS1-3673 Streaming settings deserialization. Settings responses used by GetItems, GetModifierGroups, GetItemGroups, and Lanes are now deserialized as a stream instead of being built in memory first. This roughly halves peak memory for these calls.
AS1-3674 Reduced allocations in GetOrders. Order translation now releases source objects as it goes, uses pre-sized collections, replaces repeated scans with dictionary lookups, and caches serializer options. The GetOrders response shape is unchanged.
AS1-3685 Unused fields removed from the historical order models. Fields that were deserialized from the Reporting service but never returned by GetOrders are no longer read. The GetOrders response is unchanged.
AS1-3749 Lower memory use for large-account token caching. For accounts with several thousand locations, cached access information is now returned directly instead of being copied on every read, reducing garbage collection pressure.
AS1-3684 Settings request coalescing and TTL jitter. When many requests miss the settings cache at the same time, they are combined into a single settings fetch. Cache expiry times are also randomized so that locations do not all expire together after a mass settings change.
AS1-3641 Dictionary exception fixed in the settings filter cache. Corrected an exception raised in the settings filter cache of the settings client.
AS1-3642 Unique identifier for in-store communication. Calls to the store now use a unique GUID as the communication identifier instead of the HTTP request correlation ID.

Order Service Modernization

ID Description
AS1-3336 Order Service modernization — decouple Order Service. Internal engineering work on the Order Service, including database usage improvements, serialization and payment audit fixes for the .NET 10 solution, project file updates, and added unit and integration test coverage. There are no changes to the Order Service API contract, and no integrator action is required.

WSDL Changes (0.2.152 → 0.3.127)

No changes to the CDN-published WSDL files have been identified for the SOAP services covered by this release, so SOAP clients using auto-generated proxies require no regeneration for this build.