API key configuration

Returns everything that governs how an API key behaves: its identity and demo flag, the complete module-settings blob (including order boxing and which couriers are displayed), pickup warehouses, and any margin/markup and package-type rules. This is the single call to introspect a key’s setup — the curated /api_details endpoint returns only a subset.

Endpoints

Path	Where it works
`GET /api/bookings/v4/api_details`	v4 and v5 — curated subset (titles, default dimensions, quote display, surcharge, sync flags, enabled couriers).
`GET /api/bookings/v4/api_details/full`	v5 only (`https://api.transdirect.com.au`) — full key identity, complete `module_setting` blob, warehouses, margin rules, package-type rules. Not available on the PHP v4 host.

# Curated settings (v4 or v5)
GET /api/bookings/v4/api_details

# Full configuration (v5 only)
GET /api/v5/bookings/v4/api_details/full

Authentication

Response

Field	Type	Description
`api_key`	object	Key identity: `id`, `member_id`, `status`, `demo_mode`, `module_type_id`, `site_domain`, `created`.
`module_setting`	object	The full settings blob — display preferences, per-courier surcharge/markup config, and order-boxing (`multipickup`, `minimum_fill_percent`, `box_length`, `box_width`, `box_height`, `box_weight`).
`module_setting.enabled_courier`	array	The courier identifiers displayed for this key.
`module_setting.quote_diplay`	string	Quote display mode, e.g. `display_all`. (`quote_diplay` is a long-standing misspelling in the underlying schema — the key really is spelled this way, not `quote_display`.)
`warehouses`	array	Pickup warehouses configured for the member.
`rules`	array	Margin/markup rules, each with the couriers they apply to.
`package_type_rules`	array	Weight-to-package-type rules.

Order boxing

When order boxing is enabled, module_setting carries the box dimensions and fill settings used to consolidate order items into cartons before quoting. See Order boxing for how these are applied.

Example

# Curated settings on v4
curl -H "Api-key: YOUR_API_KEY" \
  https://www.transdirect.com.au/api/bookings/v4/api_details

# Full configuration on v5
curl -H "Api-key: YOUR_API_KEY" \
  https://api.transdirect.com.au/api/v5/bookings/v4/api_details/full

import { client, getApiV5BookingsV4ApiDetailsFull } from '@transdirect/api-sdk';

client.setConfig({ baseUrl: 'https://api.transdirect.com.au', headers: { 'Api-Key': KEY } });
const { data } = await getApiV5BookingsV4ApiDetailsFull();
console.log(data?.api_key.demo_mode, data?.module_setting.enabled_courier);

See the fully-typed request/response in the API Explorer (left sidebar), and a runnable script at examples/end-to-end/ts/src/09-api-config.ts.