---
title: "Retrieve dynamic return policy content"
method: POST
path: "/entitlements-management/dynamic-return-policy-content"
tags: ["Dynamic Return Policy"]
---

# Retrieve dynamic return policy content

`POST /entitlements-management/dynamic-return-policy-content`

## Request

- Base URL: `https://api.helloextend.com`
- URL: `https://api.helloextend.com/entitlements-management/dynamic-return-policy-content`
- Auth: none declared. Required headers: `Content-Type`, `Accept`

This endpoint retrieves dynamic return policy content and provides personalized and accurate return information that can be displayed on an e-commerce checkout page.

## Headers

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

## Request body

- object
  - `storeId` string, required: Unique identifier for the merchant store
  - `locale` 'en-US' | 'en-CA' | 'fr-CA' | 'es-US', required: Locale for the content retrieval. Supported values: en-US, en-CA, fr-CA, es-US
  - `cartId` string: Unique identifier for the customer's cart
  - `currency` string, required: Currency code for the cart and pricing information
  - `region` string: Region is used to filter return policy content 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
  - `customerInfo` object: Customer information including
    - `name` string: Customer's full name
    - `email` string, email: Customer's email address
    - `phone` string: Customer's phone number
    - `shippingAddress` object: Customer's shipping address
      - `address1` string: Primary address line
      - `address2` string: Secondary address line (apartment, suite, etc.)
      - `city` string: City name
      - `provinceCode` string: Province or state
      - `postalCode` string: Postal or ZIP code
      - `countryCode` string: Two-letter ISO country code (e.g., US, CA)
    - `billingAddress` object: Customer's billing address
      - `address1` string: Primary address line
      - `address2` string: Secondary address line (apartment, suite, etc.)
      - `city` string: City name
      - `provinceCode` string: Province or state
      - `postalCode` string: Postal or ZIP code
      - `countryCode` string: Two-letter ISO country code (e.g., US, CA)
    - `loyaltyStatus` string: Customer's loyalty status
  - `cartItems` object[]: Array of cart items with product details
    - `productId` string: Unique identifier for the product
    - `quantity` integer: Quantity of the product in cart (defaults to 1)
    - `parentProductId` string: Parent product identifier for variants or bundles
    - `productName` string: Name of the product
    - `category` string: Product category
    - `listPrice` number: List price of the product in smallest currency unit (ie: cents)
    - `purchasePrice` number: Purchase price of the product in smallest currency unit (cents)
    - `discountAmount` number: Discount amount applied to this item in smallest currency unit (cents)
    - `finalPrice` number: Final price after discounts in smallest currency unit (cents)
  - `discounts` object[]: Array of discounts applied at cart level
    - `discountCode` string: Discount/coupon code
    - `discountType` 'percentage' | 'flat_amount' | 'free_shipping' | 'buy_one_get_one': Type of discount applied
    - `amountValue` number: Discount amount value (percentage or fixed amount)
    - `amountUnit` 'percentage' | 'flat_amount': Unit for the discount amount
    - `description` string: Human-readable description of the discount

## Response `200`

Successfully retrieved dynamic return policy content

- object
  - `customerReturnPolicyId` string, uuid, required: UUID identifier for the customer return policy
  - `content` object, nullable
    - `largeBlock` object: Primary three-line dynamic policy display component
      - `headlineIcon` string, required: Icon for the large block headline
      - `header` string, required: Header text for the large block
      - `body` string, required: Body text for the large block
      - `returnPolicyLinkText` string, required: Display text for the return policy link
      - `returnPolicyLinkUrl` string, uri, required: URL link to the full return policy
    - `smallBlock` object: Secondary one-line dynamic policy display component
      - `icon` string, required: Icon for the small block
      - `header` string, required: Header text for the small block
      - `returnPolicyLinkText` string, required: Display text for the return policy link
      - `returnPolicyLinkUrl` string, uri, required: URL link to the full return policy
    - `modal` object: Summary modal displaying return policy details with bullet points
      - `header` string, required: Header text for the modal
      - `bullet1` string, required: First bullet point text
      - `icon1` string, required: Icon for the first bullet point
      - `bullet2` string, required: Second bullet point text
      - `icon2` string, required: Icon for the second bullet point
      - `bullet3` string, required: Third bullet point text
      - `icon3` string, required: Icon for the third bullet point
      - `returnPolicyLinkText` string, required: Display text for the return policy link
      - `returnPolicyLinkUrl` string, uri, required: URL link to the full return policy
  - `surfacesConfig` object, nullable: Controls which surfaces are enabled for displaying dynamic return policy content
    - `largeBlock` object, required: Configuration for large block surface
      - `isEnabled` boolean, required: Whether this surface config is enabled
    - `smallBlock` object, required: Configuration for small block surface
      - `isEnabled` boolean, required: Whether this surface config is enabled
    - `modal` object, required: Configuration for modal surface
      - `isEnabled` boolean, required: Whether this surface config is enabled

## Other responses

- `400`: The request to the endpoint was invalid
- `404`: The specified resource was not found
- `422`: Unprocessable entity
- `500`: Internal server error

---

[API](https://skmtc.dev/extend/apis/entitlements-api.md) - [All operations](https://skmtc.dev/extend/apis/entitlements-api/llms.txt) - [OpenAPI document](https://skmtc.dev/extend/apis/entitlements-api/revisions/24fb11c582c4?raw)