Found 383 results
in 10.8941 ms
/getting-started/bulk-api-calls
...requestID to each of the sub-requests; the same value will be returned in response header.
Some usage notes and tips:
Processing bulk calls will take considerably longer that processing a single call. Use a longer request timeout.
The following input parameters must be sent as top-level...
/new-apis/wms-api
...specialized REST API for implementing warehouse management on top of Erply inventory.
As a user, you might rather be interested in the end-user apps and the workflow we offer — instead of the raw API. The processes are documented here:
Warehouse Management Software
Warehouse Management Software...
/requests/calculateshoppingcart
Calculate the value of a shopping cart, and have discounts, promotions and taxes automatically calculated by API. You only need to input item IDs and quantities.calculateShoppingCart is a very versatile function that: For each item, finds the sales price that should apply in given location, and to...
/requests/switchuser
...parameters
Parameter name
Description
Possible value
Required
sessionKey
A valid session key (or one that has expired in the last 2 hours)
string
yes
cardCode
New user PIN
string
yes
sessionLength
Desired session length in seconds (1...86400 sec).If you omit the parameter, or specify 0 or a...
/requests/verifyuser
...parameters
Parameter name
Description
Possible value
Required
username
User name
string
yes
password
Password
string
yes
sessionLength
Desired session length in seconds (1...86400 sec).If you omit the parameter, or specify 0 or a negative value, a session with a default length of 3600 will be...
/requests/changepassword
...parameters
Parameter name
Description
Possible value
Required
sessionKey
A valid session key
string
yes
oldPassword
A valid password of current user
string
yes
newPassword
New new password, shouldn't match old one and be shorter than 8 symbols
string
yes
sessionLength
Desired session length in...
/requests/getsessionkeyuser
...parameters
Parameter name
Description
Possible value
Required
sessionKey
Session key
string
yes
doNotGenerateIdentityToken
If set to 1, then API will NOT return parameter "identityToken".
Integer (1 or 0)
Response
Field name
Type
Description
userID
integer
ID of the user...
/requests/verifyoauthtoken
...parameters
Parameter name
Description
Possible value
Required
idToken
Json Web Token containing user data, required fields - "mail", "roles" - set of user roles, optionally - "givenName" and "familyName".
string
yes
expiresIn
Session length in seconds.
integer
yes
Response
Field...
/getting-started/curl
Any API call MUST always include these parameters:
clientCode - Your ERPLY account code (for example, "2881")
request - Name of the API function (getCustomers, verifyUser, getRelatedProducts etc).
Every API session must be authenticated with username, password and a call to verifyUser()
(ie., a...
/new-apis/cdn-api
This API offers a picture storage and file storage.
Internally, we use it for product pictures and product files — but it can just as well support any custom assets.
This is a REST API. There are two endpoints:
Sandbox endpoint for sandbox accounts:
Endpoint:...
/requests/getserviceendpointsforpos
...record in the array contains the following fields:Field nameTypeDescriptionoperatingSystemStringPossible values - "Windows", "macOS" and "Linux"urlStringInstallation link
/requests/getconfparameters
...or an associative array, and a default value (0, unless specified otherwise) assumed for all missing ones. Some of the parameters are supposed to have a decimal/integer value, or a value of 1 or 0 (true/false, enabled/disabled). However API returns almost all fields as strings. If your...
/getting-started/php
...Get client groups from API
// No input parameters are needed
$result = $api->sendRequest("getClientGroups", array());
// Default output format is JSON, so we'll decode it into a PHP array
$output = json_decode($result, true);
print "<pre>";
print_r($output);
print...
/requests/addstoreregionpricelist
...parameters
Parameter name
Description
Possible value
Required
priceListID
Price list ID.
integer
yes
storeRegionID
Store region ID.
integer
yes
positionNumber
Price list's position.Specify this input parameter if you want to place the price list to a specific position, among this region's price...
/requests/editstoreregionpricelist
...parameters
Parameter name
Description
Possible value
Required
priceListID
Price list ID.
integer
yes
storeRegionID
Store region ID.
integer
yes
positionNumber
Price list's position.Move the price list to a specific position, among this region's price lists; positionNumber = 1 sets it as the...
/concepts/languages
...name) as a JSON structure (containing key-value pairs: language code + name in the respective language). Examples:
"name": {
"en": "Example",
"nl":"Voorbeeld"
}
or:
"name": {
"en": "Other",
"zh_Hans": "其他"
}
Configuration Parameters
To detect which languages have been activated on...
/requests/saveproductfile
...parameters
Parameter name
Description
Possible value
Required
productFileID
Use productFileID to edit or replace an existing file. You may edit general information of the file (productID, name, fileTypeID, isInformationFile) or replace/update the file as well, as...
/requests/saveproductpicture
...parameters
Parameter name
Description
Possible value
Required
productPictureID
Use productPictureID to edit or replace an existing image. You may edit general information of the file (productID, pictureName) or replace/update the file as well, as needed.
integer
productID
Product ID. For new...
/new-apis
...have started implementing new API features as separate "microservices". Each such API fulfills a specific purpose.
The motivation behind those separate APIs (and the reason to use them!) might be that:
Some of them expose the same standard functionality in a better format and with more expressive...
/getting-started
...is a HTTP POST request in traditional parameter1=value1&parameter2=value2 format. Server responds by sending an XML or JSON document that contains response metadata and requested records.
Request – HTTP POST
Response – JSON / XML document (you get to choose which). JSON is the default...