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 clsf API

The clsf API from Erply — 7 operation(s) for clsf.

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

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

This API exposes 13 operations across 7 paths, and defines 6 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.

13 operations 7 paths 6 schemas 3 DELETE4 GET3 PATCH3 POST

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 clsf 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 13

Across 7 paths, the API surfaces 13 operations — 3 DELETE, 4 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

clsf 13
GET
/api/v1/clsf/priority
Look up priorities
7 params → 200401500
POST
/api/v1/clsf/priority
Add a new priority
1 param → 201400401500
DELETE
/api/v1/clsf/priority/{priorityId}
Delete one priority record
1 param → 200400401404500
PATCH
/api/v1/clsf/priority/{priorityId}
Update an existing priority record
2 params → 200400401404500
GET
/api/v1/clsf/state
Look up states
8 params → 200401500
POST
/api/v1/clsf/state
Add a new state record
1 param → 201400401500
DELETE
/api/v1/clsf/state/{stateId}
Delete one state record
1 param → 200400401404500
PATCH
/api/v1/clsf/state/{stateId}
Update an existing state record
2 params → 200400401404500
GET
/api/v1/clsf/unit
Look up product units
4 params → 200401500
GET
/api/v1/clsf/workorder-type
Look up workorder types
7 params → 200401500
POST
/api/v1/clsf/workorder-type
Add a new workorder type
1 param → 201400401500
DELETE
/api/v1/clsf/workorder-type/{typeId}
Delete one workorder type record
1 param → 200400401404500
PATCH
/api/v1/clsf/workorder-type/{typeId}
Update an existing workorder type record
2 params → 200400401404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are core.Translatable (25 properties), ClsfResponse (10 properties), StateRequest (5 properties), WorkorderTypeRequest (4 properties). Each schema is shown below with its type and property counts.

StateRequest
object
5 properties
ClsfResponse
object
10 properties
ClsfChildResponse
object
2 properties
PriorityRequest
object
4 properties
core.Translatable
object
25 properties
WorkorderTypeRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-clsf-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-device-properties API
Erply clsf-events API
Erply clsf-labels API
Erply Country API
Erply device API
Erply event API
Erply Export API