List notes across all orders

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/notes?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderNoteList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<OrderNoteList> response = client.orders().getOrdersNotes(Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Orders.GetOrdersNotesAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Orders().GetOrdersNotes(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "attachments": [
        {
          "uuid": "<string>",
          "filename": "<string>",
          "content_type": "<string>",
          "size": 123,
          "href": "<string>"
        }
      ],
      "content": "<string>",
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "created_on": "<string>",
      "group": "<unknown>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "last_updated_on": "<string>",
      "object": "<string>",
      "order": {
        "href": "<string>",
        "id": "<string>",
        "object": "<string>"
      },
      "user": "<unknown>",
      "version": 123,
      "watchers": [
        {
          "email": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ]
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

GET

orders

notes

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/notes?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderNoteList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<OrderNoteList> response = client.orders().getOrdersNotes(Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Orders.GetOrdersNotesAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Orders().GetOrdersNotes(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "attachments": [
        {
          "uuid": "<string>",
          "filename": "<string>",
          "content_type": "<string>",
          "size": 123,
          "href": "<string>"
        }
      ],
      "content": "<string>",
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "created_on": "<string>",
      "group": "<unknown>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "last_updated_on": "<string>",
      "object": "<string>",
      "order": {
        "href": "<string>",
        "id": "<string>",
        "object": "<string>"
      },
      "user": "<unknown>",
      "version": 123,
      "watchers": [
        {
          "email": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ]
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

This listing is not limited to one order. The records are under data, and pagination holds the cursor for the next page.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

cursor

string

The next_cursor from the previous page, to fetch the page after it.

sort

string

The field to sort by. Prefix it with - to sort in descending order.

Example:

"-created_on"

Response

200 - application/json

One page of notes, under data.

data

object[]

Show child attributes

object

string

pagination

object

Cursor paging for the listing.

Show child attributes

url

string

Guides

API reference

Authorizations

Query Parameters

Response