GET
/
v1
/
quote
/
insurance?store_url=
{store_url}
curl --request GET \
  --url 'https://api.production.orderprotection.com/v1/quote/insurance?store_url={store_url}'
{
  "id": "clz1sc3z8039p8ruxx7mrob50",
  "automaticallyAddToCart": true,
  "mandatoryOp": false,
  "rules": [
    {
      "id": "cm7b0iepj0007wbgxv6q91iaj",
      "min": 0,
      "max": 5000,
      "terms": {
        "paidBy": "customer",
        "customer": {
          "amount": 10,
          "type": "fixed"
        }
      }
    },
    {
      "id": "cm7b0ieoo0005wbgx3790q9ex",
      "min": 5000,
      "max": 6000,
      "terms": {
        "paidBy": "brand",
        "brand": {
          "amount": 5,
          "type": "fixed"
        }
      }
    }
  ],
  "variants": null
}

A range of pricing rules is returned, and the logic to determine which rule to use should be handled on the client side.

The store_url is the URL of the store to get insurance quote for, e.g. docs.orderprotection.com.

​
Example

If the subtotal (the price before add-ons and shipping) is $1,000, and one of the pricing rules specifies a minimum of $0 and a maximum of $5,000, this rule should be applied to calculate the price of Order Protection, as the subtotal falls within the specified range.

​
Notes

  • The amounts in pricing rules are always in USD. If the subtotal is in a different currency, the amount should be converted to the cart’s currency using the current exchange rate.

  • The rules array is sorted by min in ascending order.

  • If the pricing rule has a type of brand, Order Protection should not be added to the cart.

Path Parameters

​
store_url
string
required

URL of the store to get insurance quote for

Response

200
application/json
Successfully retrieved insurance quote
​
id
string
required
Example:

"clz1sc3z8039p8ruxx7mrob50"

​
automaticallyAddToCart
boolean
required

Order Protection should automatically be added to the cart if this is true

Example:

true

​
mandatoryOp
boolean
required

Order Protection should always be added to the cart

Example:

false

​
rules
object[]
required
​
variants
any[] | null
Example:

null