Update in methods for obtaining a list of orders, deliveries, reserves and banquets
In API V7, we have made changes to the methods for obtaining a list of orders, deliveries, reservations and banquets. Including methods for obtaining entity data from a known revision.
Getting a complete list of all entities:
- The method for receiving reservations/banquets has not changed —
GetReserves
, which returns them in any status; - The method for obtaining a general list of orders (regular and delivery) has changed —
GetOrders
, which now has optional parameters:includeDeleted
— include orders in the result statusDeleted
, which were not included before;excludeDeliveryOrders
— exclude delivery orders from the results.
- The method for obtaining a list of delivery orders has changed (separate from regular ones) —
GetDeliveryOrders
, which has an optional parameter:includeDeleted
— include uncanceled deliveries in the results (delivery status !=Cancelled
) and their orders in statusDeleted
, which were previously enabled by default.
The principle of obtaining entities by revision has changed.
Previously, you could only get delivery orders and only a list of objects.
The fact is that in addition to deleted orders in the Deleted
status, there are also irrevocably deleted orders, of which only id
remains and only at the Main Terminal.
Such permanently deleted orders are obtained by dividing the order by 2FR.
Now, when retrieving entities from a known revision, an object
ChangedEntities<T>
is returned,
which includes list of changed entities
and maximum revision entities from the list.
The changed entity itself
ChangedEntity<T>
— this is the id
and the object if this object has not been permanently deleted.
Retrieving changed entities by known revision:
GetChangedOrders
— receiving modified orders;GetChangedDeliveryOrders
— receiving modified deliveries;GetChangedReserves
— receiving modified reservations/banquets.