Repository navigation
Expand file tree
/
Copy pathopenapi.json
More file actions
593 lines (593 loc) · 30 KB
/
Copy pathopenapi.json
File metadata and controls
593 lines (593 loc) · 30 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
{
"openapi": "3.0.3",
"info": {
"title": "Supertext Order API",
"version": "1.1",
"description": "The Supertext Order API lets you place and manage **professional (human) translation** orders: upload content, request a quote, create orders, receive a completion callback, and download the finished translation.\n\nThis is the Basic-auth **Order API**. All endpoint paths are relative to the environment base URL.\n\n## Authentication\n\nThe Order API uses **HTTP Basic authentication**:\n\n- **username** = your Supertext account email\n- **password** = your **Order API Key** (from your Supertext account settings)\n\nSend it on every request as an `Authorization` header:\n\n Authorization: Basic BASE64(\"email:orderApiKey\")\n\n## Environments\n\nAll environments live under `supertext.com`:\n\n- **Production (live)** — `https://www.supertext.com`\n- **Staging** — `https://staging.supertext.com`\n- **Testing** — `https://testing.supertext.com`\n\nUse Staging or Testing for integration work; those orders are not billed and not translated by humans.\n\n## Order flow\n\n1. (optional) Verify credentials with **Account check**.\n2. Upload the content with **Upload a file** to get a DocumentId (or send it inline).\n3. Create the order(s) with **Create an order** — one order per target language.\n4. Supertext POSTs the completed order(s) to your **CallbackUrl** when finished.\n5. Download the **Final** file(s).\n\n## Order types & delivery\n\n`OrderTypeConfigurationId` selects the product/quality tier and is **account-specific** (e.g. 166 BASIC, 167 PREMIUM, 168 CREATIVE). `DeliveryId` selects speed: 1 = Express, 2 = 24h, 3 = 48h, 4 = 3 days, 5 = 1 week.",
"contact": {
"name": "Supertext",
"url": "https://www.supertext.com"
}
},
"servers": [
{ "url": "https://www.supertext.com", "description": "Production (live)" },
{ "url": "https://staging.supertext.com", "description": "Staging (non-billed integration)" },
{ "url": "https://testing.supertext.com", "description": "Testing (non-billed integration)" }
],
"security": [{ "basicAuth": [] }],
"tags": [
{ "name": "Account", "description": "Credential verification" },
{ "name": "Files", "description": "Upload and download documents" },
{ "name": "Orders", "description": "Quotes, orders, status and feedback" }
],
"paths": {
"/api/v1/translation/accountcheck": {
"get": {
"tags": ["Account"],
"summary": "Verify credentials",
"operationId": "accountCheck",
"responses": {
"200": { "description": "Credentials are valid." },
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/api/v1/files/files": {
"post": {
"tags": ["Files"],
"summary": "Upload a document to translate",
"operationId": "uploadFile",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": ["ElementId", "ElementTypeId", "DocumentTypeId", "file"],
"properties": {
"ElementId": { "type": "integer", "default": 0, "description": "0 = create a new element." },
"ElementTypeId": { "type": "integer", "default": 2, "description": "2 = file element." },
"DocumentTypeId": { "type": "integer", "default": 1, "enum": [1, 3], "description": "1 = original (source) document to translate; 3 = reference file (e.g. a screenshot) attached for the translator's context, not translated." },
"file": { "type": "string", "format": "binary", "description": "The file (use a real filename and content type, e.g. content.html / text/html, or screenshot.png / image/png)." }
}
}
}
}
},
"responses": {
"200": {
"description": "The uploaded document object(s). Use the returned Id as the DocumentId in an order's Files array.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Document" }
},
"example": [ { "Id": 3538699, "Name": "content.html", "DocumentType": "Original" } ]
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/api/v1/files/files/{orderId}": {
"get": {
"tags": ["Files"],
"summary": "List files for an order",
"operationId": "getFilesForOrder",
"parameters": [ { "$ref": "#/components/parameters/OrderId" } ],
"responses": {
"200": {
"description": "Files associated with the order.",
"content": {
"application/json": {
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileObject" } }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/api/v1/translation/quote": {
"post": {
"tags": ["Orders"],
"summary": "Get a quote",
"description": "Returns the word count, price, and available delivery options (with prices and delivery dates) for the given content, without placing an order. Upload the content first and reference it via Files (or send it inline via Groups). Select the product with OrderTypeConfigurationId + OrderTypeId.",
"operationId": "getQuote",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OrderRequest" },
"example": {
"OrderTypeConfigurationId": 167,
"OrderTypeId": 55,
"SourceLang": "de-CH",
"TargetLanguages": ["fr-CH", "en-US"],
"Files": [ { "Id": 380995, "Comment": "The main story" } ]
}
}
}
},
"responses": {
"200": {
"description": "The quote: word count, currency, and one Options entry per product with its delivery options.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/QuoteResponse" },
"example": {
"Currency": "CHF",
"CurrencySymbol": "CHF",
"WordCount": 28,
"Options": [
{
"Name": "Übersetzung PREMIUM",
"OrderTypeConfigurationId": 167,
"OrderTypeId": 55,
"ShortDescription": "For demanding content where every word counts",
"DeliveryOptions": [
{ "DeliveryId": 1, "Name": "Express", "Price": 90.0, "HourlyRate": null, "DeliveryDate": "2026-07-16T10:26:36Z", "IsDefaultDeliveryOption": false }
]
}
],
"AccountValid": true
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/api/v1.1/translation/order": {
"post": {
"tags": ["Orders"],
"summary": "Create an order",
"description": "Place a translation order. Returns one order object per target language. If CallbackUrl is set, Supertext POSTs the completed order object(s) to it when finished.",
"operationId": "createOrder",
"parameters": [
{
"name": "suppressConfirmationEmail",
"in": "query",
"required": false,
"schema": { "type": "boolean" },
"description": "Suppress the order confirmation email."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OrderRequest" },
"example": {
"OrderTypeConfigurationId": 6,
"DeliveryId": 1,
"OrderName": "Homepage translation",
"SourceLang": "de",
"TargetLanguages": ["fr-CH", "en-US"],
"ContentType": "text/html",
"CallbackUrl": "https://yourdomain.com/supertext/callback",
"ReferenceData": "ticket-4711",
"Files": [ { "Id": 3538699, "Comment": "File to translate" } ]
}
}
}
},
"responses": {
"200": {
"description": "One order object per target language.",
"content": {
"application/json": {
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderObject" } },
"example": [
{ "Id": 715113, "TargetLang": "fr-CH", "Status": "New", "ReferenceData": "ticket-4711" },
{ "Id": 715114, "TargetLang": "en-US", "Status": "New", "ReferenceData": "ticket-4711" }
]
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
},
"callbacks": {
"orderCompleted": {
"{$request.body#/CallbackUrl}": {
"post": {
"summary": "Order completed notification",
"description": "Sent by Supertext when the order is completed. Body is the order object(s), including the Final file(s). Respond 2xx to acknowledge.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{ "$ref": "#/components/schemas/OrderObject" },
{ "type": "array", "items": { "$ref": "#/components/schemas/OrderObject" } }
]
},
"example": {
"Id": 715113,
"Status": "Completed",
"ReferenceData": "ticket-4711",
"SourceLang": "de",
"TargetLang": "fr-CH",
"Files": [
{ "Id": 8811, "Name": "content.html", "DocumentType": "Original", "ContentType": "text/html" },
{ "Id": 8812, "Name": "content.html", "DocumentType": "Final", "ContentType": "text/html" }
]
}
}
}
},
"responses": {
"200": { "description": "Acknowledged." }
}
}
}
}
}
}
},
"/api/v1/order/{orderId}": {
"get": {
"tags": ["Orders"],
"summary": "Get an order",
"description": "Fetch a single order with its current status and files.",
"operationId": "getOrder",
"parameters": [ { "$ref": "#/components/parameters/OrderId" } ],
"responses": {
"200": {
"description": "The order.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OrderObject" }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
}
},
"patch": {
"tags": ["Orders"],
"summary": "Update an order",
"description": "Change the briefing, the requested deadline or the delivery speed of an order that already exists, using an RFC 6902 JSON Patch document. The body is an array of operations; `path` is a slash plus the property name in PascalCase, exactly as `GET /api/v1/order/{orderId}` returns it.\n\n**Access**\n\nWith a standard Order API account you can update the cost centre of your own orders. The other paths below are writable through the same endpoint but need the internal `Administrator` role, so your account receives `403 Forbidden` for them. Ask your Supertext contact if you need one of those changed.\n\nOn your own account use only `replace`, `add` or `remove`. `move` and `copy` are rejected with `403`, because their `from` path would reach a field you may not change.\n\n**Paths you can update**\n\n- `/CostCenter` (string, max 100 characters) - your cost centre, carried onto the invoice.\n\n**Paths that need the Administrator role**\n\n- `/OrderName` (string, max 100 characters) - the order title shown in Supertext and on the invoice.\n- `/AdditionalInformation` (string) - free-text instructions for the translator.\n- `/Background` (string) - background and purpose of the text.\n- `/TargetAudience` (string) - who will read the translation.\n- `/Deadline` (string) - requested delivery date, ISO 8601, e.g. `2026-07-20T10:00:00Z`. A value that cannot be parsed as a date clears the deadline.\n- `/DeliveryId` (integer) - delivery speed: 1 Express, 2 24 hours, 3 48 hours, 4 3 days, 5 1 week.\n- `/IndustryId` (integer) - subject area. Valid ids: `GET /api/v1/util/industries`.\n- `/TextTypeId` (integer) - text type. Valid ids: `GET /api/v1/util/texttype`.\n- `/TextStyleId` (integer) - writing style. Ids are product specific - ask Supertext.\n- `/Links` (array of `{ Url, Comment }`) - reference links for the translator. Replaces the whole list.\n- `/RecalculateDeadline` - not a field on the order: including this operation makes Supertext recompute `Deadline` from the order's delivery option, respecting business hours. It overrides any `/Deadline` sent in the same request.\n\n**Important**\n\n- Changing `/DeliveryId` or `/Deadline` does **not** reprice the order, and does not reschedule work that is already in production.\n- Only the paths above are written to the order. On a standard account anything else is rejected with `403`; with the `Administrator` role an unlisted property is instead accepted and silently ignored - a `204` does not mean the value was stored. Either way `CallbackUrl`, `ReferenceData`, `ContentType`, `Groups` and `Files` cannot be changed after the order is created, and the status has its own endpoint (`PUT /api/v1/order/status/{orderId}/{statusId}`).\n- Every change is written to the order's history, but nobody is notified. For a change to an order that is already being translated, contact Supertext.",
"operationId": "patchOrder",
"parameters": [ { "$ref": "#/components/parameters/OrderId" } ],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OrderPatch" },
"example": [
{ "op": "replace", "path": "/CostCenter", "value": "CC-4711" }
]
}
}
},
"responses": {
"204": { "description": "The patch was applied." },
"400": { "description": "The patch could not be applied - for example a price change on an order that has already been billed, or an unknown language code." },
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "description": "The patch touches a field the account may not update, uses move or copy, or the order does not belong to the account. Nothing is changed." },
"404": { "description": "No order was updated." },
"409": { "description": "The patch tried to change /Id, which is not permitted." },
"500": { "description": "The order id does not exist, path is not a property of the order, or the update failed." }
}
}
},
"/api/v1/order/feedback": {
"post": {
"tags": ["Orders"],
"summary": "Provide feedback / reject an order",
"operationId": "provideFeedback",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/FeedbackRequest" },
"example": {
"OrderId": 168110,
"PostEditing": "true",
"Rating": 4,
"Comments": [ { "Comment": "Please keep the product name untranslated." } ]
}
}
}
},
"responses": {
"200": { "description": "Feedback recorded." },
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/api/v1/order/status/{orderId}/{statusId}": {
"put": {
"tags": ["Orders"],
"summary": "Change an order's status",
"description": "Set an order's status. Commonly used to mark an order as Collected (statusId = 9).",
"operationId": "changeOrderStatus",
"parameters": [
{ "$ref": "#/components/parameters/OrderId" },
{
"name": "statusId",
"in": "path",
"required": true,
"schema": { "type": "integer" },
"description": "Target status id. 9 = Collected.",
"example": 9
}
],
"responses": {
"200": { "description": "Status updated." },
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/api/v1/customer/orders/current/{pageSize}/{page}/{personId}": {
"get": {
"tags": ["Orders"],
"summary": "List the current person's orders",
"operationId": "listCurrentOrders",
"parameters": [
{ "name": "pageSize", "in": "path", "required": true, "schema": { "type": "integer" }, "example": 50 },
{ "name": "page", "in": "path", "required": true, "schema": { "type": "integer" }, "example": 1 },
{ "name": "personId", "in": "path", "required": true, "schema": { "type": "integer" }, "example": 598 },
{
"name": "queryFilter[IgnoreOrderStatusIds][]",
"in": "query",
"required": false,
"schema": { "type": "integer" },
"description": "Exclude orders with the given status id (repeatable).",
"example": 22
}
],
"responses": {
"200": {
"description": "A page of orders.",
"content": {
"application/json": {
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderObject" } }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
},
"/storage/file/{fileId}/{fileName}": {
"get": {
"tags": ["Files"],
"summary": "Download a file",
"description": "Download a document by id (e.g. the finished 'Final' file). Older integrations may use /filedownloads/file/{fileId}/{fileName}.",
"operationId": "downloadFile",
"parameters": [
{ "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer" }, "example": 1964676 },
{ "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "translation.html" }
],
"responses": {
"200": {
"description": "The file contents.",
"content": {
"application/octet-stream": { "schema": { "type": "string", "format": "binary" } },
"text/html": { "schema": { "type": "string" } }
}
},
"401": { "$ref": "#/components/responses/Unauthorized" }
}
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic",
"description": "HTTP Basic: username = account email, password = Order API Key."
}
},
"parameters": {
"OrderId": {
"name": "orderId",
"in": "path",
"required": true,
"schema": { "type": "integer" },
"description": "Supertext order id.",
"example": 715113
}
},
"responses": {
"Unauthorized": {
"description": "Missing or invalid credentials.",
"content": {
"application/json": {
"schema": { "type": "object", "properties": { "Message": { "type": "string" } } }
}
}
}
},
"schemas": {
"OrderRequest": {
"type": "object",
"required": ["OrderTypeConfigurationId", "SourceLang", "TargetLanguages"],
"description": "Order (and quote) request. Provide content via exactly one of `Files` or `Groups`. An order additionally requires `DeliveryId` and `OrderName`; a quote additionally uses `OrderTypeId`.",
"properties": {
"OrderTypeConfigurationId": { "type": "integer", "description": "Product / quality tier (account-specific).", "example": 6 },
"OrderTypeId": { "type": "integer", "description": "Matching product type id, used together with OrderTypeConfigurationId when requesting a quote (account-specific).", "example": 55 },
"DeliveryId": { "type": "integer", "description": "Delivery speed. 1=Express, 2=24h, 3=48h, 4=3 days, 5=1 week. Required for an order; omit for a quote (a quote returns the available delivery options).", "example": 1 },
"SourceLang": { "type": "string", "description": "Source language (2-letter or regional).", "example": "de" },
"TargetLanguages": { "type": "array", "items": { "type": "string" }, "description": "Target languages; one order is created per language.", "example": ["fr-CH", "en-US"] },
"OrderName": { "type": "string", "example": "Homepage translation" },
"ContentType": { "type": "string", "example": "text/html" },
"CallbackUrl": { "type": "string", "format": "uri", "description": "URL Supertext POSTs to on completion.", "example": "https://yourdomain.com/supertext/callback" },
"ReferenceData": { "type": "string", "description": "Opaque correlation string, echoed back in the callback.", "example": "ticket-4711" },
"AdditionalInformation": { "type": "string", "description": "Free-text instructions for the translator." },
"Currency": { "type": "string", "example": "chf" },
"Deadline": { "type": "string", "description": "ISO-8601 desired deadline.", "example": "2026-02-09T13:46:47.0000000" },
"ServiceTypeId": { "type": "integer", "description": "Older service type (quote); account-specific.", "example": 46 },
"Referrer": { "type": "string", "example": "X-System Integration" },
"SystemName": { "type": "string", "example": "WordPress" },
"SystemVersion": { "type": "string", "example": "6.7" },
"ComponentName": { "type": "string", "example": "supertext-polylang" },
"ComponentVersion": { "type": "string", "example": "1.0" },
"Links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } },
"Files": { "type": "array", "items": { "$ref": "#/components/schemas/FileRef" }, "description": "Reference previously uploaded documents." },
"Groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" }, "description": "Inline content." }
}
},
"FileRef": {
"type": "object",
"required": ["Id"],
"properties": {
"Id": { "type": "integer", "description": "DocumentId returned by the upload endpoint.", "example": 3538699 },
"Comment": { "type": "string", "nullable": true }
}
},
"Group": {
"type": "object",
"properties": {
"GroupId": { "type": "string", "example": "Group1" },
"Context": { "type": "string", "nullable": true, "example": "Some Node" },
"Items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupItem" } }
}
},
"GroupItem": {
"type": "object",
"required": ["Id", "Content"],
"properties": {
"Id": { "type": "string", "description": "Your identifier for the string (returned unchanged).", "example": "1" },
"Content": { "type": "string", "description": "Text/HTML to translate.", "example": "<div>Hello</div>" },
"Comment": { "type": "string", "nullable": true },
"Context": { "type": "string", "nullable": true }
}
},
"Link": {
"type": "object",
"properties": {
"Url": { "type": "string", "format": "uri", "example": "http://en.wikipedia.org/wiki/Amalfi_Cathedral" },
"Comment": { "type": "string", "example": "Background to the text" }
}
},
"PatchOperation": {
"type": "object",
"description": "A single RFC 6902 JSON Patch operation.",
"required": ["op", "path"],
"properties": {
"op": { "type": "string", "enum": ["replace"], "description": "Always replace.", "example": "replace" },
"path": {
"type": "string",
"description": "A slash plus the property name in PascalCase. Only the paths listed here are written to the order; any other property is accepted and silently ignored.",
"enum": [
"/OrderName",
"/AdditionalInformation",
"/Background",
"/TargetAudience",
"/CostCenter",
"/Deadline",
"/DeliveryId",
"/IndustryId",
"/TextTypeId",
"/TextStyleId",
"/Links",
"/RecalculateDeadline"
],
"example": "/CostCenter"
},
"value": { "description": "The new value; its type depends on the field being replaced.", "example": "Homepage translation (rev 2)" }
}
},
"OrderPatch": {
"type": "array",
"description": "JSON Patch document - the operations are applied in the order given.",
"items": { "$ref": "#/components/schemas/PatchOperation" }
},
"OrderObject": {
"type": "object",
"description": "An order. One is created per target language.",
"properties": {
"Id": { "type": "integer", "description": "OrderId.", "example": 715113 },
"Status": { "type": "string", "description": "Textual status, e.g. New, In progress, Quality check, Completed.", "example": "Completed" },
"SourceLang": { "type": "string", "example": "de" },
"TargetLang": { "type": "string", "example": "fr-CH" },
"OrderName": { "type": "string", "example": "Homepage translation" },
"ReferenceData": { "type": "string", "example": "ticket-4711" },
"Files": { "type": "array", "items": { "$ref": "#/components/schemas/FileObject" } }
}
},
"FileObject": {
"type": "object",
"properties": {
"Id": { "type": "integer", "example": 8812 },
"Name": { "type": "string", "example": "content.html" },
"DocumentType": { "type": "string", "enum": ["Original", "Final"], "description": "Final = the finished translation to download.", "example": "Final" },
"ContentType": { "type": "string", "example": "text/html" }
}
},
"Document": {
"type": "object",
"properties": {
"Id": { "type": "integer", "description": "DocumentId.", "example": 3538699 },
"Name": { "type": "string", "example": "content.html" },
"DocumentType": { "type": "string", "enum": ["Original", "Final", "Reference"], "description": "Reference = supporting material (e.g. a screenshot) for the translator; not translated.", "example": "Original" }
}
},
"FeedbackRequest": {
"type": "object",
"required": ["OrderId"],
"properties": {
"OrderId": { "type": "integer", "example": 168110 },
"PostEditing": { "type": "string", "example": "true" },
"Rating": { "type": "integer", "minimum": 1, "maximum": 5, "example": 4 },
"Comments": {
"type": "array",
"items": {
"type": "object",
"properties": { "Comment": { "type": "string" } }
}
}
}
},
"QuoteResponse": {
"type": "object",
"description": "Result of a quote request.",
"properties": {
"Currency": { "type": "string", "description": "Currency of the quoted prices (the account currency).", "example": "CHF" },
"CurrencySymbol": { "type": "string", "example": "CHF" },
"WordCount": { "type": "integer", "description": "Authoritative source word count for the submitted content.", "example": 28 },
"AccountValid": { "type": "boolean", "description": "false when the request was unauthenticated / the account can't order.", "example": true },
"Options": {
"type": "array",
"description": "One entry per requested product (OrderTypeConfigurationId).",
"items": { "$ref": "#/components/schemas/QuoteOption" }
}
}
},
"QuoteOption": {
"type": "object",
"properties": {
"Name": { "type": "string", "example": "Übersetzung PREMIUM" },
"OrderTypeConfigurationId": { "type": "integer", "example": 167 },
"OrderTypeId": { "type": "integer", "example": 55 },
"ShortDescription": { "type": "string", "example": "For demanding content where every word counts" },
"Description": { "type": "string" },
"DeliveryOptions": {
"type": "array",
"description": "Available delivery speeds for this product + language pair. Not every language pair offers the same set — build delivery choices from this list.",
"items": { "$ref": "#/components/schemas/DeliveryOption" }
}
}
},
"DeliveryOption": {
"type": "object",
"properties": {
"DeliveryId": { "type": "integer", "description": "1=Express, 2=24h, 3=48h, 4=3 days, 5=1 week.", "example": 1 },
"Name": { "type": "string", "example": "Express" },
"Price": { "type": "number", "format": "float", "example": 90.0 },
"HourlyRate": { "type": "number", "format": "float", "nullable": true },
"DeliveryDate": { "type": "string", "format": "date-time", "example": "2026-07-16T10:26:36Z" },
"IsDefaultDeliveryOption": { "type": "boolean", "example": false }
}
}
}
}
}