Skip to main content
GET
/
items
/
{itemId}
/
images
Query Item Images
curl --request GET \
  --url https://api.jtl-cloud.com/erp/items/{itemId}/images \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "ItemId": 123,
    "ImageId": 123,
    "Filename": "<string>",
    "ImageDataType": "<string>",
    "SalesChannelId": "<string>",
    "EbayUserName": "<string>",
    "SortNumber": 123,
    "Size": 123,
    "Width": 123,
    "Height": 123
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
itemId
integer<int32>
required

The id of the item that the descriptions belong to.

Response

The requested item images.

​
ItemId
integer<int32>
required

Unique ID to identify an item.

​
ImageId
integer<int32>
required

Unique ID to identify an image.

​
Filename
string
required

Name of the file.

​
ImageDataType
string
required

Type of image.

​
SalesChannelId
string
required

The sales channel ID for an image. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET).

​
EbayUserName
string
required

Name of the eBay user if the sales channel is eBay.

​
SortNumber
integer<int32>
required

The sort number for arranging images in sales channels. Every image needs to have an unique sort number per sales channel and item.

​
Size
integer<int64>
required

The size of an image.

​
Width
integer<int32>
required

The width of an image in pixels.

​
Height
integer<int32>
required

The height of the image in pixels.