Get the full configuration bound to an API key

GET

/api/v5/bookings/v4/api_details/full

• Production

Unlike /api_details (a curated subset), returns the key identity, the complete module_setting blob, pickup warehouses, margin/markup rules and weight-to-package-type rules.

Authorizations

• ApiKeyAuth

Responses

200

Full API key configuration

object

api_key

required

Identity and status of the API key.

object

id

required

API key identifier.

number

member_id

required

Member who owns this API key.

number

status

required

Whether the key is currently active.

boolean

demo_mode

required

Whether the key operates in no-charge demo mode.

boolean

module_type_id

required

Module type identifier for the integration (e.g. platform type).

number

nullable

site_domain

required

Site domain registered for this key.

string

nullable

created

required

ISO 8601 timestamp the key was created.

string

nullable

module_setting

required

Complete raw module_setting blob controlling quote/booking behaviour.

object

key

additional properties

nullable

warehouses

required

Configured pickup warehouses for this key.

Array<object>

object

id

required

Warehouse (pickup location) identifier.

number

suburb

required

Warehouse suburb.

string

nullable

postcode

required

Warehouse 4-digit AU postcode.

string

nullable

state

required

Warehouse state code (e.g. NSW, VIC).

string

nullable

type

required

Warehouse address type, “business” or “residential”.

string

nullable

created

required

ISO 8601 timestamp the warehouse was created.

string

nullable

rules

required

Margin/markup rules applied to quotes.

Array<object>

object

id

required

Margin/markup rule identifier.

number

module_id

required

API module/key this rule belongs to.

number

nullable

type

required

Rule type, e.g. margin or markup.

string

nullable

trigger_comparison

required

Comparison operator that decides when the rule fires (e.g. “gt”, “lte”).

string

nullable

trigger_value

required

Threshold value the trigger comparison is evaluated against.

string

nullable

action_operator

required

Operator applied by the action (e.g. add, multiply, percent).

string

nullable

action_value

required

Value applied by the action operator.

string

nullable

trigger_description

required

Human-readable description of the trigger condition.

string

nullable

action_description

required

Human-readable description of the action taken.

string

nullable

created

required

ISO 8601 timestamp the rule was created.

string

nullable

priority

required

Evaluation priority; lower numbers are applied first.

number

nullable

couriers

required

Courier string_ids this rule is scoped to; empty means all couriers.

Array<string>

package_type_rules

required

Weight-to-package-type mapping rules.

Array<object>

object

id

required

Package-type rule identifier.

number

package_type

required

Package type assigned when the range matches (e.g. “Carton”, “Pallet”).

string

nullable

base_on

required

Metric the range is measured against, e.g. “weight”.

string

nullable

range_from

required

Lower bound of the matching range (inclusive), in the base_on unit.

number

nullable

range_to

required

Upper bound of the matching range (inclusive), in the base_on unit.

number

nullable

401

Missing or invalid API key

object

error

required

Human-readable settings error message.

string

404

API key not found

object

error

required

Human-readable settings error message.

string