Register an insured order

Register an order for shipping-insurance coverage, spending the offer_id returned by a quote. The offer token is single-use, and Mulberry derives the insured value from the order breakdown rather than accepting it from the caller. Re-registering the same external_order_id returns the existing policy instead of creating another.

Payload validation runs before token resolution:

  • No Authorization header, invalid body — 400
  • No Authorization header, valid body — 401
  • Authorization header with an unrecognized token — 401, whatever the body

Mulberry derives the coverage amount rather than accepting it: min(order_items_subtotal - premium, quoted_value) + min(order_shipping + order_tax, quoted_value). Each half is capped at the quoted value independently, so coverage can exceed what you quoted — the ceiling is twice quoted_value. An order_items_subtotal that omits the premium under-insures the order rather than failing, and one at or below the premium is rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Your order ID. Use it to look the policy up later.

string
required

Signed offer token from the quote call

string
required
Defaults to 2.50

Premium quoted for this order. Must match the quote.

string
required
Defaults to 252.50

Item subtotal including the premium.

string
required
Defaults to 9.99

Shipping charged on the order

string
required
Defaults to 21.45

Tax charged on the order

customer
object

Customer details. This writes to the customer record Mulberry holds for that email address, not just to this policy: every field is overwritten, and a field you omit is cleared. Send the customer's full details each time, or omit the object entirely to leave the existing record alone. Supplying it also emails the customer a purchase confirmation, and a customer new to Mulberry receives an account-registration email. billing_country and billing_zip are validated together — supplying either one alone fails, and US and CA postal formats are enforced while other countries pass through unchecked.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json