v1

latestOpenAPI 3.0.12026-07-243902.3 MB

Dynamic Return Policy

Retrieve dynamic return policy content

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

post/entitlements-management/dynamic-return-policy-content

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=latest

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

cartIdstring

Unique identifier for the customer's cart

currencystring required

Currency code for the cart and pricing information

regionstring

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

Example request

{
  "storeId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
  "locale": "en-US",
  "cartId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
  "currency": "USD",
  "region": "US",
  "customerInfo": {
    "name": "John Smith",
    "email": "customer@gmail.com",
    "phone": "123-456-7890",
    "shippingAddress": {
      "address1": "535 Mission Street",
      "address2": "11th Floor",
      "city": "San Francisco",
      "provinceCode": "CA",
      "postalCode": "94526",
      "countryCode": "US"
    },
    "billingAddress": {
      "address1": "535 Mission Street",
      "address2": "11th Floor",
      "city": "San Francisco",
      "provinceCode": "CA",
      "postalCode": "94526",
      "countryCode": "US"
    },
    "loyaltyStatus": "member"
  },
  "cartItems": [
    {
      "productId": "SKU-123-456",
      "quantity": 1,
      "parentProductId": "SKU-123",
      "productName": "Shiny Hat 2",
      "category": "clothing",
      "listPrice": 5900,
      "purchasePrice": 5900,
      "finalPrice": 5900
    }
  ],
  "discounts": [
    {
      "discountCode": "SUMMER20",
      "discountType": "percentage",
      "amountValue": 20,
      "amountUnit": "percentage",
      "description": "20% off summer sale"
    }
  ]
}

Response

Successfully retrieved dynamic return policy content

customerReturnPolicyIdstring uuid required

UUID identifier for the customer return policy

Example response

{
  "customerReturnPolicyId": "550e8400-e29b-41d4-a716-446655440000",
  "content": {
    "largeBlock": {
      "headlineIcon": "https://example.com/icons/reset.svg",
      "header": "Returns & Exchanges",
      "body": "Fees may apply to returns and exchanges.",
      "returnPolicyLinkText": "See Return Policy for details",
      "returnPolicyLinkUrl": "https://example.com/return-policy"
    },
    "smallBlock": {
      "icon": "https://example.com/icons/reset.svg",
      "header": "Free 45-Day Returns & Exchanges",
      "returnPolicyLinkText": "See Return Policy for details",
      "returnPolicyLinkUrl": "https://example.com/return-policy"
    },
    "modal": {
      "header": "Return Policy",
      "bullet1": "Free 30-day in-store returns from when item is delivered. (US only)",
      "icon1": "https://example.com/icons/reset.svg",
      "bullet2": "Free 30-day mail-in returns for Platinum Rewards members from when item is delivered. (US only)",
      "icon2": "https://example.com/icons/package.svg",
      "bullet3": "Fees may apply for standard mail-in returns, depending on rewards status or item.",
      "icon3": "https://example.com/icons/cash-dollar.svg",
      "returnPolicyLinkText": "See Refund Policy for details.",
      "returnPolicyLinkUrl": "https://example.com/refund-policy"
    }
  }
}