1

Closed

Change paging implementation to allow other keys

description

3.0 and 3.1 paging uses the last order number to keep track of which orders need to be sent in GetNewOrders and GetOrdersByRange. Two custom implementors want to use a different key (date/time of last call).
Closed Feb 13, 2009 at 6:32 AM by afmiller
Implemented in 3.2.

comments

afmiller wrote Dec 4, 2008 at 6:32 PM

Changed GetNewOrders and GetOrdersByRange in 3.2 to return an OrderResultsPage instead of an OrderResult array. The OrderResultsPage includes a PageKey and the OrderResult array. The PageKey is stored by Shipper and passed back to GetNewOrders and GetOrdersByRange. The PageKey replaces LastOrderNumber which was used to implement paging in 3.0 and 3.1. The PageKey is a string and can be anything that the ShippingAgent implementation can use to determine where it left off last time it was called. For example, it can be the last order number, or the last time. The later can be used to retrieve orders that have changed status since the last time if the underlying platform tracks order status changes.

wrote Dec 4, 2008 at 6:37 PM

wrote Feb 13, 2009 at 6:32 AM

wrote Feb 13, 2013 at 2:07 AM

wrote May 15, 2013 at 2:16 AM