Update on Methods for Retrieving Lists of Orders, Deliveries, Reserves, and Banquets
In API version V7, we made changes to the methods for retrieving lists of orders, deliveries, reserves, and banquets. This includes changes to the methods for retrieving entity data by known revision.
Retrieving the complete list of all entities:
- The method for retrieving the list of reserves / banquets has not changed —
GetReserves, which returns them in any status; - The method for retrieving the general list of orders (regular and delivery) has changed —
GetOrders, which now has optional parameters:includeDeleted— include in the result orders in statusDeleted, which were previously not included;excludeDeliveryOrders— exclude delivery orders from the result.
- The method for retrieving the list of delivery orders (separately from regular ones) has changed —
GetDeliveryOrders, which now has an optional parameter:includeDeleted— include in the result non-cancelled deliveries (delivery status !=Cancelled) and their orders in statusDeleted, which were previously included by default.
The principle of retrieving entities by revision has changed.
Previously, it was only possible to retrieve delivery orders and only a list of objects.
The thing is, besides deleted orders in the Deleted status, there are also irreversibly deleted orders, of which only the id remains and only on the Main terminal.
Such irreversibly deleted orders occur when splitting an order into 2FR.
Now, when retrieving entities by known revision, an object
ChangedEntities<T>
is returned, which contains a list of changed entities
and the maximum revision of the entities in the list.
The changed entity itself
ChangedEntity<T>
is the id and the object, if this object has not been irreversibly deleted.
Retrieving changed entities by known revision:
GetChangedOrders— retrieving changed orders;GetChangedDeliveryOrders— retrieving changed deliveries;GetChangedReserves— retrieving changed reserves / banquets.