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.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| productPictureID | Retrieve one specific image by ID. | integer | |
| productID | Retrieve all images associated with a product. | integer | |
| changedSince | Retrieve 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) | |
| recordsOnPage | Number of records API should return. By default 20, at most 100. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description |
|---|---|---|
| productPictureID | integer | Image ID. |
| productID | integer | Product ID. |
| name | String (255) | A descriptive name for the file. May be empty. |
| thumbURL | String (255) | URL of image thumbnail (by default 100 x 100 px). |
| smallURL | String (255) | URL of a small version of the image (by default 200 x 200 px). |
| largeURL | String (255) | URL of a large version of the image (by default 800 x 600 px). |
| fullURL | String (255) | URL of the full-size original image. |
| external | Integer (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. |
| hostingProvider | string | A 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. |
| added | Unix timestamp | |
| lastModified | integer | Last modification timestamp. |
| hash | String/Null | CDN Only field. Filename in the cdn. |
| tenant | String/Null | CDN Only field. Tenant in the cdn. |