Retrieve a booking custom object instance

GET

booking

{booking_id}

custom_objects

{custom_object_id}

instances

{instance_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/booking/BOOKING_ID/custom_objects/CUSTOM_OBJECT_ID/instances/INSTANCE_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.bookings.getBookingCustomObjectInstance('BOOKING_ID', 'CUSTOM_OBJECT_ID', 'INSTANCE_ID');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->bookings->getBookingCustomObjectInstance(
    'BOOKING_ID',
    'CUSTOM_OBJECT_ID',
    'INSTANCE_ID',
);
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.bookings().getBookingCustomObjectInstance(
        "BOOKING_ID",
        "CUSTOM_OBJECT_ID",
        "INSTANCE_ID");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Bookings.GetBookingCustomObjectInstanceAsync(
    "BOOKING_ID",
    "CUSTOM_OBJECT_ID",
    "INSTANCE_ID");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.bookings.getBookingCustomObjectInstance(
  'BOOKING_ID',
  'CUSTOM_OBJECT_ID',
  'INSTANCE_ID',
);
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.Bookings().GetBookingCustomObjectInstance(context.Background(), "BOOKING_ID", "CUSTOM_OBJECT_ID", "INSTANCE_ID", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Returns a single instance, picked by its id, of a custom object on this booking.

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

booking_id

string

required

The booking's id. Any order's id works here, whatever the order's type.

custom_object_id

string

required

The custom object's id, for a custom object used in orders (use_in is SALE_ORDER).

instance_id

string

required

The custom object instance's id.

Response

200

The custom object instance.

Guides

API reference

Retrieve a booking custom object instance

Authorizations

Path Parameters

Response