Media

PreviousProducts NextTypes

catalog Product Attribute Media Gallery Management V1Get Get

Return information about gallery entry

get

/V1/products/{sku}/media/{entryId}

Path parameters

skustringrequired

(Required)

Example: <string>

entryIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/products/{sku}/media/{entryId}'

200

400

401

500

{
  "media_type": "<string>",
  "label": "<string>",
  "position": "<integer>",
  "disabled": "<boolean>",
  "types": [
    "<string>",
    "<string>"
  ],
  "id": "<integer>",
  "file": "<string>",
  "content": {
    "base64_encoded_data": "<string>",
    "type": "<string>",
    "name": "<string>"
  },
  "extension_attributes": {
    "video_content": {
      "media_type": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_provider": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_url": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_title": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_description": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_metadata": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    }
  }
}

catalog Product Attribute Media Gallery Management V1Update Put

Update gallery entry

put

/V1/products/{sku}/media/{entryId}

Path parameters

skustringrequired

(Required)

Example: <string>

entryIdstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"entry":{"media_type":"<string>","label":"<string>","position":"<integer>","disabled":"<boolean>","types":["<string>","<string>"],"id":"<integer>","file":"<string>","content":{"base64_encoded_data":"<string>","type":"<string>","name":"<string>"},"extension_attributes":{"video_content":{"media_type":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_provider":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_url":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_title":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_description":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_metadata":{"value":"<Error: Too many levels of nesting to fake this schema>"}}}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/products/{sku}/media/{entryId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "entry": {
      "media_type": "<string>",
      "label": "<string>",
      "position": "<integer>",
      "disabled": "<boolean>",
      "types": [
        "<string>",
        "<string>"
      ],
      "id": "<integer>",
      "file": "<string>",
      "content": {
        "base64_encoded_data": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "extension_attributes": {
        "video_content": {
          "media_type": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_provider": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_url": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_title": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_description": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_metadata": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      }
    }
  }'

200

400

401

500

true

catalog Product Attribute Media Gallery Management V1Remove Delete

Remove gallery entry

delete

/V1/products/{sku}/media/{entryId}

Path parameters

skustringrequired

(Required)

Example: <string>

entryIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/products/{sku}/media/{entryId}'

200

400

401

500

true

catalog Product Attribute Media Gallery Management V1Get List Get

Retrieve the list of gallery entries associated with given product

get

/V1/products/{sku}/media

Path parameters

skustringrequired

(Required)

Example: <string>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/products/{sku}/media'

200

401

500

[
  {
    "media_type": "<string>",
    "label": "<string>",
    "position": "<integer>",
    "disabled": "<boolean>",
    "types": [
      "<string>",
      "<string>"
    ],
    "id": "<integer>",
    "file": "<string>",
    "content": {
      "base64_encoded_data": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "extension_attributes": {
      "video_content": {
        "media_type": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_provider": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_url": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_title": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_description": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_metadata": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  },
  {
    "media_type": "<string>",
    "label": "<string>",
    "position": "<integer>",
    "disabled": "<boolean>",
    "types": [
      "<string>",
      "<string>"
    ],
    "id": "<integer>",
    "file": "<string>",
    "content": {
      "base64_encoded_data": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "extension_attributes": {
      "video_content": {
        "media_type": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_provider": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_url": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_title": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_description": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_metadata": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  }
]

catalog Product Attribute Media Gallery Management V1Create Post

Create new gallery entry

post

/V1/products/{sku}/media

Path parameters

skustringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"entry":{"media_type":"<string>","label":"<string>","position":"<integer>","disabled":"<boolean>","types":["<string>","<string>"],"id":"<integer>","file":"<string>","content":{"base64_encoded_data":"<string>","type":"<string>","name":"<string>"},"extension_attributes":{"video_content":{"media_type":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_provider":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_url":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_title":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_description":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_metadata":{"value":"<Error: Too many levels of nesting to fake this schema>"}}}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/products/{sku}/media' \
  --header 'Content-Type: application/json' \
  --data '{
    "entry": {
      "media_type": "<string>",
      "label": "<string>",
      "position": "<integer>",
      "disabled": "<boolean>",
      "types": [
        "<string>",
        "<string>"
      ],
      "id": "<integer>",
      "file": "<string>",
      "content": {
        "base64_encoded_data": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "extension_attributes": {
        "video_content": {
          "media_type": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_provider": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_url": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_title": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_description": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "video_metadata": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      }
    }
  }'

200

400

401

500

-34417480