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

POST https://dy-api.com/v2/serve/user/agent 
{
  "user": {
    "dyid": "string",
    "dyid_server": "string",
    "active_consent_accepted": false
  },
  "session": {
    "dy": "string"
  },
  "query": {
    "text": "string",
    "chatId": "string"
  },
  "context": {
    "page": {
      "type": "HOMEPAGE",
      "data": [
        "p76311-020"
      ],
      "locale": "en_US"
    },
  },
  "selector": {
    "name": "Shopping Muse"
  },
  "commerce": {
    "cart_id": "cart-111"
  },
}

Responses

Recommendation

[ 
   {
      "slots": [
        {
          "item": {
            "sku": "string",
            "group_id": "string",
            "name": "string",
            "url": "string",
            "image_url": "string",
            "categories": "string[]",
            "keywords": "string[]",
            "price": "number",
            "description": "string",
            "in_stock": "boolean",
            "brand": "string"
          }
        }
      ],
      "title": "string",
      "wId": "string", // in use? can move to metadata?
      "fId": "number", // in use? can move to metadata?
      "fallback": "boolean" // in use?
    }
]

Text

"string"

Markdown

{
  "contentType": "table"            // table | text
  "content": "string",
}

Redirect

{
  "contentType": "checkout",        // checkout | web_url,
  "url": "https://example.com",
}

Did this page help you?