Retrieving an order

Under rare circumstances, a need to fetch an archived order from Archive Service might arise. Sometimes, when you attempt to search for an order that is already archived, Sterling Order Management System Software might need to display more details of the order than stored as summary in the search index repository.

By using an appropriate template, you can fetch the complete order details from the order archive storage. If the order details are stored with some entities, such as OrderLine as a separate part, you can retrieve the order data by limiting the number of rows of the separate parts. To limit the number of rows fetched, you can provide the limit attribute as a parameter in the template. If the limit parameter that is used to fetch a restricted number of rows is too small for the chunk size of the stored order part, the default behavior of retrieval from Archive Service is such that no row is returned. This default behavior is to ensure that the size of the data in the response does not exceed the requested size under any circumstances. However, it provides a capability to fetch data beyond the provided limit parameter, if needed. It can proactively fetch the top-most available row for the order part based on the configurable order_archive_bypass_retrieve_limit property. If this property allows retrieving data beyond the limit parameter that is specified in the request, the first row of that order part is obtained. If this property does not allow bypassing the specified limit parameter, no rows are returned. Instead, the retrieve operation computes and displays an attribute. The attribute indicates the minimum value that is required to be used as limit parameter for retrieval operation of the specified order parts in the input.

It is also possible to learn whether more data is available beyond the initial retrieval for each order part in the input. If so, this information can then be used to retrieve the remaining rows of data for these separate parts in a paginated fashion. If other entities are archived as separate parts such as OrderAudit, you can retrieve these parts separately. If the data exists, the retrieval operation provides the capability to fetch previous pages.

You can fetch an order from Archive Service by passing the order identifiers.