Update downloadable sample of the given product

PUT /V1/products/{sku}/downloadable-links/samples/{id}

Path parameters

sku string Required
id string Required

Body

sample object Required
Hide sample attributes Show sample 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
isGlobalScopeContent boolean

Body

sample object Required
Hide sample attributes Show sample 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
isGlobalScopeContent boolean

Responses

200

application/json

application/json application/xml

200 Success.
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

PUT /V1/products/{sku}/downloadable-links/samples/{id}

curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/downloadable-links/samples/{id}' \
 --header "Content-Type: application/json" \
 --data '{"sample":{"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":{}},"isGlobalScopeContent":true}'

curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/downloadable-links/samples/{id}' \
 --header "Content-Type: application/xml"

Request examples

{
  "sample": {
    "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": {}
  },
  "isGlobalScopeContent": true
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <sample>
    <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>
  </sample>
  <isGlobalScopeContent type="boolean">true</isGlobalScopeContent>
</root>

Response examples (200)

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>