Skip to content

File upload

Request

This is new endpoint - older asynchronous endpoint has been only renamed to "Batch files upload" in documentation, url and structure is unchanged

Please, do not use this endpoint for batch file upload!

Performs one file upload synchronously in same way as asynchronous files upload.

In the result's image section, there are successfully uploaded image with current unique name and upload datetime.

See more about Files upload

In case of image upload, response tag is "image", any other file types has response key "file" as here:

IMAGE: JPG, PNG, GIF, WEBP

{
    "data": {
        "image": {
            "name": "image.jpg",
            "created": "2025-03-31T20:28:55+0200"
        }
    },
    "errors": null
}

ANY OTHER FILE TYPE

{
    "data": {
        "file": {
            "name": "file.pdf",
            "created": "2025-03-31T20:28:55+0200"
        }
    },
    "errors": null
}

Current filesize limit is 2MB.

Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobjectrequired
curl -i -X POST \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/system/file \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "sourceUrl": "https://example.com/file.png",
      "name": "string"
    }
  }'

Responses

Created

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "image": { … },
    "file": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}