Skip to content

Get standard API module settings

GET
/api/v5/bookings/v4/api_details

Returns the curated subset of the standard API module settings bound to the API key: titles, default parcel dimensions/weight, quote display, surcharge, order-sync flags and enabled couriers. Requires an API key.

Standard API settings

object
module_id
required
Any of:
string
module_title
required
Any of:
string
shipping_title
required
Any of:
string
street_type
required
Any of:
string
default_height
required
Any of:
string
default_width
required
Any of:
string
default_lenght
required
Any of:
string
default_weight
required
Any of:
string
enable_sync
required
Any of:
string
sync_from_date
required
Any of:
string
quote_diplay
required
Any of:
string
surcharge_amount
required
Any of:
string
enabled_courier
required
Any of:
string
mode
required
Any of:
string
sync_all_order
required
Any of:
string

Missing or invalid API key

object
error
required

Human-readable settings error message.

string

API key not found

object
error
required

Human-readable settings error message.

string