Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Erply sync API

The sync API from Erply — 3 operation(s) for sync.

Erply sync API is one of 64 APIs that Erply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include sync. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 2.0, at version 2.36.5.

Requests are made against the base URL https://api-pim-eu.erply.com.

3 operations 3 paths 10 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.36.5
Base URL
https://api-pim-eu.erply.com
Authentication
API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Erply sync API declares 5 security schemes for authenticating requests. An API key is passed in the header as accessToken (AccessToken). An API key is passed in the header as clientCode (ErplyClientCode). An API key is passed in the header as jwt (ErplyJWT). An API key is passed in the header as sessionKey (ErplySession). An API key is passed in the header as requestKey (RequestKey).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

sync 3
GET
/api/v1/sync/device
Sync devices
4 params → 200401500
GET
/api/v1/sync/workorder
Sync workorders
4 params → 200401500
GET
/configurations/sync
Sync configurations
5 params → 200400500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SyncResponse (48 properties), RowResponse (31 properties), DeviceResponse (25 properties), TaskResponse (24 properties). Each schema is shown below with its type and property counts.

response
object
3 properties
LabelResponse
object
6 properties
ItemResponse
object
10 properties
TaskResponse
object
24 properties
DeviceListResponse
object
3 properties
RowResponse
object
31 properties
NoteResponse
object
12 properties
DeviceResponse
object
25 properties
SyncResponse
object
48 properties
configuration
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-sync-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
Erply Assortment To Product Linking API
Erply Attributes API
Erply auth API
Erply Brand API
Erply clsf API
Erply clsf-device-properties API
Erply clsf-events API
Erply clsf-labels API
Erply Country API
Erply device API
Erply event API