Basic information

POST /{shopId}/products/{productId}/slideshow

Creates (uploads) an image for the product slideshow.

Authorisation

OAuth 2.0 Token required with scopes:

products_write

URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop
productId string

The unique identifier of the product.

Required: true
Example: 52F221E0-36F6-DC4E-384A-AC1504050C04

Request body

Media type multipart/form-data

Name Type Description
filename string

The file name must be specified as property filename of the Content-Disposition: form-data; sub-header of the multipart.
For further details, refer to this example of a multipart/form-data request.
It is important that the file name has a ‘file name extension’ that is one of .png , .jpg , .jpeg , .gif , .ico.
An already existing image cannot be overwritten by a new image with the same file name.
Either delete the old image and upload a new image, or choose a different file name.

Required: true
name string

The name parameter of the Content-Disposition: form-data; sub-header.
Example for a complete header:
Content-Disposition: form-data; name = image; filename = your-filename.jpg

Required: true
image file

The image file to be uploaded. This parameter represents the binary-encoded section of the multipart.
Typically an HTTP client library would specify Content-Type: application/octet-stream as sub-header for a binary part.
This is not verified by our API.

Required: true

Response attributes

Name Type Description
name

string

The name of the slideshow image.

sizes

array of image

The size of the images in the slideshow.

Response

HTTP 201

Media type application/json

{
  "name": "logo_small.png",
  "sizes": [
    {
      "classifier": "MediumSmall",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small_ms.png",
      "isZoomEnabled": false
    },
    {
      "classifier": "Thumbnail",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small_xs.png",
      "isZoomEnabled": false
    },
    {
      "classifier": "MediumLarge",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small_ml.png",
      "isZoomEnabled": false
    },
    {
      "classifier": "HotDeal",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small_h.png",
      "isZoomEnabled": false
    },
    {
      "classifier": "Small",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small_s.png",
      "isZoomEnabled": false
    },
    {
      "classifier": "Medium",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small_m.png",
      "isZoomEnabled": false
    },
    {
      "classifier": "Large",
      "url": "http://demo.intern.epages.de/WebRoot/Store/Shops/DemoShop/Products/be_40401/logo_small.png",
      "isZoomEnabled": false
    }
  ]
}

HTTP 400

Image name is taken. (To replace an image, delete the old one first and then upload the new one.)

HTTP 413

The file size is too large. The entire HTTP body (including multipart headers) must not exceed the defined limit.