Shopping Muse Sample Request & Response

These samples use the latest Shopping Muse version (October 2026). If you are looking for the previous version, see here

Request example

{
  "user": {
    "dyid": "EXAMPLE_USER_ID",
    "dyid_server": "EXAMPLE_SERVER_USER_ID",
    "active_consent_accepted": false
  },
  "session": {
    "dy": "EXAMPLE_SESSION_ID"
  },
  "query": {
    "text": "Can you suggest shoes to go with that dress?",
    "chatId": "EXAMPLE_CHAT_ID"
  },
  "context": {
    "page": {
      "type": "HOMEPAGE",
      "data": [],
      "locale": "en_US"
    }
  },
  "selector": {
    "name": "Shopping Muse"
  },
  "commerce": {
    "cart_id": "EXAMPLE_CART_ID"
  }
}

Response examples

Recommendation

{
  "type": "recommendation",
  "data": [
    {
      "title": "Suggested shoes",
      "slots": [
        {
          "sku": "EXAMPLE_SKU_001",
          "productData": {
            "group_id": "EXAMPLE_GROUP_ID_001",
            "name": "Example Sandals",
            "url": "https://shop.example.com/products/example-sandals",
            "image_url": "https://shop.example.com/images/example-sandals.jpg",
            "categories": ["Shoes", "Sandals"],
            "keywords": ["summer", "leather"],
            "price": 50,
            "description": "Leather sandals for summer occasions.",
            "in_stock": true,
            "brand": "Example Brand"
          },
          "slotId": "EXAMPLE_SLOT_ID_001"
        }
      ]
    }
  ],
  "support": false,
  "fallback": "Try Example Sandals, leather sandals priced at $50.00."
}

Text

{
  "type": "text",
  "data": "I can help you find shoes to match your dress. Do you prefer heels or flats?",
  "support": false,
  "fallback": null
}

Markdown

{
  "type": "markdown",
  "data": {
    "contentType": "table",
    "content": "| Feature | Example Sandals | Example Sneakers |\n|---|---|---|\n| Material | Leather | Canvas |\n| Color | Black | White |\n| Price | $50.00 | $70.00 |"
  },
  "support": false,
  "fallback": "Example Sandals: leather, black, $50.00. Example Sneakers: canvas, white, $70.00."
}
{
  "type": "markdown",
  "data": {
    "contentType": "text",
    "content": "- Example Summer Dress - Medium / Blue - $80.00\n- Example Sandals - Size 38 / Black - $50.00\n\n**Subtotal: $130.00**"
  },
  "support": false,
  "fallback": "Your cart contains an Example Summer Dress for $80.00 and Example Sandals for $50.00. Subtotal: $130.00."
}

Redirect

{
  "type": "redirect",
  "data": {
    "type": "checkout",
    "url": "https://shop.example.com/checkout?cart_id=EXAMPLE_CART_ID"
  },
  "support": false,
  "fallback": "Continue to checkout: https://shop.example.com/checkout?cart_id=EXAMPLE_CART_ID"
}

Did this page help you?