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

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

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 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 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
1 param → 201400401500
DELETE
/api/v1/workorder/{workorderId}
Delete one workorder record
1 param → 200400401404500
PATCH
/api/v1/workorder/{workorderId}
Update workorder record
2 params → 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
2 params → 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
2 params → 200400401404500
POST
/api/v1/workorder/{workorderId}/prepay
Create a prepayment document based on the specified workorder and optionally add payments to it
2 params → 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
2 params → 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.

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

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