API Calls for Archived Orders

The Admin API getOrderForOrderId() populates the ArchivedOrders attribute of the AdminOrder .

On the storefront side when calling the saveOrderWithOptions() API call, in the SaveOrderOptions object you can set the id of the order to be archived. When this is set, the KonaKart engine links the order being saved with the order being archived with a unique id.

Still on the storefront side, when retrieving an order using the getOrderWithOptions() API call, the archivedOrders attribute is populated if you set the populateArchivedOrdersAttribute to true on the FetchOrderOptions object. When retrieving multiple orders using the searchForOrdersPerCustomer() API call you must set the populateArchivedOrdersAttribute in the OrderSearch object to populate the archivedOrders attribute of the returned orders.