Search

getProductFiles

Retrieve product files (brochures, manuals, specifications). For each file, API provides a URL.

Please note that the files (as well as product images) are not accessible by default. To get access to the files, please contact ERPLY customer support.

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

Input parameters

Parameter nameDescriptionPossible valueRequired
productFileIDRetrieve one specific file by ID.Integer
productIDRetrieve all files 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
productFileIDIntegerID of the file.
productIDIntegerProduct ID.
nameStringA descriptive name for the file. May be empty.
typeIDIntegerFile type ID. Types are defined in Settings » Inventory settings » Product file types. See getProductFileTypes.
typeNameStringName of the file type.
isInformationFileInteger(0/1)A flag for categorizing the files.
fileURLStringURL of file.
externalInteger(0/1)A flag that indicates whether the file 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 files from a specific CDN when the file is removed from ERPLY.
addedUnix timestamp
lastModified