LogoLogo
API Specification
  • Introduction
  • Integration Checklist
  • Common Use Cases
    • Events / Tickets
    • Travel / Accomodation
    • Property / Renters
    • Parcel / Shipping
    • Product / Retail
  • API Authentication
  • Idempotency Keys
  • Rate Limits
  • Purchase Workflow Overview
    • Quote Request for Policies
      • Fast Quote (Optional)
      • Displaying the Quote
      • JS based offer display
    • Payment Process
      • Single Payment
      • Dual Payment
    • Booking
      • Instant Booking
    • Insurance Opt-Out
  • Cancellation Workflow
  • Modification Workflow
  • Renewal Workflow
  • Instalments Workflow
  • Claim
  • Policy Management
  • XCover Quote Package State
  • API Responses
    • Quote/Policy Status
    • Error Management
    • Error Types
  • Data Formats
  • Webhooks
  • Apple Private Relay
  • FAQs
    • Events / Tickets FAQs
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Common Use Cases

Parcel / Shipping

Total Shipping Insurance - Offered to Merchants or Consumers

PreviousProperty / RentersNextProduct / Retail

Last updated 4 years ago

Was this helpful?

Shipping services and platforms offering parcel shipping, or marketplaces connected to 3rd party logistics services (3PL's) can enable the offer and or attachment of parcel insurance policies in the purchase path. Commonly, partners will integrate XCover using two key purchase process API calls: and . See a collection of common requests for this integration type. Many integrations follow the below high level flow of events:

1. User creates a shipment order 3. Partner platform sends a to the create quote endpoint 4. User selects insurance option/s 5. User pays for shipment and insurance - this is often a debit of merchants shipping account wallet 6. Partner sends a to the create booking endpoint 7. Confirmation of the coverage is presented to the user

Post sale processes

In the event that a shipment label is not collected, and rendered void by the platform (within appropriate timeframes) the policy booking may be cancelled.

Cancellation
💡
create quote
create booking
quote package payload
booking request payload