Create a shipping protection quote

post

https://api.helloextend.com/shipping-offers/quotes

This endpoint calculates the shipping protection premium, i.e. the price you will charge the customer for shipping protection, for eligible products in the specified cart.

The response will include the premium and a quote id which must be used to create a valid Order with Extend including shipping protection. An optional array "excluded_products" may contain a list of products that were excluded from the premium calculation if the cart contained products that are not eligible for shipping protection.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

storeId

string

required

Unique identifier for a store on Extend

region

string

Region is used to filter quotes by the region where the customer is located (an ISO 3166-2 region code).

If no region is passed, "US" will be used as default region

currency

string

enum

required

Currency code used when contract was purchased. NOTE - This is an ISO-4217 currency code.

Allowed:

customer

object

Customer information

items

array of objects

required

Array of products in the cart for shipping protection quote

items*

locale

string

The locale of the customer. Locale is used to determine the language for display and communication. Locale is formatted as xx-XX: the first two letters denote language, (ISO 639-1 standards) and the last two letters denote region (ISO 3166 standards).

Headers

Content-Type

string

required

Used to indicate the original media type of the resource (prior to any content encoding applied for sending).

string

required

Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.

Responses

400The request to the endpoint was invalid

404The specified resource was not found

500Internal server error