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.

The token is checked before the payload, so a missing, unrecognized or malformed Authorization header returns 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.

Retailer-paid orders. With retailer_paid: true there is no quote: the insured value is the item subtotal plus shipping and tax (shipping and tax capped at the item subtotal), the customer premium is recorded as $0, and no order email is sent to the shopper. offer_id and premium must be omitted and customer must carry an email. Errors: 400 Retailer-paid registration is not enabled for this retailer, 400 Field required when retailer_paid (customer), 400 must be omitted when retailer_paid (offer_id, premium), and 409 Order already registered with a different payer when an external_order_id was first registered the other way.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
Defaults to false

Set true when you are buying protection on the shopper's behalf. No quote is needed, the customer premium records as $0, Mulberry sends the shopper no order email (a claim they file is still confirmed by email), and customer becomes required. Available once Mulberry enables it on your account.

string
required

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

string

Signed offer token from the quote call. Required unless retailer_paid; must be omitted when it is.

string
Defaults to 2.50

Premium the shopper paid. Must match the quote. Required unless retailer_paid; must be omitted when it is.

string
required
Defaults to 252.50

Item subtotal as charged — with the premium line still in it when the shopper paid for protection.

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 non-null field you send is overwritten; fields you omit or send as null are left as they were. Omit the object entirely to leave the record alone. On a customer-paid registration, supplying it also emails the customer a purchase confirmation, and a customer new to Mulberry receives an account-registration email. A retailer-paid registration sends the customer nothing. 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. Required when retailer_paid.

Responses

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