cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/orders/preview" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"order": {
"account_id": "ACC0001",
"name": "Acme Pty Ltd monthly order",
"lines": [
{
"item_id": "ITEM-0001",
"item_order_quantity": 1
}
]
}
}'from exsited import build_client
client = build_client()
response = client.orders.preview_order(
{
"order": {
"account_id": "ACC0001",
"name": "Acme Pty Ltd monthly order",
"lines": [{"item_id": "ITEM-0001", "item_order_quantity": 1}],
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.orders.previewOrder({
order: {
account_id: 'ACC0001',
name: 'Acme Pty Ltd monthly order',
lines: [{item_id: 'ITEM-0001', item_order_quantity: 1}],
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->orders->previewOrder([
'order' => [
'account_id' => 'ACC0001',
'name' => 'Acme Pty Ltd monthly order',
'lines' => [['item_id' => 'ITEM-0001', 'item_order_quantity' => 1]],
],
]);
print_r($response->data);
import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Dto> response = client.orders().previewOrder(
Map.of(
"order", Map.of(
"account_id", "ACC0001",
"name", "Acme Pty Ltd monthly order",
"lines", List.of(Map.of("item_id", "ITEM-0001", "item_order_quantity", 1)))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Orders.PreviewOrderAsync(new Dictionary<string, object?>
{
["order"] = new Dictionary<string, object?>
{
["account_id"] = "ACC0001",
["name"] = "Acme Pty Ltd monthly order",
["lines"] = new List<object?>
{
new Dictionary<string, object?>
{
["item_id"] = "ITEM-0001",
["item_order_quantity"] = 1,
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.orders.previewOrder({
'order': {
'account_id': 'ACC0001',
'name': 'Acme Pty Ltd monthly order',
'lines': [
{'item_id': 'ITEM-0001', 'item_order_quantity': 1},
],
},
});
print(response.map);
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().PreviewOrder(context.Background(), map[string]any{
"order": map[string]any{
"account_id": "ACC0001",
"name": "Acme Pty Ltd monthly order",
"lines": []any{
map[string]any{
"item_id": "ITEM-0001",
"item_order_quantity": 1,
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
Orders
Preview an order
Checks an order body without creating the order.
POST
/
orders
/
preview
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/orders/preview" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"order": {
"account_id": "ACC0001",
"name": "Acme Pty Ltd monthly order",
"lines": [
{
"item_id": "ITEM-0001",
"item_order_quantity": 1
}
]
}
}'from exsited import build_client
client = build_client()
response = client.orders.preview_order(
{
"order": {
"account_id": "ACC0001",
"name": "Acme Pty Ltd monthly order",
"lines": [{"item_id": "ITEM-0001", "item_order_quantity": 1}],
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.orders.previewOrder({
order: {
account_id: 'ACC0001',
name: 'Acme Pty Ltd monthly order',
lines: [{item_id: 'ITEM-0001', item_order_quantity: 1}],
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->orders->previewOrder([
'order' => [
'account_id' => 'ACC0001',
'name' => 'Acme Pty Ltd monthly order',
'lines' => [['item_id' => 'ITEM-0001', 'item_order_quantity' => 1]],
],
]);
print_r($response->data);
import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Dto> response = client.orders().previewOrder(
Map.of(
"order", Map.of(
"account_id", "ACC0001",
"name", "Acme Pty Ltd monthly order",
"lines", List.of(Map.of("item_id", "ITEM-0001", "item_order_quantity", 1)))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Orders.PreviewOrderAsync(new Dictionary<string, object?>
{
["order"] = new Dictionary<string, object?>
{
["account_id"] = "ACC0001",
["name"] = "Acme Pty Ltd monthly order",
["lines"] = new List<object?>
{
new Dictionary<string, object?>
{
["item_id"] = "ITEM-0001",
["item_order_quantity"] = 1,
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.orders.previewOrder({
'order': {
'account_id': 'ACC0001',
'name': 'Acme Pty Ltd monthly order',
'lines': [
{'item_id': 'ITEM-0001', 'item_order_quantity': 1},
],
},
});
print(response.map);
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().PreviewOrder(context.Background(), map[string]any{
"order": map[string]any{
"account_id": "ACC0001",
"name": "Acme Pty Ltd monthly order",
"lines": []any{
map[string]any{
"item_id": "ITEM-0001",
"item_order_quantity": 1,
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
Send the same body as create order. No order is created, and the response holds only an empty
activity_logs under order. A body that names a new account still creates that account.
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. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.