ERerply
Sync

Sync configurations

Request the configurations with the intention to sync some or all of the configurations created or modified since the lastModified timestamp. At most, 5000 configurations will be returned from this endpoint in one request. Continue making requests with the same lastModified to get the remaining configurations. The API remembers itself where you left off.

get/configurations/sync

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

lastModifiedinteger required

change since date for the configurations to sync

lastIdRetrievedinteger

the ID of the last configuration in the previous response. It is the responsibility of the API client to extract this value and use it for the next call.

takeinteger

Number of records to return. If API client omits this parameter, the 20 is the default value.

withTotalCountboolean

optionally return total number of records in the X-Total-Count response header

Headers

timestampstring

UNIX timestamp used for the HMAC Auth method only

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.