Sign in
Media

Retrieve a media object

Retrieves details about the given Media object

get/shop/media/{mediaId}

Response

The media was successfully retrieved

idstring uuid required

Unique identifier of the uploaded media item, returned from createMedia. Pass this ID into any field that accepts a media reference (logos, hero images, product images, etc.).

file_namestring required

Original filename of the uploaded asset, preserved as provided at upload time. Used for display in the media library and as a hint when serving downloads.

mime_typestring required

The mime type of the media item.

original_urlstring required

The url of the media resource.

sizeinteger required

The size of the media item in bytes.

urlstring required

The url of the converted media resource.

Example response

{
  "file_name": "super-cool-photo.jpg",
  "mime_type": "image/jpeg",
  "original_url": "https://example.com/media/super-cool-photo.jpg",
  "size": 84256,
  "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.