Skip to content

Onward API (1.0.0)

Download OpenAPI description
onward.json
onward.yaml
Overview
E-mail
help@useonward.com
Terms of Service
Languages
Servers
https://app.useonward.com/api/v1/

Orders

Your customers orders, including the information necessary for Onward to insure and handle claims.

Operations

Shipments

Physical shipments of items within an order and their tracking events.

Operations

Quotes

Insurance quotes for customers during checkout.

Operations

Get an insurance quote

Request

During check out, get the insurance quote amount for the cart and add that amount to the order.

Security
api_key
Headers
Content-Typestringrequired

Content-Type must be application/json

Example: application/json
Acceptstringrequired

Accept must be application/json

Example: application/json
Bodyapplication/jsonrequired
cartobject(Cart)required
cart.​amount_insuredanyrequired

Sum of shippable line items that are being insured

Example: {"cents":1999,"currency":"USD"}
curl -i -X POST \
  https://app.useonward.com/api/v1/quotes \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "cart": {
      "amount_insured": {
        "cents": 1999,
        "currency": "USD"
      }
    }
  }'

Responses

Successful operation

Bodyapplication/json
idstring

Onward's ID for this Quote

Example: "8c0d0946dc595ecfe090ef85"
tokenstring

Tokenized reference to this Quote that you will use when creating the insured Order after checkout

Example: "c0740f7e3d4718a64fd9ce18101961d210d1c61c8c8afd62f95d62d8c433347b$$qkJClv/+sWfpOfPqp4sI46PxzBuBCW4eEDKsL4q87aFhRT9mdCpIuEWwuRuvbkX4BS8=--AUnUz8WgunyUiZ4o--nnYz0Lj5WsxSqsUxtBpIIQ=="
priceany

Price of insurance to be charged to the customer

Example: {"cents":500,"currency":"USD"}
variantobject

(Only included for Shopify shops) The Shopify Variant to add to cart in order to purchase this Quote

Response
application/json
{
  "id": "8c0d0946dc595ecfe090ef85",
  "token": "c0740f7e3d4718a64fd9ce18101961d210d1c61c8c8afd62f95d62d8c433347b$$qkJClv/+sWfpOfPqp4sI46PxzBuBCW4eEDKsL4q87aFhRT9mdCpIuEWwuRuvbkX4BS8=--AUnUz8WgunyUiZ4o--nnYz0Lj5WsxSqsUxtBpIIQ==",
  "price": {
    "cents": 500,
    "currency": "USD"
  },
  "variant": {
    "id": 0,
    "sku": "string"
  }
}