v1

latestOpenAPI 3.0.12026-07-243902.3 MB
ShippingOffers

Get shipping offer marketing text

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.

get/shipping-offers/config/marketing

Query parameters

storeIdstring uuid required
Example:c57ed096-24ef-49a4-a20a-d1b8bf770980

Unique identifier for a store on Extend

localestring
Example:en-US

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

Response

Successfully returns config for shipping offers.

offerTypestring required