Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Path Parameters

merchant_id
string
required

Lite merchant id of the store to upload to, e.g. shopify-<shop id>.

Query Parameters

collection_id
string

The collection being edited. In a multi-store group, the file is also uploaded to every store whose collection is linked to this one; omit it to upload to this store only.

alt_text
string

Alt text stored on the Shopify file.

url
string<uri>
required

Public http(s) URL of the media to copy.

media_type
enum<string>
required

Uploaded as image/jpeg or video/mp4 respectively.

Available options:
image,
video

Response

The file as Shopify holds it once processed (this store's copy): a MediaImage or a Video.

__typename
enum<string>
required
Available options:
MediaImage
id
string
required

Shopify MediaImage GID; store it to reference the file.

fileStatus
string
required

Shopify's file status: always READY on a 200 (the route waits out processing; a failed file answers 400).

fileErrors
object[]
required
mediaContentType
string
required

IMAGE.

alt
string | null
required
image
object | null
required