Orders

Order → UBL invoice and credit note

Checked out by you since 2026-11-13 15:50. Only you can change this project. Every save is committed to git; Check in lets others edit.

Key orders Runtime base /run/orders/ Versions per environment One

Orders runtime API v1.1.288

API reference · overview

Runtime API of project Orders: one POST per pipeline, the document streams back. Only pipelines run; a pipeline version pins the exact mapping versions it runs.

Endpoints

Pipelines

1.1.288

API version

Sample languages

AuthenticationAuthorization: ApiKey <key>

Every call needs an API key of this project, sent as Authorization: ApiKey <key>. The key decides the environment: the same call runs DEV, TEST or PROD by changing only the key. No session, no cookie — the runtime has its own security chain. Paste a key in the Connection field to run live requests from this page; it stays in this browser tab and never goes into a sample — the samples read it from MERLIN_API_KEY.

Problem codesRFC 9457 problem JSON — branch on code, never on the text

Code	Status	Meaning	Retry?
RUN_INPUT_MALFORMED	400	The input is not well-formed XML / JSON.	No
RUN_INPUT_TOO_LARGE	413	The input is too large.	No
RUN_OUTPUT_TOO_LARGE	422	The output is too large.	No
RUN_XSLT_DYNAMIC_ERROR	422	The transformation failed with a dynamic error.	No
RUN_TIMEOUT	422	The run took longer than the time limit.	Maybe, smaller input
RUN_RESOURCE_DENIED	422	The stylesheet may only read project resources.	No
RUN_VALUE_INVALID	422	A captured value does not fit its field type.	No
RUN_FIELDS_MISSING	422	A required capture field of an extraction step has no value.	No
RUN_NOT_FOUND	404	No pipeline with this key exists in this project.	No
RUN_NOT_DEPLOYED	409	This pipeline, or the version named, is not installed in the environment of the API key.	No
RUN_INACTIVE	503	The service is not available: the project or pipeline is deactivated; it runs again once it is activated.	Yes, once activated
RUN_UNSUPPORTED_MEDIA_TYPE	415	Send XML or JSON (raw, as a multipart/form-data file part, optionally gzip-encoded) in the format the target expects.	No
RUN_KEY_INVALID	401	The API key is missing, invalid, expired or not allowed here.	No
RUN_RATE_LIMITED	429	Too many requests with this API key. Try again later.	Yes, after Retry-After
RUN_PARAMETERS_INVALID	400	The stylesheet parameters are not valid.	No

Endpoint groups

Detect an order, build the UBL invoice, extract the totals