Upload product image

Upload a product image (multipart field file) and set imageUrl. Replaces any previous image. Requires a Write key. Max. 10 MiB (10,485,760 bytes). The type is taken from the part’s Content-Type header: jpeg, png, webp or gif.

POST/products/{productId}/image

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

productIdstringrequired

Request body

requiredmultipart/form-data

fileanyrequired

Image file (jpeg, png, webp or gif), max. 10 MiB.

Responses

200

Uploaded

dataobjectrequired

Show properties

urlstringrequired

imageUrlstringrequired

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

404

No item with this id.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

413

File too large

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Parameters

productIdpath*

Bodymultipart/form-data

filestring*Image file (jpeg, png, webp or gif), max. 10 MiB.

Request

curl -X POST 'https://dashboard.scango.ch/api/v1/products/string/image' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  --form-string 'file=null'

const form = new FormData();
form.append("file", "null");

const response = await fetch("https://dashboard.scango.ch/api/v1/products/string/image", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  },
  body: form
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/products/string/image",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
    files=[
        ("file", (None, "null")),
    ],
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/products/string/image',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
  CURLOPT_POSTFIELDS => [
    'file' => 'null',
  ],
]);

$response = curl_exec($curl);

Response

{
  "data": {
    "url": "https://firebasestorage.googleapis.com/v0/b/example/o/instance%2Forg%2Fproducts%2Fprod%2Fphoto.jpg?alt=media&token=abc",
    "imageUrl": "https://firebasestorage.googleapis.com/v0/b/example/o/instance%2Forg%2Fproducts%2Fprod%2Fphoto.jpg?alt=media&token=abc"
  }
}

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}