Samples

PreviousDownloadable links NextAttributes

downloadable Sample Repository V1Get List Get

List of samples for downloadable product

get

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

Path parameters

skustringrequired

(Required)

Example: <string>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/products/{sku}/downloadable-links/samples'

200

401

500

[
  {
    "title": "<string>",
    "sort_order": "<integer>",
    "sample_type": "<string>",
    "id": "<integer>",
    "sample_file": "<string>",
    "sample_file_content": {
      "file_data": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "extension_attributes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "sample_url": "<string>",
    "extension_attributes": "<object>"
  },
  {
    "title": "<string>",
    "sort_order": "<integer>",
    "sample_type": "<string>",
    "id": "<integer>",
    "sample_file": "<string>",
    "sample_file_content": {
      "file_data": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "extension_attributes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "sample_url": "<string>",
    "extension_attributes": "<object>"
  }
]

downloadable Sample Repository V1Save Post

Update downloadable sample of the given product

post

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

Path parameters

skustringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"sample":{"title":"<string>","sort_order":"<integer>","sample_type":"<string>","id":"<integer>","sample_file":"<string>","sample_file_content":{"file_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"name":{"value":"<Error: Too many levels of nesting to fake this schema>"},"extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}},"sample_url":"<string>","extension_attributes":"<object>"},"isGlobalScopeContent":"<boolean>"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/products/{sku}/downloadable-links/samples' \
  --header 'Content-Type: application/json' \
  --data '{
    "sample": {
      "title": "<string>",
      "sort_order": "<integer>",
      "sample_type": "<string>",
      "id": "<integer>",
      "sample_file": "<string>",
      "sample_file_content": {
        "file_data": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "name": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "extension_attributes": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      },
      "sample_url": "<string>",
      "extension_attributes": "<object>"
    },
    "isGlobalScopeContent": "<boolean>"
  }'

200

401

500

66689314

downloadable Sample Repository V1Save Put

Update downloadable sample of the given product

put

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

Path parameters

skustringrequired

(Required)

Example: <string>

idstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"sample":{"title":"<string>","sort_order":"<integer>","sample_type":"<string>","id":"<integer>","sample_file":"<string>","sample_file_content":{"file_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"name":{"value":"<Error: Too many levels of nesting to fake this schema>"},"extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}},"sample_url":"<string>","extension_attributes":"<object>"},"isGlobalScopeContent":"<boolean>"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/products/{sku}/downloadable-links/samples/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "sample": {
      "title": "<string>",
      "sort_order": "<integer>",
      "sample_type": "<string>",
      "id": "<integer>",
      "sample_file": "<string>",
      "sample_file_content": {
        "file_data": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "name": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "extension_attributes": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      },
      "sample_url": "<string>",
      "extension_attributes": "<object>"
    },
    "isGlobalScopeContent": "<boolean>"
  }'

200

401

500

66689314

downloadable Sample Repository V1Delete Delete

Delete downloadable sample

delete

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

Path parameters

idstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/products/downloadable-links/samples/{id}'

200

401

500

true