Search

getProductPictures

Retrieve product pictures.

For each picture, ERPLY provides 4 URLs for 4 different image sizes. These URLs must not be hotlinked — you need to download the images to your application and serve them from there.

Access to images is currently limited and the images are not accessible by default. If you need to access the files, please contact ERPLY customer support.

The same information is also available through API call getProducts (field images), so if you need to query product information anyway, getProducts can also provide you the list of images for each product.

Input parameters

Parameter nameDescriptionPossible valueRequired
productPictureIDRetrieve one specific image by ID.Integer
productIDRetrieve all images associated with a product.Integer
changedSinceRetrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with ERPLY.Integer (Unix timestamp)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer

Response

Field nameTypeDescription
productPictureIDIntegerImage ID.
productIDIntegerProduct ID.
nameString (255)A descriptive name for the file. May be empty.
thumbURLString (255)URL of image thumbnail (by default 100 x 100 px).
smallURLString (255)URL of a small version of the image (by default 200 x 200 px).
largeURLString (255)URL of a large version of the image (by default 800 x 600 px).
fullURLString (255)URL of the full-size original image.
externalInteger (0 or 1)A flag that indicates whether the image is stored as a local file in Erply, or as a URL to an external location, eg. a content delivery network.
hostingProviderStringA codename for the hosting provider, if the file is stored in an external location. May be empty.

This is used only for ERPLY's internal purposes, eg. to know how to remove image files from a specific CDN when the picture is removed from ERPLY.
addedUnix timestamp
lastModified