List orders with filtering, sorting, search and pagination

GEThttps://api.testingapis.com/api/OrdersSign in to see this endpoint's URL

Common filters: userId, status. Any other property name also works as an exact, case-insensitive filter. Paging and sorting: limit (1-100), page (1-based, needs limit), offset, sort (property name), order (asc or desc) and q (search across title, name, body, description and text fields). Totals are returned in the X-Total-Count, X-Page, X-Per-Page and X-Total-Pages headers.

Responses

200: The matching orders.
500: Unexpected server error.

Example

Request

curl -X GET "https://api.testingapis.com/api/Orders?limit=2" \
  -H "X-TestingApis-Key: YOUR_API_KEY"

Response200 OK

X-Total-Count: 15
X-Page: 1
X-Per-Page: 2
X-Total-Pages: 8

[
  {
    "id": 1,
    "userId": 101,
    "items": [{"productId": 8, "title": "Running Sneakers", "quantity": 1, "price": 89.99}],
    "total": 89.99,
    "status": "delivered",
    "shippingAddress": {
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
… (3 more lines)

The parameters, request and response examples and the live Try it panel for this endpoint are for signed-in members. Accounts are free and take a few seconds to create.

Try itSign-in requiredUses your key

api.testingapis.com

curl 'https://api.testingapis.com/api/Orders?limit=2' \
  -H 'X-TestingApis-Key: YOUR_API_KEY'

const res = await fetch("https://api.testingapis.com/api/Orders?limit=2", {
  headers: {
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
console.log(res.status, await res.text());

const res = await fetch("https://api.testingapis.com/api/Orders?limit=2", {
  headers: {
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
const body: string = await res.text();
console.log(res.status, body);

import requests

res = requests.get(
    "https://api.testingapis.com/api/Orders?limit=2",
    headers={
        "X-TestingApis-Key": "YOUR_API_KEY",
    },
)
print(res.status_code, res.text)

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.testingapis.com/api/Orders?limit=2");
request.Headers.TryAddWithoutValidation("X-TestingApis-Key", "YOUR_API_KEY");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.testingapis.com/api/Orders?limit=2"))
                .header("X-TestingApis-Key", "YOUR_API_KEY")
                .GET()
                .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.testingapis.com/api/Orders?limit=2", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-TestingApis-Key", "YOUR_API_KEY")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.StatusCode, string(data))
}

GEThttps://api.testingapis.com/api/Orders?limit=2

List orders with filtering, sorting, search and pagination

Responses

Example

Related