Listing and Pagination

The orders endpoint allows you to retrieve your orders with support for pagination using an offset. This enables you to efficiently navigate through large sets of orders. The endpoint supports per_page and offset query parameters. To retrieve orders with pagination, you must provide a valid API key.

Retrieving a list of orders with a set per page limit

JavaScript

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();
}

Python

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, pagination

PHP

$apiKey = "YOUR_API_KEY";
$perPage = 16;

function get_orders($perPage, $apiKey) {
    $url = "https://api.autoenhance.ai/v3/orders?per_page=$perPage";

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $apiKey",
            'method'  => 'GET'
        )
    );

    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error fetching orders';
    }

    $orders_data = json_decode($result, true);
    return $orders_data;
}

cURL

curl -X GET \
  'https://api.autoenhance.ai/v3/orders?per_page=16' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

As you can see, the response returns an orders, and pagination object. The orders object contains the list of your orders, and pagination contains two values: per_page, and next_offset.

Retrieving a paginated list of orders

If you want to load more orders with a pagination (next batch of orders without the initial orders that you've already fetched), you will need to use the next_offset value in your next request.

The value next_offset is returned from in the object that is returned from retrieving a list of orders with a set per page limit

JavaScript

const apiKey = "YOUR_API_KEY";
const pagination = { per_page:16, next_offset:"string" };

const loadMoreOrders = async (perPage, nextOffset, apiKey) => {
    const loadMoreOrdersResponse = await fetch(
      `https://api.autoenhance.ai/v3/orders?per_page=${perPage}&offset=${nextOffset}`,
      { 
        method: "GET",
        headers:{
          "x-api-key": apiKey,  
        }
      }
    );

    const { orders, pagination } = await getOrdersResponse.json();
}

Python

import requests

api_key = "YOUR_API_KEY"
per_page = 16
next_offset = "string"

def load_more_orders(per_page, next_offset, api_key):
    url = f"https://api.autoenhance.ai/v3/orders?per_page={per_page}&offset={next_offset}"
    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, pagination

PHP

$apiKey = "YOUR_API_KEY";
$perPage = 16;
$nextOffset = "";

function load_more_orders($perPage, $nextOffset, $apiKey) {
    $url = "https://api.autoenhance.ai/v3/orders?per_page=$perPage&offset=$nextOffset";

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $apiKey",
            'method'  => 'GET'
        )
    );

    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error loading more orders';
    }

    $response_data = json_decode($result, true);
    return $response_data;
}

cURL

curl -X GET \
  'https://api.autoenhance.ai/v3/orders?per_page=16&offset=' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Important note The response will always return pagination object with values that will enable you to fetch next batch of orders if you still have more orders to fetch.

Specification

List Orders

Lists the orders for the current user.

GEThttps://api.autoenhance.ai//v3/orders/

Authorization

ApiKeyAuth

Query parameters

Response

200401422

Successful response

Body

application/json

ordersarray of OrderOut (object)

paginationPagination (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.autoenhance.ai//v3/orders/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401422

{
  "orders": [
    {
      "created_at": "2024-11-21T06:29:56.744Z",
      "images": [
        {
          "ai_version": "text",
          "brightness_boost": "NONE",
          "brightness_boost_external": "NONE",
          "brightness_boost_internal": "NONE",
          "clarity_level": "NONE",
          "cloud_type": "CLEAR",
          "contrast_boost": "NONE",
          "contrast_boost_external": "NONE",
          "contrast_boost_internal": "NONE",
          "denoise_level": "NONE",
          "downloaded": false,
          "enhance": true,
          "enhance_type": "property",
          "image_id": "123e4567-e89b-12d3-a456-426614174000",
          "image_name": "text",
          "image_type": "text",
          "lens_correction": true,
          "order_id": "text",
          "privacy": false,
          "saturation_level": "NONE",
          "scene": "text",
          "sharpen_level": "NONE",
          "sky_replacement": false,
          "status": "waiting",
          "user_id": "text",
          "vertical_correction": false,
          "window_pull": false
        }
      ],
      "is_merging": false,
      "last_updated_at": "2024-11-21T06:29:56.744Z",
      "name": "text",
      "order_id": "text",
      "status": "waiting"
    }
  ],
  "pagination": {
    "next_offset": "text"
  }
}