List of samples for downloadable product

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}

GET /V1/products/{sku}/downloadable-links/samples

List of samples for downloadable product

Path parameters

sku string Required

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- id integer
  
  Sample(or link) id
- title string Required
  
  Title
- sort_order integer Required
  
  Order index for sample
- sample_type string Required
- sample_file string
  
  relative file path
- sample_file_content object
  
  Hide sample_file_content attributes Show sample_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
- sample_url string
  
  file URL
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface
Hide response attributes Show response attributes object
- id integer
  
  Sample(or link) id
- title string Required
  
  Title
- sort_order integer Required
  
  Order index for sample
- sample_type string Required
- sample_file string
  
  relative file path
- sample_file_content object
  
  Hide sample_file_content attributes Show sample_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
- sample_url string
  
  file URL
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/products/{sku}/downloadable-links/samples

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/downloadable-links/samples'

Response examples (200)

[
  {
    "id": 42,
    "title": "string",
    "sort_order": 42,
    "sample_type": "string",
    "sample_file": "string",
    "sample_file_content": {
      "file_data": "string",
      "name": "string",
      "extension_attributes": {}
    },
    "sample_url": "string",
    "extension_attributes": {}
  }
]

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <id type="integer">42</id>
    <title>string</title>
    <sort-order type="integer">42</sort-order>
    <sample-type>string</sample-type>
    <sample-file>string</sample-file>
    <sample-file-content>
      <file-data>string</file-data>
      <name>string</name>
      <extension-attributes>
      </extension-attributes>
    </sample-file-content>
    <sample-url>string</sample-url>
    <extension-attributes>
    </extension-attributes>
  </root>
</root>

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>