List Orders (Analytics)

curl --request GET \
  --url https://api-ai.textyess.com/analytics/orders \
  --header 'x-auth-token: <api-key>'

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://api-ai.textyess.com/analytics/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-ai.textyess.com/analytics/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api-ai.textyess.com/analytics/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-auth-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-ai.textyess.com/analytics/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439020",
      "cms_id": "ord_12345",
      "order_number": "1001",
      "total": 89.99,
      "items_number": 2,
      "paid": true,
      "createdAt": "2024-01-15T14:30:00.000Z",
      "conversation": {
        "_id": "507f1f77bcf86cd799439021",
        "phone": "+393331234567"
      }
    }
  ],
  "pagination": {
    "total": 450,
    "perPage": 10,
    "page": 0
  }
}

{
  "message": "Unauthorized"
}

GET

analytics

orders

List Orders (Analytics)

curl --request GET \
  --url https://api-ai.textyess.com/analytics/orders \
  --header 'x-auth-token: <api-key>'

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://api-ai.textyess.com/analytics/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-ai.textyess.com/analytics/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api-ai.textyess.com/analytics/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-auth-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-ai.textyess.com/analytics/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439020",
      "cms_id": "ord_12345",
      "order_number": "1001",
      "total": 89.99,
      "items_number": 2,
      "paid": true,
      "createdAt": "2024-01-15T14:30:00.000Z",
      "conversation": {
        "_id": "507f1f77bcf86cd799439021",
        "phone": "+393331234567"
      }
    }
  ],
  "pagination": {
    "total": 450,
    "perPage": 10,
    "page": 0
  }
}

{
  "message": "Unauthorized"
}

Overview

The list orders endpoint returns a paginated list of TextYess-attributed orders. You can filter by date range and optionally by type (e.g. WhatsApp AI assistant, onsite AI assistant, or all). Results can be sorted by various keys.

Authentication

This endpoint requires a valid JWT token in the x-auth-token header. You can find your token in the Developers section:

x-auth-token: your_jwt_token

Query Parameters

string

Start date for filtering orders (ISO 8601).

string

End date for filtering orders (ISO 8601).

string

Sort direction: 1 for ascending, -1 for descending. Defaults to -1.

string

Field to sort by: createdAt, name, title, total_messages, cost, revenue, orders_number, campaign_conversion_rate, average_cart, roas.

string

Filter by order source: whatsapp-ai-assistant (WhatsApp AI), onsite-ai-assistant (onsite widget), or omit for all attributed orders.

string

required

Page number (0-based). Use 0 for the first page.

string

required

Number of items per page. Must be at least 1.

Response

The response has two top-level keys: data (array of order objects) and pagination. Each order in data includes order fields (e.g. cms_id, order_number, total, items_number, paid, createdAt) and a populated conversation when available.

array

Array of order documents (TextYess-attributed orders).

object

Pagination metadata: total (total count), perPage, page.

{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439020",
      "cms_id": "ord_12345",
      "order_number": "1001",
      "total": 89.99,
      "items_number": 2,
      "paid": true,
      "createdAt": "2024-01-15T14:30:00.000Z",
      "conversation": {
        "_id": "507f1f77bcf86cd799439021",
        "phone": "+393331234567"
      }
    }
  ],
  "pagination": {
    "total": 450,
    "perPage": 10,
    "page": 0
  }
}

{
  "message": "Unauthorized"
}

Get Started

Shopify

WooCommerce

Magento

Guides

Flows

Flows API

Orders API

Products API

Campaigns API

Analytics API

List Orders (Analytics)

Overview

Authentication

Query Parameters

Response

​Overview

​Authentication

​Query Parameters

​Response

Overview

Authentication

Query Parameters

Response