Operations 4
Documentation
Documentation
https://docs.shipstation.com/apis/shipengine/docs/getting-started/get-started
APIReference
https://docs.shipstation.com/apis/shipengine/openapi
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/shipengine:shipengine-insurance-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Shipengine Insurance API
version: 1.1.202604070904
contact:
name: ShipEngine Sales & Support
email: sales@shipengine.com
url: https://www.shipengine.com/contact/
x-phone: 1-512-856-5379
license:
name: Proprietary
url: https://www.shipengine.com/terms-of-service/
termsOfService: https://www.shipengine.com/terms-of-service/
x-logo:
url: https://shipengine.github.io/img/shipengine-logo-square.png
backgroundColor: '#FFFFFF'
altText: ShipEngine logo
description: 'Operations tagged insurance across 2 of this provider''s published API definitions: shipengine-openapi-docs-bundle.yaml, shipengine-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.shipengine.com
security:
- api_key: []
tags:
- name: Insurance
description: insurance
x-displayName: Insurance
paths:
/v1/connections/insurance/shipsurance:
summary: Shipsurance connection
description: Shipsurance Connection
delete:
summary: Disconnect a shipsurance account
description: Disconnect a Shipsurance Account
deprecated: true
operationId: disconnect_insurer
tags:
- Insurance
responses:
'200':
description: The request was a success
content:
application/json:
schema:
$ref: '#/components/schemas/disconnect_insurer_response_body'
'400':
$ref: '#/components/responses/400_error_response'
'500':
$ref: '#/components/responses/500_error_response'
post:
summary: Connect a shipsurance account
description: Connect a Shipsurance Account
deprecated: true
operationId: connect_insurer
tags:
- Insurance
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/connect_insurer_request_body'
required: true
responses:
'200':
description: The request was a success
content:
application/json:
schema:
$ref: '#/components/schemas/connect_insurer_response_body'
'400':
$ref: '#/components/responses/400_error_response'
'500':
$ref: '#/components/responses/500_error_response'
servers:
- url: https://api.shipengine.com
/v1/insurance/shipsurance/add_funds:
summary: Shipsurance
description: '[Shipsurance](https://www.shipsurance.com/) is a shipping insurance company offering coverage for shipments sent via the major shipping carriers worldwide.
'
patch:
summary: Add funds to insurance
description: 'You may need to auto fund your account from time to time. For example, if you don''t normally ship items over $100,
and may want to add funds to insurance rather than keeping the account funded.'
deprecated: true
tags:
- Insurance
operationId: add_funds_to_insurance
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/add_funds_to_insurance_request_body'
responses:
'200':
description: The request was a success.
content:
application/json:
schema:
$ref: '#/components/schemas/add_funds_to_insurance_response_body'
'400':
$ref: '#/components/responses/400_error_response'
'500':
$ref: '#/components/responses/500_error_response'
servers:
- url: https://api.shipengine.com
/v1/insurance/shipsurance/balance:
summary: Shipsurance
description: '[Shipsurance](https://www.shipsurance.com/) is a shipping insurance company offering coverage for shipments sent via the major shipping carriers worldwide.
'
get:
summary: Get insurance funds balance
description: Retrieve the balance of your Shipsurance account.
deprecated: true
tags:
- Insurance
operationId: get_insurance_balance
responses:
'200':
description: The request was a success.
content:
application/json:
schema:
$ref: '#/components/schemas/get_insurance_balance_response_body'
'400':
$ref: '#/components/responses/400_error_response'
'500':
$ref: '#/components/responses/500_error_response'
servers:
- url: https://api.shipengine.com
components:
schemas:
error_response_body:
title: error_response_body
type: object
description: An error response body
required:
- request_id
- errors
additionalProperties: false
properties:
request_id:
allOf:
- $ref: '#/components/schemas/uuid'
description: 'A UUID that uniquely identifies the request id.
This can be given to the support team to help debug non-trivial issues that may occur
'
errors:
type: array
readOnly: true
items:
$ref: '#/components/schemas/error'
description: The errors associated with the failed API call
get_insurance_balance_response_body:
title: get_insurance_balance_response_body
description: A get insurance balance response body
additionalProperties: false
allOf:
- $ref: '#/components/schemas/monetary_value'
se_id:
title: se_id
type: string
minLength: 1
maxLength: 25
pattern: ^se(-[a-z0-9]+)+$
example: se-28529731
description: A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
error_source:
title: error_source
type: string
example: shipengine
enum:
- carrier
- order_source
- shipengine
description: 'The source of the error, as indicated by the name this informs us if the API call failed because of the
carrier, the order source, or the ShipEngine API itself.
'
monetary_value:
title: monetary_value
type: object
description: 'A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
'
required:
- currency
- amount
additionalProperties: false
properties:
currency:
$ref: '#/components/schemas/currency'
amount:
type: number
minimum: 0
description: The monetary amount, in the specified currency.
currency:
title: currency
type: string
description: 'The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
'
example: USD
connect_insurer_response_body:
title: connect_insurer_response_body
type: object
disconnect_insurer_response_body:
title: disconnect_insurer_response_body
type: object
error_code:
title: error_code
type: string
example: invalid_field_value
enum:
- auto_fund_not_supported
- batch_cannot_be_modified
- bring_your_own_label_not_supported
- carrier_conflict
- carrier_disconnected
- carrier_not_connected
- carrier_not_supported
- confirmation_not_supported
- default_warehouse_cannot_be_deleted
- field_conflict
- field_value_required
- forbidden
- identifier_conflict
- identifiers_must_match
- insufficient_funds
- invalid_address
- invalid_billing_plan
- invalid_field_value
- invalid_identifier
- invalid_status
- invalid_string_length
- label_images_not_supported
- meter_failure
- multiple_sales_orders
- order_source_not_active
- rate_limit_exceeded
- refresh_not_supported
- request_body_required
- return_label_not_supported
- sales_order_link_required
- settings_not_supported
- subscription_inactive
- terms_not_accepted
- tracking_not_supported
- trial_expired
- unauthorized
- unknown
- unspecified
- verification_failure
- warehouse_conflict
- webhook_event_type_conflict
- customs_items_required
- incompatible_paired_labels
- invalid_charge_event
- invalid_object
- no_rates_returned
- file_not_found
- shipping_rule_not_found
- service_not_determined
- funding_source_registration_in_progress
- insurance_failure
- funding_source_missing_configuration
- funding_source_error
- freight_connection_inactive
- freight_provider_id_required
- freight_provider_already_connected
- freight_shipment_not_found
- freight_tracking_not_available
- freight_tracking_not_found
- freight_shipment_not_batchable
description: The error code specified for the failed API Call
carrier_code:
title: carrier_code
type: string
pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
example: dhl_express
description: 'A shipping carrier, such as `fedex`, `dhl_express`, `stamps_com`, etc.
'
uuid:
title: uuid
type: string
format: uuid
minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
example: aa3d8e8e-462b-4476-9618-72db7f7b7009
description: A UUID (a.k.a. GUID) that uniquely identifies a resource
error:
title: error
type: object
description: 'The error structure that gets returned with almost all failed API calls
'
required:
- error_source
- error_type
- error_code
- message
additionalProperties: false
properties:
error_source:
$ref: '#/components/schemas/error_source'
error_type:
$ref: '#/components/schemas/error_type'
error_code:
$ref: '#/components/schemas/error_code'
message:
type: string
readOnly: true
example: Body of request cannot be null.
minLength: 1
description: An error message associated with the failed API call
carrier_id:
readOnly: true
allOf:
- $ref: '#/components/schemas/se_id'
description: A string that uniquely identifies the carrier that generated the error.
carrier_code:
readOnly: true
allOf:
- $ref: '#/components/schemas/carrier_code'
description: 'The name of the shipping carrier that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.
'
field_name:
type: string
readOnly: true
example: shipment.ship_to.phone_number
description: The name of the field that caused the error
add_funds_to_insurance_request_body:
title: add_funds_to_insurance_request_body
description: An add funds to insurance request body
additionalProperties: false
allOf:
- $ref: '#/components/schemas/monetary_value'
add_funds_to_insurance_response_body:
title: add_funds_to_insurance_response_body
description: Add funds to insurance response body
additionalProperties: false
allOf:
- $ref: '#/components/schemas/monetary_value'
email:
title: email
type: string
format: email
minLength: 1
example: john.doe@example.com
description: An email address.
connect_insurer_request_body:
title: connect_insurer_request_body
type: object
description: A create shipsurance connection request body
required:
- email
- policy_id
additionalProperties: false
properties:
email:
$ref: '#/components/schemas/email'
policy_id:
type: string
minLength: 1
error_type:
title: error_type
type: string
example: validation
enum:
- account_status
- business_rules
- validation
- security
- system
- integrations
- funding_sources
description: 'The type of error
'
responses:
400_error_response:
description: The request contained errors.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response_body'
500_error_response:
description: 'An error occurred on ShipStation API''s side.
> This error will automatically be reported to our engineers.
'
content:
application/json:
schema:
$ref: '#/components/schemas/error_response_body'
securitySchemes:
api_key:
type: apiKey
name: API-Key
in: header
description: 'To authenticate yourself to ShipEngine, you need to include an `API-Key` header in each API call. If you don''t include a key when making an API request, or if you use an incorrect or expired key, then ShipEngine will respond with a `401 Unauthorized` error.
Learn more about API keys in our [authentication guide](https://docs.shipstation.com/apis/shipengine/docs/guides/auth).
'
x-refined-from:
- shipengine-openapi-docs-bundle.yaml
- shipengine-openapi.yml
x-provenance:
method: harvested
publisher: ShipEngine
source: https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)