develop #38

Merged
bboterm merged 451 commits from develop into main 2025-11-19 14:28:14 +00:00
Showing only changes of commit 2bf79f1fa0 - Show all commits

View File

@ -4,12 +4,12 @@ info:
version: "1.0" version: "1.0"
description: Order APIs available in the Service Engine for order validation and fulfillment. description: Order APIs available in the Service Engine for order validation and fulfillment.
servers: servers:
- url: https://api.integratielaag.nl/v2 - url: https://api.integratielaag.nl/v1
paths: paths:
/orders/validation: /orders/validation:
post: post:
tags: tags:
- Order Validation v1 & v2 - Order Validation v1 & v1
summary: Validate order. summary: Validate order.
description: Validate order. description: Validate order.
parameters: parameters:
@ -133,9 +133,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
v1: v2:
summary: Order validation v1 summary: Order validation v2
description: Order validation v1 description: Order validation v2
value: value:
{ {
"validContents": true, "validContents": true,
@ -166,9 +166,9 @@ paths:
}, },
], ],
} }
v2: v1:
summary: Order validation v2 summary: Order validation v1
description: Order validation v2 description: Order validation v1
value: value:
{ {
"validContents": true, "validContents": true,
@ -186,7 +186,7 @@ paths:
"validFrom": "2024-03-22T09:00:00", "validFrom": "2024-03-22T09:00:00",
"validUntil": null, "validUntil": null,
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"isRenewable": true, "isRenewable": true,
@ -232,7 +232,7 @@ paths:
"validFrom": "2024-03-22T09:00:00", "validFrom": "2024-03-22T09:00:00",
"validUntil": null, "validUntil": null,
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"isRenewable": true, "isRenewable": true,
@ -437,7 +437,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -599,7 +599,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -730,7 +730,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).
get: get:
tags: tags:
- Order Retrieval v2.1 - Order Retrieval v1.1
summary: Get all orders for a specific customer. summary: Get all orders for a specific customer.
description: Get all orders for a specific customer. description: Get all orders for a specific customer.
responses: responses:
@ -871,7 +871,7 @@ paths:
example: 7208e73e-87a6-46d9-bb6d-867ffc460c9b example: 7208e73e-87a6-46d9-bb6d-867ffc460c9b
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 v2.1 - Order Retrieval v1.1
summary: Find orders. summary: Find orders.
description: Find orders. description: Find orders.
responses: responses:
@ -1073,9 +1073,9 @@ paths:
] ]
} }
} }
v2.2: v1.2:
summary: Order creation v2.2 summary: Order creation v1.2
description: Order creation v2.2 description: Order creation v1.2
value: value:
{ {
"externalOrderId": null, "externalOrderId": null,
@ -1182,9 +1182,9 @@ paths:
], ],
}, },
} }
v2: v1:
summary: Order creation v2.1 summary: Order creation v1.1
description: Order creation v2.1 description: Order creation v1.1
value: value:
{ {
"externalOrderId": null, "externalOrderId": null,
@ -1363,7 +1363,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -1394,9 +1394,10 @@ paths:
"fileType": "image/jpg", "fileType": "image/jpg",
"challengeTypeId": 1, "challengeTypeId": 1,
"oneTimePassword": "H5Iiz3JTaQeIV8p", "oneTimePassword": "H5Iiz3JTaQeIV8p",
}, }
}, },
], ],
"additionalRemarks" : []
}, },
], ],
"payments": "payments":
@ -1450,7 +1451,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ {
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
@ -1502,7 +1503,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).
get: get:
tags: tags:
- Order Retrieval v2.1 - Order Retrieval v1.1
summary: Get a single order. summary: Get a single order.
description: Get a single order. description: Get a single order.
responses: responses:
@ -1566,7 +1567,7 @@ paths:
"taxMetadata": "taxMetadata":
{ {
"taxMetadataId": "06270769-a263-4325-82d6-f49396f39d03", "taxMetadataId": "06270769-a263-4325-82d6-f49396f39d03",
"taxCode": "V21", "taxCode": "V11",
"taxPercentageAmount": 21, "taxPercentageAmount": 21,
"description": "21% BTW", "description": "21% BTW",
}, },
@ -1709,9 +1710,9 @@ paths:
"shippingAddressId": 1, "shippingAddressId": 1,
"lastUpdatedOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00",
} }
v2.2: v1.2:
summary: Order update v2.2 summary: Order update v1.2
description: Order update v2.2 description: Order update v1.2
value: { value: {
"customerProfileId": 1337, "customerProfileId": 1337,
"totalAmount": 121, "totalAmount": 121,
@ -1772,7 +1773,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -1806,6 +1807,13 @@ paths:
}, },
}, },
], ],
"additionalRemarks" :
[
{
"code": "MANDATE_REQUIRED",
"parameter": "directDebitMandateId"
}
]
}, },
], ],
"payments": "payments":
@ -1859,7 +1867,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ {
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
@ -1900,6 +1908,9 @@ paths:
responses: responses:
"200": "200":
description: OK description: OK
"400":
description: "Bad request"
/orders/{orderId}/orderlines: /orders/{orderId}/orderlines:
parameters: parameters:
- in: path - in: path
@ -1953,9 +1964,9 @@ paths:
}, },
] ]
} }
v2.2: v1.2:
summary: Create orderLine v2.2 summary: Create orderLine v1.2
description: Create orderLine v2.2 description: Create orderLine v1.2
value: value:
{ {
"externalOrderLineId": null, "externalOrderLineId": null,
@ -2055,7 +2066,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -2089,6 +2100,13 @@ paths:
}, },
}, },
], ],
"additionalRemarks" :
[
{
"code": "MANDATE_REQUIRED",
"parameter": "directDebitMandateId"
}
]
}, },
{ {
"orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71", "orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71",
@ -2098,7 +2116,7 @@ paths:
"productCode": "HTM-MND-40", "productCode": "HTM-MND-40",
"productDescription": "HTM Maandkorting 40%", "productDescription": "HTM Maandkorting 40%",
"taxAmount": 42, "taxAmount": 42,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 200, "amountExclTax": 200,
"amountInclTax": 242, "amountInclTax": 242,
"quantity": 1, "quantity": 1,
@ -2123,9 +2141,10 @@ paths:
"verificationCode": null , "verificationCode": null ,
"personalAccountData": null "personalAccountData": null
} }
] ],
"additionalRemarks" : []
} }
], ],
"payments": "payments":
[ [
{ {
@ -2177,7 +2196,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" }
"400": "400":
description: Bad request description: Bad request
@ -2243,9 +2262,9 @@ paths:
"validFrom": "2024-03-25T09:00:00", "validFrom": "2024-03-25T09:00:00",
"validUntil": null "validUntil": null
} }
v2.2: v1.2:
summary: Order creation v2.2 summary: Order creation v1.2
description: Order creation v2.2 description: Order creation v1.2
value: value:
{ {
"taxAmount": 21, "taxAmount": 21,
@ -2309,7 +2328,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -2342,7 +2361,14 @@ paths:
"oneTimePassword": "H5Iiz3JTaQeIV8p", "oneTimePassword": "H5Iiz3JTaQeIV8p",
} }
} }
] ],
"additionalRemarks" :
[
{
"code": "MANDATE_REQUIRED",
"parameter": "directDebitMandateId"
}
]
}, },
], ],
"payments": "payments":
@ -2396,7 +2422,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" }
"400": "400":
@ -2570,9 +2596,9 @@ paths:
"place": "Den Haag", "place": "Den Haag",
}, },
} }
v2.2: v1.2:
summary: Order creation v2.2 summary: Order creation v1.2
description: Order creation v2.2 description: Order creation v1.2
value: value:
{ {
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
@ -2654,7 +2680,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -2697,7 +2723,7 @@ paths:
"productCode": "HTM-MND-40", "productCode": "HTM-MND-40",
"productDescription": "HTM Maandkorting 40%", "productDescription": "HTM Maandkorting 40%",
"taxAmount": 42, "taxAmount": 42,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 200, "amountExclTax": 200,
"amountInclTax": 242, "amountInclTax": 242,
"quantity": 1, "quantity": 1,
@ -2776,7 +2802,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" }
/payments/{paymentId}: /payments/{paymentId}:
@ -2834,9 +2860,9 @@ paths:
"place": "Den Haag", "place": "Den Haag",
} }
} }
v2.2: v1.2:
summary: Order payment update v2.2 summary: Order payment update v1.2
description: Order payment update v2.2 description: Order payment update v1.2
value: value:
{ {
"htmPaymentReference": "HTM-1234", "htmPaymentReference": "HTM-1234",
@ -2888,7 +2914,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -2982,7 +3008,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" }
/orders/{orderId}/ordercustomers: /orders/{orderId}/ordercustomers:
@ -3036,9 +3062,9 @@ paths:
}, },
], ],
} }
v2.2: v1.2:
summary: Order payment update v2.2 summary: Order payment update v1.2
description: Order payment update v2.2 description: Order payment update v1.2
value: value:
{ {
"birthname": "Jan", "birthname": "Jan",
@ -3111,7 +3137,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -3169,7 +3195,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" }
/ordercustomers/{orderCustomerId}: /ordercustomers/{orderCustomerId}:
@ -3211,9 +3237,9 @@ paths:
"emailAddress": "jandevries@outlook.com", "emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01", "dateOfBirth": "1970-01-01",
} }
v2.2: v1.2:
summary: Order customer update v2.2 summary: Order customer update v1.2
description: Order customer update v2.2 description: Order customer update v1.2
value: value:
{ {
"birthname": "Jan", "birthname": "Jan",
@ -3274,7 +3300,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -3308,8 +3334,9 @@ paths:
}, },
}, },
], ],
"additionalRemarks" : []
} }
], ],
"payments": null, "payments": null,
"customer": "customer":
{ {
@ -3332,7 +3359,7 @@ paths:
] ]
} }
} }
v2.2: v1.2:
value: value:
{ "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" }
/ordercustomers/{orderCustomerId}/orderCustomerAddress: /ordercustomers/{orderCustomerId}/orderCustomerAddress:
@ -3364,8 +3391,8 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
v3.0: v3.0:
summary: Order customer address create v2.2 summary: Order customer address create v1.2
description: Order customer address create v2.2 description: Order customer address create v1.2
value: value:
{ {
"addressTypeId": 1, "addressTypeId": 1,
@ -3428,7 +3455,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -3462,8 +3489,15 @@ paths:
}, },
}, },
], ],
} "additionalRemarks" :
], [
{
"code": "MANDATE_REQUIRED",
"parameter": "directDebitMandateId"
}
]
}
],
"payments": null, "payments": null,
"customer": "customer":
{ {
@ -3515,8 +3549,8 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
v3.0: v3.0:
summary: Order customer address create v2.2 summary: Order customer address create v1.2
description: Order customer address create v2.2 description: Order customer address create v1.2
value: value:
{ {
"addressTypeId": 1, "addressTypeId": 1,
@ -3579,7 +3613,7 @@ paths:
"productCode": "HTM-MND-20", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%", "productDescription": "HTM Maandkorting 20%",
"taxAmount": 21, "taxAmount": 21,
"taxCode": "V21", "taxCode": "V11",
"amountExclTax": 100, "amountExclTax": 100,
"amountInclTax": 121, "amountInclTax": 121,
"quantity": 1, "quantity": 1,
@ -3613,8 +3647,15 @@ paths:
}, },
}, },
], ],
} "additionalRemarks" :
], [
{
"code": "MANDATE_REQUIRED",
"parameter": "directDebitMandateId"
}
]
}
],
"payments": null, "payments": null,
"customer": "customer":
{ {
@ -3656,7 +3697,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 v2.1 - Order Fulfillment v1.1
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: