Update standard API module settings
POST /api/v5/bookings/v4/set_api_settings
Saves the standard API module settings for the key (titles, default dimensions, sync flags, enabled couriers, pickup warehouse). When “authtype” is “Email and Password” a new API key is created and returned; otherwise the response is true. Requires an API key.
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”object
Authentication type for the integration.
Domain of the site making requests with this key.
Label shown to buyers for the shipping method.
Default sender address type, “business” or “residential”.
Default parcel height in cm.
Default parcel width in cm.
Default parcel length in cm.
Default parcel weight in kg.
Whether order syncing is enabled.
Earliest order date (YYYY-MM-DD) to import when syncing.
How many quotes to display, or the quote-display mode.
Flat surcharge added to quoted prices, in AUD.
Measurement unit system, e.g. metric.
Whether the grouped-box packing option is enabled.
Default box size preset used for grouped packing.
Pickup postcodes (4-digit AU) configured for this key.
Per-postcode address type entries, paired with the postcode list.
Responses
Section titled “ Responses ”Settings saved, or a new API key when email/password auth creates one
Missing or invalid API key
object
Human-readable settings error message.
API key not found
object
Human-readable settings error message.