Powered by Redocly

Combined Cargo Delay Policy API (1.0.1)

Download OpenAPI specification:Download

Get an instant quote for cargo delay

This endpoint will provide a quote for a given shipment. The quote will be valid for 1 hour. Indicate whether it is an air or maritime shipment and provide the necessary details. The response will include the premium amount, the available limit, the expiration time of the quote, and the quote ID to be used for binding. For Air shipments, either the AWB number or the flight number is required. For Maritime shipments, either the container ID or the Bill of Lading, and carrier code are required. Must provide the customer details: for new customers, an ID and company Name and country of domicile are required. For existing customers, provide the customer ID or name only.

SecurityAPIKeyHeader
Request
Request Body schema: application/json
required
transportMode
required
string
Enum: "air" "maritime"
required
AirShipment (object) or MaritimeShipment (object)
customerEmail
string

Email of the insured customer

customerName
required
string

Name of the insured customer

customerId
string

ID of the insured customer (either Name or ID is required for existing customers)

customerCountry
string

Country of domicile of the insured customer (required for first time customers)

commodityType
string

Type of commodity being insured

markupRate
number <float>

Markup percentage for the policy (e.g. 0.4)

listPremium
number <currency>

If end customer will be shown a specific premium, include it here (dollar amount e.g. 140)

Responses
200

Successful quote provided

400

Bad request for quote

401

Unauthorized request

404

Shipment not found

post/quote
Request samples
application/json
{
  • "transportMode": "air",
  • "shipment": {
    },
  • "customerEmail": "string",
  • "customerName": "string",
  • "customerId": "string",
  • "customerCountry": "string",
  • "commodityType": "string",
  • "markupRate": 0,
  • "listPremium": 0
}
Response samples
application/json
{
  • "quoteId": "string",
  • "shipment": {
    },
  • "availableLimit": 0,
  • "premiumRate": 0,
  • "premiumAmount": 0,
  • "markupRate": 0,
  • "insuredName": "string",
  • "expires": "2019-08-24T14:15:22Z"
}

Bind coverage with a given quote using the ID provided in the /quote response

SecurityAPIKeyHeader
Request
Request Body schema: application/json
required
quoteId
required
string
Responses
200

Policy successfully bound

400

Bad request, must have existing quote

401

Unauthorized request

404

Quote not found

post/policy/bind
Request samples
application/json
{
  • "quoteId": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "status": "string",
  • "shipment": {
    },
  • "insuredName": "string",
  • "premiumAmount": 0
}

Get policy certificate using the policy ID provided in the /policy/bind response

SecurityAPIKeyHeader
Request
query Parameters
policyId
required
string

The id of the policy to retrieve the certificate for

Responses
200

Certificate of Insurance PDF

400

Bad request, must have existing policy

401

Unauthorized request

404

Policy not found

get/policy/certificate