Listing and Pagination
Retrieving a list of orders with a set per page limit
const apiKey = "YOUR_API_KEY";
const perPage = 16;
const getOrders = async (perPage, apiKey) => {
const getOrdersResponse = await fetch(
`https://api.autoenhance.ai/v3/orders?per_page=${perPage}`,
{
method: "GET",
headers:{
"x-api-key": apiKey,
}
}
);
const { orders, pagination } = await getOrdersResponse.json();
}import requests
api_key = "YOUR_API_KEY"
per_page = 16
def get_orders(per_page, api_key):
url = f"https://api.autoenhance.ai/v3/orders?per_page={per_page}"
headers = {
"x-api-key": api_key
}
response = requests.get(url, headers=headers)
response_data = response.json()
orders = response_data.get('orders')
pagination = response_data.get('pagination')
return orders, paginationRetrieving a paginated list of orders
Specification
Lists the orders for the current user with optional search and sorting.
Query Parameters:
- q: Free-text search term applied to order name
- sort: Sorting key (name, -name, date, -date). Defaults to -date (most recent first)
- offset: Pagination offset token
- per_page: Number of items per page
The offset token used to indicate which page of results to use.
0The amount of items to be loaded per page of results. The final response may have a smaller number than requested if too large.
5Free-text search term applied to order name. If omitted or empty, no search filter is applied.
nullSorting key with optional '-' prefix for descending order. Allowed values: 'name' (sort by name ascending), '-name' (sort by name descending), 'date' (sort by created_at ascending), '-date' (sort by created_at descending). If omitted or invalid, defaults to '-date' (most recent first).
-dateSuccessful response
Authentication error
Validation error
Last updated
Was this helpful?