Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
mutation CreateCoverage($input: CoverageCreate!) {
createCoverage(input: $input) {
id
object
status
livemode
created
updated
shipment
connection
policy_number
insured_value {
amount
currency
}
premium {
amount
currency
}
coverage_types
period {
starts
ends
days
}
certificate
claims
}
}
{
"input": {
"quote": "example",
"shipment": "shp_1Q2w3E4r5T6y",
"connection": "conn_9f8e",
"insured_value": {
"amount": 1299,
"currency": "usd"
}
}
}
{
"data": {
"createCoverage": {
"id": "cov_1a2B3c",
"object": "coverage",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"shipment": "shp_1Q2w3E4r5T6y",
"connection": "conn_9f8e",
"policy_number": "example",
"insured_value": {
"amount": 1299,
"currency": "usd"
},
"premium": {
"amount": 1299,
"currency": "usd"
},
"coverage_types": [
"example"
],
"period": {
"starts": "example",
"ends": "example",
"days": 2
},
"certificate": "example",
"claims": [
"example"
]
}
}
}
Buy coverage
mutation CreateCoverage($input: CoverageCreate!) {
createCoverage(input: $input) {
id
object
status
livemode
created
updated
shipment
connection
policy_number
insured_value {
amount
currency
}
premium {
amount
currency
}
coverage_types
period {
starts
ends
days
}
certificate
claims
}
}
{
"input": {
"quote": "example",
"shipment": "shp_1Q2w3E4r5T6y",
"connection": "conn_9f8e",
"insured_value": {
"amount": 1299,
"currency": "usd"
}
}
}
{
"data": {
"createCoverage": {
"id": "cov_1a2B3c",
"object": "coverage",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"shipment": "shp_1Q2w3E4r5T6y",
"connection": "conn_9f8e",
"policy_number": "example",
"insured_value": {
"amount": 1299,
"currency": "usd"
},
"premium": {
"amount": 1299,
"currency": "usd"
},
"coverage_types": [
"example"
],
"period": {
"starts": "example",
"ends": "example",
"days": 2
},
"certificate": "example",
"claims": [
"example"
]
}
}
}
mutation · Module: Integrations · Requires integrations:write · Idempotency-Key header required · Spends money: confirm before calling
| Argument | Type | Description |
|---|---|---|
input | CoverageCreate | The fields for this operation. |
CoverageCreate fields| Field | Type |
|---|---|
quote | String |
shipment | String |
connection | String |
insured_value | MoneyInput |
user_metadata | UserMetadataInput |
Coverage!
| Field | Type |
|---|---|
id | String! |
object | CoverageObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
status | CoverageStatus! |
shipment | String! |
connection | String |
policy_number | String |
insured_value | Money! |
premium | Money |
coverage_types | [String!] |
period | CoveragePeriod |
certificate | String |
claims | [String!] |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation CreateCoverage($input: CoverageCreate!) {
createCoverage(input: $input) {
id
object
status
livemode
created
updated
shipment
connection
policy_number
insured_value {
amount
currency
}
premium {
amount
currency
}
coverage_types
period {
starts
ends
days
}
certificate
claims
}
}
{
"input": {
"quote": "example",
"shipment": "shp_1Q2w3E4r5T6y",
"connection": "conn_9f8e",
"insured_value": {
"amount": 1299,
"currency": "usd"
}
}
}
{
"data": {
"createCoverage": {
"id": "cov_1a2B3c",
"object": "coverage",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"shipment": "shp_1Q2w3E4r5T6y",
"connection": "conn_9f8e",
"policy_number": "example",
"insured_value": {
"amount": 1299,
"currency": "usd"
},
"premium": {
"amount": 1299,
"currency": "usd"
},
"coverage_types": [
"example"
],
"period": {
"starts": "example",
"ends": "example",
"days": 2
},
"certificate": "example",
"claims": [
"example"
]
}
}
}