The documentation version numbering scheme consists of four components. The first three represent the corresponding version of the Fetch API:
- Major - All versions that share a Major component retain backward compatibility
even as new functionality is introduced between minor versions. - Minor - Minor versions introduce new functionality such as new optional parameters
or entirely new endpoints. - Sub-Minor - Sub-Minor versions introduce small improvements such as better
performance or bug fixes that generally do not require documentation changes. - Doc - Doc versions indicate documentation updates published after the most recently released version of the Fetch API. If two versions differ only by
doc component, there was no change to the Fetch server code in that time span.
Recent changes to APIs, tools, and documentation are listed below by version.
- This version was released on 2026-04/14.
- Updates only affect documentation; Fetch API version is still 3.30.0.
- The REST User Guide includes more advice for POS integrations.
- Documentation on the following endpoints is improved:
- GET /stores/{storeId}/items
- GET /items
- GET /items/{itemId}
- POST /transactions
- POST /interfaces/thirdpartycodes
- This version was released on 2026-04/03.
- Includes Fetch API v3.30.0 with new functionality and corresponding documentation in the API reference.
- The following endpoints now return additional attribute information in a unified schema:
- GET /stores/{storeId}/items
- GET /items
- GET /items/{itemId}
- The DELETE verb has been deprecated for the following endpoints which now lead to a 403 response:
- DELETE /dimensions/{dimensionId}
- DELETE /vendors
- DELETE /vendors/{vendorId}
- The following endpoints now return additional attribute information in a unified schema:
- No developers are expected to experience breaking changes in these updates.
- Please contact api@yellowdogsoftware.com for any special requests regarding functionality changes.
- This version was released on 2026-04/01.
- The changes affect documentation only; no endpoint functionality has changed.
- The REST APIs User Guide has been updated for ease of use and comprehension.
- Redirects take old URLs to corresponding new locations.
- This version was released on 2026-03/19.
- The changes affect documentation only; no endpoint functionality has changed.
- All REST API information is now grouped under the "REST APIs" top level tab.
- Auth API endpoints
- Fetch API endpoints
- Content from "Getting Started" is now promoted as the REST APIs User Guide.
- Redirects take old URLs to corresponding new locations.
- This version was released on 2026-03/13.
- Fetch API v3.29.0
- Server side refactoring prepares for future improvements without impacting current API consumers.
- Changelog moved to a top level tab for improved visibility.
- This version was released on 2026-03/10.
- Documentation for the GET /recipes/{id} endpoint reflects newly added cost and usage details.
- Add the following objects to the Recipe schema:
- RecipeCosting
- RecipeCostingStore
- RecipeUsage
- RecipeUsageItem
- Make date-time examples ISO compliant.
- The baseRetail property of a transaction line is now listed as deprecated.
- The RFID API Guide has been updated.
- This version was released on 2026-02/20.
- Corrected an error which caused examples to be omitted for the following endpoints
- POST /transactions
- POST /interfaces/thirdpartycodes
- This version was released on 2026-02/17.
- New RFID features
- An RFID Guide was added to Fetch --> Getting Started
- The following endpoints are now able to return a list of GTIN values for RFID labelled units of an item:
- GET /stores/{storeId}/items
- GET /items
- GET /items/{itemId}
- The following endpoints received minor documentation changes:
- POST /invoices/ocr
- POST /items/{itemId}/images
- POST /recipes/{recipeId}/images
- An "invoiceDate" has been added to schemas for accounting models.
- Required ID and quantity properties are now enforced for CommDocLine schemas.
- The following required properties are now enforced for transfer schemas:
- due
- fromStore
- lines
- toStore
- API system internals now default to dotNet version 8 instead of version 6.