HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

review commentaar

Browse Source
This commit is contained in:
Mirjam Herald 2025-04-28 10:38:30 +02:00
parent 52d4d21871
commit 323f1c195c
1 changed files with 174 additions and 187 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
src/openapi/orders/service_engine_orders.yaml
View File

@ -808,7 +808,7 @@ paths:
description: xTat used in order fulfillment. Note that this is a joined parameter via PurchasedProduct. description: xTat used in order fulfillment. Note that this is a joined parameter via PurchasedProduct.
tags: tags:
- Order Retrieval v1 & v2 - Order Retrieval v1 & v2
summary: Find orders. P3 summary: Find orders. P1
description: Find orders. description: Find orders.
responses: responses:
"200": "200":
@ -1009,7 +1009,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "invalid",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -1056,9 +1056,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Order creation v2.1 summary: Order creation v2.2
description: Order creation v2.1 description: Order creation v2.2
value: value:
{ {
"externalOrderId": null, "externalOrderId": null,
@ -1332,7 +1332,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
value: value:
{ {
"validContents": false, "validContents": false,
@ -1425,7 +1425,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "invalid",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -1499,7 +1499,7 @@ paths:
get: get:
tags: tags:
- Order Retrieval v1 & v2 - Order Retrieval v1 & v2
summary: Get a single order. summary: Get a single order. P1
description: Get a single order. description: Get a single order.
responses: responses:
"200": "200":
@ -1712,9 +1712,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Order update v2.1 summary: Order update v2.2
description: Order update v2.1 description: Order update v2.2
value: value:
{ {
"languageId": 1, "languageId": 1,
@ -1742,7 +1742,7 @@ paths:
v2.1: v2.1:
value: value:
{ {
"validContents": true, "validContents": false,
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
"externalOrderId": null, "externalOrderId": null,
"orderNumber": "ORD-123456", "orderNumber": "ORD-123456",
@ -1832,7 +1832,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "preliminary",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -2111,7 +2111,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "preliminary",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -2164,7 +2164,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -2231,25 +2231,15 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Update order line v2.1 summary: Update order line v2.2
description: Update order line v2.1 description: Update order line v2.2
value: value:
{ {
"quantity": 1, "quantity": 1,
"validFrom": "2024-03-25T09:00:00", "validFrom": "2024-03-25T09:00:00",
"validUntil": null, "validUntil": null,
} }
v3.0:
summary: Update order line v3.0, required for prolongation
description: Update order line v3.0, required for prolongation
value:
{
"productId": 49,
"quantity": 1,
"validFrom": "2024-03-25T09:00:00",
"validUntil": null,
}
v1.2: v1.2:
summary: Orderline update v1.2 summary: Orderline update v1.2
description: Orderline update v1.2 description: Orderline update v1.2
@ -2344,7 +2334,7 @@ paths:
{ "orderLineStatusId": 1, "name": "pending" }, { "orderLineStatusId": 1, "name": "pending" },
"customerTokens": [], "customerTokens": [],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "preliminary",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -2356,8 +2346,7 @@ paths:
"parameter": "customerTokenId", "parameter": "customerTokenId",
}, },
], ],
"validationErrors": [ "validationErrors": [],
],
}, },
], ],
"payments": [], "payments": [],
@ -2366,7 +2355,7 @@ paths:
v2.1: v2.1:
value: value:
{ {
"validContents": true, "validContents": false,
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
"externalOrderId": null, "externalOrderId": null,
"orderNumber": "ORD-123456", "orderNumber": "ORD-123456",
@ -2456,7 +2445,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -2631,7 +2620,7 @@ paths:
v2.2: v2.2:
value: value:
{ {
"validContents": true, "validContents": false,
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
"externalOrderId": null, "externalOrderId": null,
"orderNumber": "ORD-123456", "orderNumber": "ORD-123456",
@ -2709,7 +2698,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "preliminary",
"additionalRemarks": [ "additionalRemarks": [
{ {
"code": "PERSONALACCOUNTDATA_BIRTHDATE_REQUIRED", "code": "PERSONALACCOUNTDATA_BIRTHDATE_REQUIRED",
@ -2843,10 +2832,8 @@ paths:
"personalAccountData": null} "personalAccountData": null}
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [ "additionalRemarks": [],
],
"validationErrors": [], "validationErrors": [],
}, },
], ],
@ -2934,7 +2921,7 @@ paths:
{ "orderLineStatusId": 1, "name": "pending" }, { "orderLineStatusId": 1, "name": "pending" },
"customerTokens": [], "customerTokens": [],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "preliminary",
"additionalRemarks": [ "additionalRemarks": [
{ {
"code": "CUSTOMERTOKEN_REQUIRED", "code": "CUSTOMERTOKEN_REQUIRED",
@ -3082,7 +3069,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -3221,7 +3208,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "invalid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [ "validationErrors": [
{ {
@ -3328,7 +3315,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -3364,9 +3351,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Add a payment v2.1 summary: Add a payment v2.2
description: Add a payment v2.1 description: Add a payment v2.2
value: value:
{ {
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
@ -3518,7 +3505,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -3566,7 +3553,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -3661,9 +3648,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Update payment v2.1 summary: Update payment v2.2
description: Update payment v2.1 description: Update payment v2.2
value: value:
{ {
"htmPaymentReference": "HTM-1234", "htmPaymentReference": "HTM-1234",
@ -3797,7 +3784,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -3995,7 +3982,7 @@ paths:
"description": "Order is aangemaakt", "description": "Order is aangemaakt",
}, },
], ],
"validationResult": false, "validationResult": "invalid",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -4129,9 +4116,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Add order customer v2.1 summary: Add order customer v2.2
description: Add order customer v2.1 description: Add order customer v2.2
value: value:
{ {
"birthname": "Jan", "birthname": "Jan",
@ -4276,7 +4263,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -4339,9 +4326,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Update order customer v2.1 summary: Update order customer v2.2
description: Update order customer v2.1 description: Update order customer v2.2
value: value:
{ {
"birthname": "Jan", "birthname": "Jan",
@ -4462,7 +4449,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": true, "validationResult": "valid",
"additionalRemarks": [], "additionalRemarks": [],
"validationErrors": [], "validationErrors": [],
}, },
@ -4525,9 +4512,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Add order customer address v2.1 summary: Add order customer address v2.2
description: Add order customer address v2.1 description: Add order customer address v2.2
value: value:
{ {
"addressTypeId": 3, "addressTypeId": 3,
@ -4652,7 +4639,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "preliminary",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -4716,9 +4703,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v2.1: v2.2:
summary: Update order customer address v2.1 summary: Update order customer address v2.2
description: Update order customer address v2.1 description: Update order customer address v2.2
value: value:
{ {
"addressTypeId": 3, "addressTypeId": 3,
@ -4830,7 +4817,7 @@ paths:
}, },
], ],
"orderAccountingStatuses": [], "orderAccountingStatuses": [],
"validationResult": false, "validationResult": "preliminary",
"additionalRemarks": "additionalRemarks":
[ [
{ {
@ -4984,7 +4971,7 @@ paths:
description: The JWT of the logged in customer (in case of a web shop). description: The JWT of the logged in customer (in case of a web shop).
post: post:
tags: tags:
- Order Fulfillment v1.1 - Order Fulfillment v2.2
summary: Fulfill an order without creating or updating the order as a resource. summary: Fulfill an order without creating or updating the order as a resource.
description: Fulfill an order without creating or updating the order as a resource. description: Fulfill an order without creating or updating the order as a resource.
responses: responses: