Request a quote
Request a quote for shipping protection. The quote is based on the value of the cart, excluding shipping, taxes, etc. In addition to the price, the response will contain identifiers for the Green Shipping Protection product variant that should be included on the order to purchase the protection. It will be up to your implementation to complete the addition of this product variant to the cart.
Use of this API and endpoint requires that the merchant product and variants be set up in Corso systems in order to map between the protection purchased, and the resultant variant that is added to an order.
Path Parameters
- shopId string required
A UUID belonging to the store
Query Parameters
- cartValue currency required
- currencyCode string required
- countryCode string
- 200
- 400
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
- cost string required
The cost to protect the quoted order, in the currency specified in the request
- productId string nullable required
Identifier of the store's Green Shipping Protection product. This product will be added to the order to complete the protection purchase on that order
- variantId string required
Identifier of the product variant that represents the cost of protection as quoted. When the Green Shipping Protection product is added, having the correct variant will ensure that the correct amount is paid by the customer.
- product string deprecated
This field is deprecated, please use 'productId' instead
- variant string deprecated
This field is deprecated, please use 'variantId' instead
- currencyCode string nullable required
The 3 letter currency code of the provided cost (in ISO 4217 format).
{
"cost": "1.25",
"productId": "5184895212",
"variantId": "3487998736",
"currencyCode": "USD"
}
Bad Request
Not Found