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

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

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

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

This API exposes 3 operations across 3 paths, and defines 15 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 15 schemas 2 GET1 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 printout 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 — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

printout 3
GET
/api/v1/workorder/{workorderId}/printout/{templateId}/data
Get printout example dataset
2 params → 200400401500
GET
/api/v1/workorder/{workorderId}/printout/{templateId}/download
Generate and download printout file
3 params → 200400401500
POST
/api/v1/workorder/{workorderId}/printout/{templateId}/send
Send printout to customer
3 params → 202400401500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PrintoutRow (27 properties), PrintoutWorkorder (27 properties), core.Translatable (25 properties), PrintoutDevice (21 properties). Each schema is shown below with its type and property counts.

PrintoutRowTotal
object
3 properties
PrintoutDocument
object
8 properties
PrintoutWorkorderData
object
7 properties
PrintoutItem
object
11 properties
PrintoutCompany
object
18 properties
PrintoutRow
object
27 properties
PrintoutDevice
object
21 properties
PrintoutParty
object
9 properties
PrintoutAddress
object
8 properties
model.EmailPrintoutRequest
object
8 properties
PrintoutNote
object
6 properties
PrintoutPayment
object
12 properties
core.Translatable
object
25 properties
PrintoutWorkorder
object
27 properties
PrintoutVatRateTotal
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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