Retrieve an order's custom object instance

GET

orders

{order_id}

custom_objects

{custom_object_id}

instances

{instance_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/custom_objects/co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b/instances/coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.orders.get_order_custom_object_instance(
    "ORD-0001",
    "co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b",
    "coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.orders.getOrderCustomObjectInstance(
    'ORD-0001',
    'co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b',
    'coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->orders->getOrderCustomObjectInstance(
    'ORD-0001',
    'co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b',
    'coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b',
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.orders().getOrderCustomObjectInstance(
        "ORD-0001",
        "co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b",
        "coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Orders.GetOrderCustomObjectInstanceAsync(
    "ORD-0001",
    "co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b",
    "coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.orders.getOrderCustomObjectInstance(
  'ORD-0001',
  'co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b',
  'coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b',
);
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().GetOrderCustomObjectInstance(context.Background(), "ORD-0001", "co_4f1c9a2e7b3d4e6f8a0b1c2d3e4f5a6b", "coi_9a8b7c6d5e4f40312a1b2c3d4e5f6a7b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Pass the order’s id, the custom object’s id and the instance’s id.

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.

Path Parameters

order_id

string

required

The order's id, as GET /orders lists it.

custom_object_id

string

required

The custom object's id, which starts with co_.

instance_id

string

required

The custom object instance's id, which starts with coi_.

Response

200

The custom object instance.

Guides

API reference

Retrieve an order's custom object instance

Authorizations

Path Parameters

Response