---
title: "Get shipping offer config"
method: GET
path: "/shipping-offers/config"
tags: ["ShippingOffers"]
---

# Get shipping offer config

`GET /shipping-offers/config`

This endpoint dictates how the shipping protection offer modal should display marketing and compliance text, and includes styling configuration based on attach behavior (i.e. opt in vs. opt out)

## Query parameters

- `storeId` string, uuid, required
- `locale` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

Successfully returns config for shipping offers.

- object
  - `surfaceVersion` object — Suggested shipping-protection surface throughout customer purchase journey
    - `cartOffer` object — Cart offer version
      - `version` string, required — Version of the cart offer surface to be display
      - `content` string, required — Content to be displayed on the cart offer surface
    - `learnMoreModal` object — Learn more modal version
      - `version` string, required — Version of the learn more modal surface to be display
      - `content` string, required — Content to be displayed on the learn more modal surface
  - `marketing` object, required — Marketing text to show for various offer types
    - `locale` string, required
    - `cartOffer` object, required — Text to display on the cart or checkout page offer UI component
      - `header` string, required
      - `subheader` string, required
      - `learnMoreLinkText` string, required
      - `extendIconLink` string, required
      - `headerWithExtendIconLink` string
    - `learnMoreModal` object, required — Text to display in a modal that provides a quick summary about the shipping protection
      - `header` string, required
      - `subheader` string, required
      - `extendIconLink` string, required
      - `bulletHeader` string, required
      - `bullets` string[], required — Array of bullet points of text describing what shipping protection does.
      - `coverageHeader` string, required
      - `coverageItems` object[], required — Array of text and images describing what shipping protection covers (i.e. lost, stolen, and damaged shipments)
        - `text` string, required
        - `description` string, required
        - `icon` string, required
      - `planDetailLinkText` string, required — Display text to use for the planDetailsLink hyperlink
      - `planDetailLink` string, required — Web link to see details of the shipping protection plan
      - `disclaimerHeader` string, required — Disclaimer header to be displayed as part of learn more UI component
      - `disclaimerText` string, required — Disclaimer text to be displayed as part of learn more UI component
    - `learnMoreModalV2` object — Text to display in a modal that provides a quick summary about the shipping protection for charitiable donations.
      - `header` string, required
      - `coverageHeader` string, required
      - `coverageItems` object[], required — Array of text and images describing what shipping protection covers (i.e. lost, stolen, and damaged shipments)
        - `description` string, required
        - `icon` string, required
      - `planDetailLinkText` string, required — Display text to use for the planDetailsLink hyperlink
      - `planDetailLink` string, required — Web link to see details of the shipping protection plan
      - `whyExtend1Icon` string, required
      - `modalImage` string, required — Relevant image to the right of modal
      - `disclaimerText` string, required — Disclaimer text to be displayed as part of learn more UI component
    - `charityDetails` object[] — Charity details.
      - `charityModalHeadline` string, required
      - `charityModalSubheadline` string, required
      - `charityModalImage` string, required
      - `charityPlanDetailLinkText` string, required
      - `charityModalDisclosureText` string, required
      - `charityPlanDetailsLogoImage` string, required
      - `charityPlanDetailsImage` string, required
      - `charityPlanDetailsHeadline` string, required
      - `charityPlanDetailsSubheadline` string, required
      - `charityPlanDetailsDisclosureText` string, required
      - `charityCartIcon` string, required
      - `charityCartSubheader` string, required
  - `config` object, required — Default offer type configuration for attach behavior <p> <uil><li>OPT_IN - UI widget is expected to have consumer turn on shipping protection</li><li>OPT_OUT - UI widget is expected to have shipping protection turned on by default</li><li>OPT_MERCHANT - Shipping protection automatically included by the merchant</li></uil>
    - `attachBehavior` 'OPT_IN' | 'OPT_OUT' | 'OPT_MERCHANT', required

## Other responses

- `404` — The specified resource was not found

---

[API](https://skmtc.dev/extend/apis/leads-api.md) · [All operations](https://skmtc.dev/extend/apis/leads-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/extend/leads-api/revisions/76403e33d7d6/schema)