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 name Description Possible value Required
productFileID Retrieve one specific file by ID. Integer
productID Retrieve all files 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 retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". Integer

Response

Field name Type Description
productFileID Integer ID of the file.
productID Integer Product ID.
name String A descriptive name for the file. May be empty.
typeID Integer File type ID. Types are defined in Settings » Inventory settings » Product file types. See getProductFileTypes.
typeName String Name of the file type.
isInformationFile Integer(0/1) A flag for categorizing the files.
fileURL String URL of file.
external Integer(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.
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 files from a specific CDN when the file 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.