Sign in

v1

latestOpenAPI 3.0.12026-07-243902.3 MB
ShippingOffers

Create a shipping protection quote

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.<p>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.

post/shipping-offers/quotes

Headers

Content-Typestring required
Example:application/json

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

Acceptstring required
Example:application/json; version=2022-02-01

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.

Request body

storeIdstring required

Unique identifier for a store on Extend

regionstring

Region is used to filter quotes by the region where the customer is located (an ISO 3166-2 region code). <p> If no region is passed, "US" will be used as default region

currency'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD' required

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

localestring

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).

Example request

{
  "customer": {
    "loyaltyStatus": "member"
  }
}

Response

When all request parameters are valid and the request is processed successfully. If the request is not eligible for shipping protection coverage, the, premium on the response will be zero and there will be no quote ID in the response, so you will not be able to create a shipping protection order. Additionally, an optional note response attribute may contain additional context when no quote id is returned.<ul> <li>exceeds_coverage_max - total eligible cart value is higher than maximum allowed value for shipping protection </li> <li>below_coverage_min - otal eligible cart value is lower than minimum allowed value </li><li>not_eligible - none of the products in the request are eligible for shipping protection</li></ul>

idstring

Quote id when a valid shipping protection quote is created.

premiumnumber required

Price, expressed in terms of the smallest currency unit.<p> <ul><li>$19.99 would be 1999</li><li>1.234,56 € would be 123456</li><li>£ 1,999.99 would be 199999</li></ul>

currency'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD' required

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

offerType'OPT_IN' | 'OPT_OUT' | 'OPT_MERCHANT'

Offer type to display to customer, from enum OPT_IN, OPT_OUT, OPT_MERCHANT

excludedProductsstring[]

Array of product referenceId from the original request that are not covered as part of this quote for shipping protection

note'exceeds_coverage_max' | 'below_coverage_min' | 'not_eligible' | 'location_not_compliant'

Optional note to provide additional context for some responses. Example: When total cart value of shipping protection covered products exceeds maximum coverage, premium will be zero and note will say exceeds_coverage_max <p> note values: <ul> <li>exceeded_coverage_max - total eligible cart value is higher than maximum allowed value for shipping protection </li> <li>below_coverage_min - total eligible cart value is lower than minimum allowed value </li><li>not_eligible - none of the products in the request are eligible for shipping protection </li></ul>