How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Erply

Erply workorder API

The workorder API from Erply — 14 operation(s) for workorder.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 16 operations across 14 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.36.5.

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

16 operations 14 paths 12 schemas 1 DELETE2 GET1 PATCH12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 workorder 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 16

Across 14 paths, the API surfaces 16 operations — 1 DELETE, 2 GET, 1 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.

workorder 16
GET
/api/v1/workorder
Look up workorder records
49 params → 200401500
POST
/api/v1/workorder
Add a new workorder record
body → 201400401500
DELETE
/api/v1/workorder/{workorderId}
Delete one workorder record
1 param → 200400401404500
PATCH
/api/v1/workorder/{workorderId}
Update workorder record
1 param body → 200400401404500
GET
/api/v1/workorder/{workorderId}/backup
Look up workorder backups
6 params → 200401500
POST
/api/v1/workorder/{workorderId}/cancel
Mark the workorder as cancelled
1 param → 200400401404500
POST
/api/v1/workorder/{workorderId}/confirm
Mark the workorder as confirmed
1 param → 200400401404500
POST
/api/v1/workorder/{workorderId}/copy
Create a copy of a workorder
1 param body → 200400401404500
POST
/api/v1/workorder/{workorderId}/device-received
Mark the device associated with the workorder as received
1 param → 200400401404500
POST
/api/v1/workorder/{workorderId}/device-returned
Mark the device associated with the workorder as returned
1 param → 200400401404500
POST
/api/v1/workorder/{workorderId}/order
Change the order of one workorder within the grouping
1 param body → 200400401404500
POST
/api/v1/workorder/{workorderId}/prepay
Create a prepayment document based on the specified workorder and optionally add payments to it
1 param body → 200400401404500
POST
/api/v1/workorder/{workorderId}/quote
Generates a quote from the workorder
1 param → 200400401404500
POST
/api/v1/workorder/{workorderId}/settle
Settle workorders. Generate sales document and make payments
1 param body → 200400401404500
POST
/api/v1/workorder/{workorderId}/uncancel
Mark the workorder as not cancelled
1 param → 200400401404500
POST
/api/v1/workorder/{workorderId}/unconfirm
Mark the workorder as not confirmed
1 param → 200400401404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are WorkorderDocResponse (47 properties), WorkorderResponse (44 properties), WorkorderDocRequestPayment (29 properties), core.Translatable (25 properties). Each schema is shown below with its type and property counts.

BackupResponse
object
8 properties
model.WorkorderPrepayRequest
object
3 properties
WorkorderDocResponse
object
47 properties
core.Translatable
object
25 properties
WorkorderResponse
object
44 properties
WorkorderDocRequestPayment
object
29 properties
WorkorderOrderRequest
object
1 property
WorkorderRequest
object
21 properties
model.WorkorderSettleRequest
object
4 properties
model.WorkorderCopyRequest
object
7 properties
LabelResponse
object
6 properties
SalesDocument
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-workorder-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
AE Profile APIs.io
Erply Assortment To Product Linking API
AE Profile APIs.io
Erply Attributes API
AE Profile APIs.io
Erply auth API
AE Profile APIs.io
Erply Brand API
AE Profile APIs.io
Erply clsf API
AE Profile APIs.io
Erply clsf-device-properties API
AE Profile APIs.io
Erply clsf-events API
AE Profile APIs.io
Erply clsf-labels API
AE Profile APIs.io
Erply Country API
AE Profile APIs.io
Erply device API
AE Profile APIs.io
Erply event API
AE Profile APIs.io
#workorder
← Back to E APIs
API Details
ID
erply:erply-workorder-api
Base URL
https://api-pim-eu.erply.com
Docs
https://wiki.erply.com/article/1322-pim-api
Provider
Erply
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=erply-workorder-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/erply-workorder-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Erply workorder API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.