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

# Get shipping offer marketing text

`GET /shipping-offers/config/marketing`

This endpoint dictates how shipping protection offer display units should display marketing and compliance text, and includes styling configuration based on the attach behavior, or offer type.  There are three main offer types: Extend Choice Opt-Out, where shipping protection is selected by default until the customer de-selects it, Extend Choice Opt-In, where the customer must select shipping protection to include it in the order, and Extend Complete, where shipping protection is automatically included by the merchant in every order.

## 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
  - `offerType` string, required
  - `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
  - `OPT_IN` 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
  - `OPT_OUT` 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
  - `OPT_MERCHANT` 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

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