A valid request URL is required to generate request examples{
"__typename": "MediaImage",
"id": "<string>",
"fileStatus": "<string>",
"fileErrors": [
{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}
],
"mediaContentType": "<string>",
"alt": "<string>",
"image": {
"altText": "<string>",
"height": 123,
"id": "<string>",
"url": "<string>",
"width": 123
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Upload an image or video file to the merchant's Shopify Files
Streams one multipart file into Shopify Files (staged upload, fileCreate), waits until Shopify has processed it, and returns the file node, whose id a content block then references. Side effects: creates a Shopify file in this store, and in every multi-store sibling linked through collection_id; nothing is rolled back if one store fails. Images and videos only; Shopify’s size caps apply. Can take tens of seconds for a video.
A valid request URL is required to generate request examples{
"__typename": "MediaImage",
"id": "<string>",
"fileStatus": "<string>",
"fileErrors": [
{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}
],
"mediaContentType": "<string>",
"alt": "<string>",
"image": {
"altText": "<string>",
"height": 123,
"id": "<string>",
"url": "<string>",
"width": 123
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
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
Lite merchant id of the store to upload to, e.g. shopify-<shop id>.
Query Parameters
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 stored on the Shopify file.
Body
The file; its part must carry a filename and a Content-Type (image/* or video/*).
Response
The file as Shopify holds it once processed (this store's copy): a MediaImage or a Video.
- Option 1
- Option 2
MediaImage Shopify MediaImage GID; store it to reference the file.
Shopify's file status: always READY on a 200 (the route waits out processing; a failed file answers 400).
Show child attributes
Show child attributes
IMAGE.
Show child attributes
Show child attributes
Was this page helpful?