ERerply
v1

Get all configurations or a sub-list.

All those parameters work like filters. You can search for all configs by type or by level. Or get all configs of Pos 1. With Look-Deeper header set to true you will get the following logic of the request: When you request a config at a User or Warehouse levels, if it is not there it will check Company level as well. When you request a config at a POS level, if it is not there it will check Warehouse (if request to ERPLY API was ok to get the Warehouse ID) and Company levels as well.

get/configuration

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header hmac-auth
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

applicationstring

Application name that uses CAFA to store configs

level'Company' | 'Warehouse' | 'Pos' | 'User' | 'Device'

Level is the operating level where the config is stored

level_idstring

LevelID is a unique value, used to identify the instance of the level. for User level, user id, for Pos - Point of Sale ID. Warehouse can use any unique string to identify the instance of its level, Company level does not need level_id.

typestring

Type is an optional grouping property, in this case its 'payment', indicating that this configuration belongs to payment integrations group used to query groups of related configurations

namestring

Name of the configuration

Headers

timestampstring

UNIX timestamp used for the HMAC Auth method only

Look-Deeperboolean

look for configuration on deeper levels. if CAFA does not find any configuration with the query parameters, CAFA will use the level_id(PointOfSaleID), to find which Warehouse the Pos belongs to and check for configuration with the same name(and type if present)

Response

OK

addedinteger
addedby_idinteger
applicationstring
changedinteger
changedby_idinteger
idstring
levelstring

Level is optional

level_idstring

LevelID is optional

namestring
typestring

Type is optional

valueunknown

Example response

[
  {
    "application": "erply-to-woo-sync",
    "level": "Pos",
    "level_id": "1",
    "name": "adyen",
    "type": "payment"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.