Guides
API examples

Record a shipment

post
https://partner.getmulberry.com/api/v2/shipping-insurance/shipments

Record the shipment for an insured order, which puts the policy in force. Identify the policy by policy_uuid or by the external_order_id you registered. Re-sending the same tracking number is safe; a different one on an already-shipped policy is rejected.

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

Identify the policy with either policy_uuid or external_order_id. Supplying neither is rejected.

uuid

Policy to record against. Supply this or external_order_id. Takes precedence if both are supplied — the two are not cross-checked.

string

Your order ID, if you'd rather not track the policy UUID. Supply this or policy_uuid — one of the two is required.

string
required

Carrier tracking number

string
required

Shipping carrier

string
required

Date the parcel shipped

string
Defaults to 0.00

Shipping cost, if you record it

string
Defaults to 3

Provider carrier identifier

origin_address
object

Where the parcel is shipped from. Omitted subfields are sent to the carrier as empty values, and an omitted country is sent as US.

destination_address
object

Where the parcel is going to. Omitted subfields are sent to the carrier as empty values, and an omitted country is sent as US.

customer
object

Recipient details

Responses

Updated 1 day ago

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

Updated 1 day ago