Merge pull request 'updated CRUD swagger' (#21) from features/OVPAY1986-aanpassingenOrderCRUD into develop

Reviewed-on: #21
Reviewed-by: Bas Boterman <b.boterman@htm.nl>
This commit was merged in pull request #21.
This commit is contained in:
MirjamHTM committed 2025-08-01 12:47:45 +00:00
commit 84b8b37a98
1 file changed
+385 -246
+385 -246
View File
@@ -1,4 +1,4 @@
openapi: "3.0.3"
openapi: 3.0.1
info:
title: ABT Orders CRUD APIs
version: "1.0"
@@ -10,7 +10,7 @@ paths:
get:
tags:
- Order
summary: P1. Find orders.
summary: Find orders.
description: Find orders.
servers:
- url: https://api.integratielaag.nl/v1
@@ -294,135 +294,154 @@ paths:
post:
tags:
- Order
summary: P1. Create a new order.
summary: Create a new order.
description: Create a new order.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"externalOrderId": "bac3958b-804a-43e3-b5f7-0b0fffaae5b7",
"customerProfileId": 1337,
"totalAmount": 121,
"touchPointId": 1,
"languageId": 1,
"createdOn": "2024-03-22T09:00:00",
"order_OrderStatus":
[
{
"orderStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"description": "Order succesvol betaald",
},
{
"orderStatusId": 3,
"createdOn": "2024-03-22T08:55:00",
"description": "Betaling in behandeling",
},
],
"orderLines":
[
{
"externalOrderLineId": "f5fddff0-7fbd-4285-bccb-e584f431ea69",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"fikoArticleNumber": "FIKO-1234",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxCode": "V21",
"taxPercentage": 21,
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"orderLineTerms":
[{ "termsUrl": "generalTermsAndConditions.pdf" }],
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"tokenTypeId": 1,
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"personalAccountData":
{
"name": "Jan de Vries",
"birthdate": "01-01-1970",
"photo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAAWJLR0Q+SWQA4wAAAAd0SU1FB+YCBAwmK58TFQgAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjItMDItMDRUMTI6Mzg6NDMrMDA6MDBAjYOrAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIyLTAyLTA0VDEyOjM4OjQzKzAwOjAwMdA7FwAAAFd6VFh0UmF3IHByb2ZpbGUgdHlwZSBpcHRjAAB4nOPyDAhxVigoyk/LzEnlUgADIwsuYwsTIxNLkxQDEyBEgDTDZAMjs1Qgy9jUyMTMxBzEB8uASKBKLgDqFxF08kI1lQAAAYdpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0n77u/JyBpZD0nVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkJz8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIj48cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPjx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+PC9yZGY6RGVzY3JpcHRpb24+PC9yZGY6UkRGPjwveDp4bXBtZXRhPg0KPD94cGFja2V0IGVuZD0ndyc/PiyUmAsAAAANSURBVBhXY3grk/YfAAXYAm/HQierAAAAAElFTkSuQmCC" ,
"challengeTypeId": 1,
"oneTimePassword": "H5Iiz3JTaQeIV8p",
}
},
],
"orderAccountingStatuses":
[
{
"accountingStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
},
],
"payments":
[
{
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
},
],
"orderCustomer":
examples:
Minimum order request body:
summary: Minimum order request
description: Minimum order request
value:
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
"totalAmount": 0,
"touchPointId": 1,
"createdOn": "2024-03-22T09:00:00",
"order_OrderStatus":
[
{
"addressTypeId": 3,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
"orderStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
}
],
},
}
}
Maximum order request :
summary: Maximum order request
description: Maximum order request
value:
{
"externalOrderId": "bac3958b-804a-43e3-b5f7-0b0fffaae5b7",
"customerProfileId": 1337,
"totalAmount": 121,
"touchPointId": 1,
"languageId": 1,
"createdOn": "2024-03-22T09:00:00",
"order_OrderStatus":
[
{
"orderStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"description": "Order succesvol betaald",
},
{
"orderStatusId": 3,
"createdOn": "2024-03-22T08:55:00",
"description": "Betaling in behandeling",
},
],
"orderLines":
[
{
"externalOrderLineId": "f5fddff0-7fbd-4285-bccb-e584f431ea69",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"fikoArticleNumber": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxPercentage": 21,
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"orderLineTerms":
[{ "termsUrl": "generalTermsAndConditions.pdf" }],
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"tokenTypeId": 1,
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"personalAccountData":
{
"name": "Jan de Vries",
"birthdate": "01-01-1970",
"photo": "DSC_0502.JPG",
"challengeTypeId": 1,
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
"orderAccountingStatuses":
[
{
"accountingStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
},
],
"payments":
[
{
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
},
],
"orderCustomer":
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
}
responses:
"201":
description: Created
@@ -446,7 +465,7 @@ paths:
required: true
description: The id of the order to process.
get:
summary: P1. Get a single order.
summary: Get a single order.
description: Get a single order.
tags:
- Order
@@ -627,7 +646,7 @@ paths:
},
}
patch:
summary: P1. Update an order.
summary: Update an order.
description: Update an order.
tags:
- Order
@@ -670,7 +689,7 @@ paths:
required: true
description: The id of the order to process.
post:
summary: P1. Add an order status.
summary: Add an order status.
description: Add an order status.
tags:
- Order
@@ -707,7 +726,7 @@ paths:
required: true
description: The id of the order to process.
post:
summary: P1. Add a single order line to an order.
summary: Add a single order line to an order.
description: Add a single order line to an order.
tags:
- Order Line
@@ -716,49 +735,63 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"externalOrderLineId": "f5fddff0-7fbd-4285-bccb-e584f431ea69",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"fikoArticleNumber": "FIKO-1234",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxCode": "V21",
"taxPercentage": 21,
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"orderLineTerms":
[{ "termsUrl": "generalTermsAndConditions.pdf" }],
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"tokenTypeId": 1,
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"personalAccountData":
examples:
Minimum orderline requestBody:
value:
{
"productId": 1,
"productName": "HTM Maandkorting 20%",
"productDescription": "HTM Maandkorting 20%",
"quantity": 0,
"orderLineTerms":
[{ "termsUrl": "generalTermsAndConditions.pdf" }],
"orderLineStatusId": 1,
"createdOn": "2024-03-22T09:00:00"
}
Maximum orderline requestBody:
value:
{
"externalOrderLineId": "f5fddff0-7fbd-4285-bccb-e584f431ea69",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"fikoArticleNumber": "FIKO-1234",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxCode": "V21",
"taxPercentage": 21,
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"orderLineTerms":
[{ "termsUrl": "generalTermsAndConditions.pdf" }],
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"birthdate": "01-01-1970"
"tokenTypeId": 1,
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"personalAccountData":
{
"birthdate": "01-01-1970"
},
},
},
],
"orderAccountingStatuses":
[
{
"accountingStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
}
],
"orderAccountingStatuses":
[
{
"accountingStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
}
responses:
"201":
description: Created
@@ -778,7 +811,7 @@ paths:
required: true
description: The id of the order to process.
post:
summary: P2. Add a payment to an order.
summary: Add a payment to an order.
description: Add a payment to an order.
tags:
- Payment
@@ -788,34 +821,46 @@ paths:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
Minimum orderline requestBody:
value:
{
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
}
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234"
}
Maximum orderline requestBody:
value:
{
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
}
responses:
"201":
description: Created
@@ -835,7 +880,7 @@ paths:
required: true
description: The id of the order to process.
post:
summary: P3. Add a customer to an order.
summary: Add a customer to an order.
description: Add a customer to an order.
tags:
- Customer
@@ -845,25 +890,32 @@ paths:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{
"addressTypeId": 3,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
}
Minimum orderCustomer requestBody:
value:
{
"emailAddress": "jandevries@outlook.com"
}
Maximum orderCustomer requestBody:
value:
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{
"addressTypeId": 3,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
}
responses:
"201":
description: Created
@@ -875,7 +927,7 @@ paths:
{ "orderCustomerId": "9c9ae71f-7de9-49f9-b676-b0fe103f6286" }
/orderlines:
get:
summary: P1. Find order lines.
summary: Find order lines.
description: Find order lines.
tags:
- Order Line
@@ -1115,8 +1167,8 @@ paths:
required: true
description: The id of the order line to process.
patch:
summary: P1. Update an order line.
description: Update an order line.
summary: Update an order line.
description: Update an order line. All possible fields that can be patched
tags:
- Order Line
requestBody:
@@ -1126,6 +1178,10 @@ paths:
$ref: "#/components/schemas/unavailable"
example:
{
"productId": 212,
"productName": "HTM maandkorting",
"fikoArticleNumber": "FIKO-1234",
"productDescription": "Reis met korting in HTM voertuigen",
"taxAmount": 21,
"taxCode": "V21",
"taxPercentage": 21,
@@ -1163,7 +1219,7 @@ paths:
required: true
description: The id of the order line to process.
post:
summary: P4. Add an accounting status to an order line.
summary: Add an accounting status to an order line.
description: Add an accounting status to an order line.
tags:
- Order Line
@@ -1200,7 +1256,7 @@ paths:
required: true
description: The id of the order line to process.
post:
summary: P3. Add a customer token to an order line.
summary: Add a customer token to an order line.
description: Add acustomer token to an order line.
tags:
- Order Line
@@ -1233,7 +1289,7 @@ paths:
{ "customerTokenId": "eeec597c-36c4-41b2-aeeb-ab5c32f2365d" }
/customertokens:
get:
summary: P3. Find customer tokens.
summary: Find customer tokens.
description: Find customer tokens.
tags:
- Order Line
@@ -1340,7 +1396,7 @@ paths:
required: true
description: The id of the customer token.
patch:
summary: P3. Update a customer token.
summary: Update a customer token.
description: Update a customer token.
tags:
- Order Line
@@ -1368,7 +1424,7 @@ paths:
example:
{ "customerTokenId": "0aedb483-2477-4720-aee6-7abcd016843b" }
delete:
summary: P1. Delete a customer token.
summary: Delete a customer token.
description: Delete a customer token.
tags:
- Order Line
@@ -1386,7 +1442,7 @@ paths:
required: true
description: The id of the customer token.
post:
summary: P3. Add personal account data to token.
summary: Add personal account data to token.
description: Add personal account data to token.
tags:
- Order Line
@@ -1467,7 +1523,7 @@ paths:
}
/personalaccountdata:
get:
summary: P5. Find personal account data.
summary: Find personal account data.
description: Find customer tokens.
tags:
- Order Line
@@ -1507,7 +1563,7 @@ paths:
name: photo
schema:
type: string
example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAIAAAD/gAIDAABV0UlEQVR4nFV9daBcxfX/OTNzZf25W9yIK4QQITjBnbZoixVaoEiRGlAo39ICLQWKtHhxd0sgBEgCIe6e57a+V2bm/P64uy/88gfse3vf7tyZI59jn4vj//Q6AAIQACICETAEAgAARCQiAAQARAAiACBEIAAEBAQAIh1chohDvyUCRAg+FgGp+JfBL6H0P2CIxTcASmsY+tvgRfFKwNIVBACADImICBhDIsLgsxGAgIBKlwMU11j8hqG3gg85+AYEtzn0Wxz6uuKqSusQpVeIyIg0lnaqeLulN4k0Av5/d1N8h0Fxp4LvRoKhu6VgA4GC/QYq7jIQEUMERCAd7Bpi8DGICEoTHdzS0i4O3U1p/QcvYGxoAzhDRMDi/QMg6uIrQEIqnhgd/CwM1ok09DOU5IMF0lCSGyBRFJvSmTDOSB/cY0QgIiBCQGCIUDo9rXVxxfgjmQAkLN4VQnEFxRslQEQGQAd3hYgAkSHkPC01mBwJSGqImCgYagIECG61eHFwp8G+Qun2itIKDAAZ5H1yJQVXaUCGFDUYZ6A0ICsupnhyxdODok7Qj94rySYNCSEiEIiDWnZQxfDg9gIgotYaWfBxBARcGNw2gTFEBgf/lbRNa2SIgESaNFHx96S1JqUAdPBlpZ3CrKfnNNknjY00JywN9O0B58X1maxHJgddVLQfLRGHvmxIfhEQGIHU5EiaUGPNaQ6NqjSiBqQ8+L7T+2RHLuvpsIBg96moKIHUlwQQCIcsS1FAikKFcPAyPOSut4oCpEuSNWQAgutLu0taGXbEZzzds9/p2e+nerWTY1wQABMmChMMC0xLmBYyjlwgN5AxYJwLkwthmLYdiRuGJd289n0uuMFZ2tW/mB6/7vAEMAQNAAQG39LhXfx6d87XBkNNQFCU7iFFGTKigUQwhq6iqIE3zys7cUxEWBxKphYQdvR4N3/Uv6HbjZhMBffIGAU2ryQ9GOgW6eD8hixpIDlDCi9KrzAwllCUfSiZbQgMKJE2I/Ge3Rv5itfq96yJe7l6g1m+BwqQQCM4BHkExVAhU4iMc4ncQ0bIJOMu8JRhd8VrC62TmuYcZ0XK8oVC2teHt4Sum1cmPaV0UaGlI8c2WieNiz6yMhmzGBGYHIa0ZcjdlBYGjKEndcxij51ce0iTKfPay6vgfkhrIhpZZTx0QvWZL3UlC0oUPQMNyQsGlglJEyFjwQYFlgbZkB0pno6AH+lhSQAD1zd0kgREZiS2d+WHkz96eAr66xONfVS1P9krGsYYFfUCiCmfKd/Q2laeKT1BSig/onyhFdOSayWAhMpFe9e7Pete/v7DxE9uPe6wyQnuHVIb0lprDYIRYGB2SGsos1lVmI+qNAYKen/KtwQSHbQMJS0sLlFqunNR5SGNlpOVhhAcAEgBaGAIgE5B11aIcyfG//rVQEUIpT7ojUruq2hRf+TWS3LJAICVTgpESV+LNiwwXMEHFK0VgGFHujZ9O/+jf9YzfX+WVxx+bGrtUj+dq7RTsWilTNSocMITBpkhLUyFSIz7KJSSQLpoDD3XX/F62IgvNOVvvYHnP3/k/373rGEheCCl4gyKPl1rjky76qjh4TPGhmIWU4z9eenASxuycZspXdwpjkgASpMhWNbV89vCR44OewVlcATQQ/4luJojkaQFbfZj3zEA4DjkIokdNIWBiztopg+aYiwqKQSSVVRMIAJCxB/hFmAMSWsQhvvdR346/+KEeY2jZ+iefWXRqGOaDbm+WXt6PNdhPhAHzcDkjHOBnBvC1IxrIB84ct7jy8+zHqtpeWfP9mFNifld+19f9v0pR83xnbwheOAXEDBAIhxwRLVR9BgMlYYfO12GLONrDjpmMk/pwYKc02QTFm1P6c41AAJpQIYMUVFdlBuc9eakxRGAIiZyZL7SSpPgKBhKTUiAjA2Z9oP/qIhXBGOMMQAAT4ImMAUKADUEFBEBQPtu9dxTvh4+tX76IitRSbnUdw/95uSoMTMevm3foDX+iJrqBj3YjdITTpa7+bD2ErIQc50qBjW2cLSvgEWdTB5g5C/u+OTVe0cPJGfmM2bIMCUDwQMJANJACIR5Vw1mZE9O7k3JD7YXlu11oibKom2GvKcXttoXTIs1x3nSgwe/GmRAJSNMRTXBg1oEAMCgO6fGVBo3zE3UxflLa7PvbMtxhnGLVYV40lFJR8dMLO1Q0agh5xQsqWQsheCYcTUS1Ua5abD+nBxwdMxEXsJpgKh9NzTskNaRk1UhJ3PpHU/cfmV620sFrAH5dEvk9vyAueiGiopqJ5fWWkvPcaXcX8iQlI6T73nzX0cV2m3l89Ezm066MtI8ZlCpb7v21Hkj173ZbnOwOHIGUmPWVVlJvXnqyclUQWU9XfCJM4yaqAkQgTNMO+r40dG/L6kGpUHpJg4Pn1jTnVPaUyWUC0C6aNBKYYTWUBdhjy+pNG0OJuYLevuA97OpsVkNdnWE9+blf77LvLo5FzIYFHFKAK+pqKZD6HfEHW8vaLUvnR4fUykMhj0F/f72wmOrklKDKZgqOQ4g0tKzYxU7Vrxz7if/MIV4buZ52WTf3B/evrDCvpOqnJ/eUVPb6OYyzDCJyBCmx1jfi/desmvpbrQ+n3VW5YKzOZFy8zwUQ87T6axSOogyWMlGIIDgaHDGgDgDjkCAmogjKAJFAAQvn1U3qtpwXSU4IyKGxBlTioAUMH7QWg1FMIhAxBlqTb4G5GxTlzO6UoQjDCSQIuQIAm5+b+D1LbmYydTBCG/I/RaDOXHxtLJbjkgAA/I0AQ23javmWdPrzMvf6VVEDDCAa5q0YYUGU/2jVrwcIvnoIaePPe4CoeTqyrp9nz91daz7v8/e1nfO7TUtYwrpfmFYBdLp5++5cNsnn0Sbdiy5rvWQWTKbVJpQGMrNgaa4JRAFEZEmxjCA+yX0U8RVqrTopKvLTIzbLCRYbZSBVIKXYiRgsog7eFGaAukY8pYEgExpTQABdJhSb2kirxAoL3quthmb3WS/tDHLGGpd1Cco+T6EojojpdYrrZQmVpRZ9DWFYvzR5cl7v0qWh7gKbKWSPFrW+/YjS756/vVR82ov+hO6ea21HS1r3/iN89r9N2Dfo7o8e+q1o6bMS+czyZf/dvaWDz+qGJU85/b6+lY3m0LG9VAsTcXICw4GzEM4sniDQwGgI+nsCdGfTIlX2ZB2dVWIGRyGkGQp1qODdr0YKv7IowFpItKERVWlUhQBAGQKBI6XvdGzbE8hanINQASBIdelaKSIJPzBtfDjDw6AGqO9g+qMl7p1ANBIG2ao58COcU/dkLTjfZfeV56oUNIHQCJlhuLZvvbd//3jmekdYEdeXnBF2e7vT9z48Yr68c75v68qr3byWcbFj5c4lH74/wBdyV4E56o1CYZpjy6YFLnlqApwQWniDKUqCkzg0zUBKwVyP3JKxexEEKhrAsNAYAgB+gi2mLMgvuxNy398nXppUzZqsiAsDvIZMGTYS6sSRVtfCsAAAUgzYpURURHmPVkpOAIxD9Fc+qzOZg4subappsnLJpkQpAmAe/l0tKqh+eI/bnjhjtaBfRct/de2nPNR7Tj7Z3+qile4hWJIVDzVIIY9uDvFOJExpP9v84poQWsdt5iSgETcYACB8wwMOWhNBgelQalApwgRiYqKpLUiIMGFYcPXuwoDBd0Wx5DBTM4cSYMu7E3633e6y/e5PXkVtTgACAYAoAm1JgBC9v+FyWIolwXFnQzyGJRzVU9OuooMDjwS61+zbPq2FRsnLayautDPp1EIAECGoAGF8J1sRVV939m3vfXAVfdXsa+1iWfdXJao9Ao55PxHEhPIKZXirWImBIkBECINyUUAmjRAzOZP/JD7dK9bHuKB6wQAX5MrwdOQdNSxI8NXzE5wk0BpUKUjIAKOgAgMfV+/9H3u7i+TrtQhgYIBZ+hr8hR4CgAobPLyEPeVLnja1wAIFmchA3XJNGBJGEVJval4K8CIkDgu3+eMrDCjJlvT6diek13+2hd5XTbtaFtw7YMeUlssOgsFkFn++m9Czq39duL8W+vrWtxCjjE+ZIKKUHhI/4aQMRDnIDVIBYIBQ9AUpJ6C9B4jgO19ngbUeigzSQjAEBnDf6xMfbvfOWF0aEyVUWVj1OIMwFU65ar9Kbml3/9kl7O+x4sYLGRwpUFr0hoR0TYgbBABQ8S8r7WmCTXWyErDYLC+x9/a70dNpkgPrQGAxNBOAQAAAyDOUHo0q8k+Y1wEDfz9Z6nHVvZEMn3HlBlv7d1sjJ7j5WU8bPKSeSWlrUh859rlx6x/10EqO/nKxomHOck+xkUp8kcqJcwQhxKkQ7uNaVfHLV4TZQN5nfNUSKAuyWKQZQuZrBRU/NgHBCtnKzvcFQeckIFRk4UEcoau1DlP5zwtCUMGS1hcaa2CZA7H/++7CQq+ais3bzuibEa9yQ0EAM/XdyxNvbolHzNRl+AHAIqDppHxIZjPEFoT3JNkEJ47PrQp1bC8ZczIXT3DNi278Nrz87zy5Q0ZR4JgqEkL0xxI9jV+/PhIcu6fePrI2ce66X4UYihmCmA1FgNAAADGkAVIGyDr09kTohdOjVXY0FOAP3+R/L7TDQnw1UEcQICAoIMkVCljN5QAjZqIyDRBwaecR0GyhDOMWoIhaArCxVK6ESBYi6+1p8BgGDH5X4+qGFNv+HmpJGhA22TXz4l/ud/JeMSL7gMhiCWLW/fj4yaSCjhj0qPhZfzl82rvufq0V7OwuNCz5ePXrj2y4Y/zYp6iYorPsLPvPHJGetfTtVNbTryE8hlAhsW8aIAMaUjtGEPGAhHBgoKevD682frDkWVtCRZmMLJG3DAnlnZ1xiXGEAOLxoq+gXHGSz8CFr8EkREW016coSnQEszgDBEIQWrSNFRIACz9ddbX5SExttp0FU2uLine truncated
example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAIAAAD/gAIDAABV0UlEQVR4nFV9daBcxfX/OTNzZf25W9yIK4QQITjBnbZoixVaoEiRGlAo39ICLQWKtHhxd0sgBEgCIe6e57a+V2bm/P64uy/88gfse3vf7tyZI59jn4vj//Q6AAIQACICETAEAgAARCQiAAQARAAiACBEIAAEBAQAIh1chohDvyUCRAg+FgGp+JfBL6H0P2CIxTcASmsY+tvgRfFKwNIVBACADImICBhDIsLgsxGAgIBKlwMU11j8hqG3gg85+AYEtzn0Wxz6uuKqSusQpVeIyIg0lnaqeLulN4k0Av5/d1N8h0Fxp4LvRoKhu6VgA4GC/QYq7jIQEUMERCAd7Bpi8DGICEoTHdzS0i4O3U1p/QcvYGxoAzhDRMDi/QMg6uIrQEIqnhgd/CwM1ok09DOU5IMF0lCSGyBRFJvSmTDOSB/cY0QgIiBCQGCIUDo9rXVxxfgjmQAkLN4VQnEFxRslQEQGQAd3hYgAkSHkPC01mBwJSGqImCgYagIECG61eHFwp8G+Qun2itIKDAAZ5H1yJQVXaUCGFDUYZ6A0ICsupnhyxdODok7Qj94rySYNCSEiEIiDWnZQxfDg9gIgotYaWfBxBARcGNw2gTFEBgf/lbRNa2SIgESaNFHx96S1JqUAdPBlpZ3CrKfnNNknjY00JywN9O0B58X1maxHJgddVLQfLRGHvmxIfhEQGIHU5EiaUGPNaQ6NqjSiBqQ8+L7T+2RHLuvpsIBg96moKIHUlwQQCIcsS1FAikKFcPAyPOSut4oCpEuSNWQAgutLu0taGXbEZzzds9/p2e+nerWTY1wQABMmChMMC0xLmBYyjlwgN5AxYJwLkwthmLYdiRuGJd289n0uuMFZ2tW/mB6/7vAEMAQNAAQG39LhXfx6d87XBkNNQFCU7iFFGTKigUQwhq6iqIE3zys7cUxEWBxKphYQdvR4N3/Uv6HbjZhMBffIGAU2ryQ9GOgW6eD8hixpIDlDCi9KrzAwllCUfSiZbQgMKJE2I/Ge3Rv5itfq96yJe7l6g1m+BwqQQCM4BHkExVAhU4iMc4ncQ0bIJOMu8JRhd8VrC62TmuYcZ0XK8oVC2teHt4Sum1cmPaV0UaGlI8c2WieNiz6yMhmzGBGYHIa0ZcjdlBYGjKEndcxij51ce0iTKfPay6vgfkhrIhpZZTx0QvWZL3UlC0oUPQMNyQsGlglJEyFjwQYFlgbZkB0pno6AH+lhSQAD1zd0kgREZiS2d+WHkz96eAr66xONfVS1P9krGsYYFfUCiCmfKd/Q2laeKT1BSig/onyhFdOSayWAhMpFe9e7Pete/v7DxE9uPe6wyQnuHVIb0lprDYIRYGB2SGsos1lVmI+qNAYKen/KtwQSHbQMJS0sLlFqunNR5SGNlpOVhhAcAEgBaGAIgE5B11aIcyfG//rVQEUIpT7ojUruq2hRf+TWS3LJAICVTgpESV+LNiwwXMEHFK0VgGFHujZ9O/+jf9YzfX+WVxx+bGrtUj+dq7RTsWilTNSocMITBpkhLUyFSIz7KJSSQLpoDD3XX/F62IgvNOVvvYHnP3/k/373rGEheCCl4gyKPl1rjky76qjh4TPGhmIWU4z9eenASxuycZspXdwpjkgASpMhWNbV89vCR44OewVlcATQQ/4luJojkaQFbfZj3zEA4DjkIokdNIWBiztopg+aYiwqKQSSVVRMIAJCxB/hFmAMSWsQhvvdR346/+KEeY2jZ+iefWXRqGOaDbm+WXt6PNdhPhAHzcDkjHOBnBvC1IxrIB84ct7jy8+zHqtpeWfP9mFNifld+19f9v0pR83xnbwheOAXEDBAIhxwRLVR9BgMlYYfO12GLONrDjpmMk/pwYKc02QTFm1P6c41AAJpQIYMUVFdlBuc9eakxRGAIiZyZL7SSpPgKBhKTUiAjA2Z9oP/qIhXBGOMMQAAT4ImMAUKADUEFBEBQPtu9dxTvh4+tX76IitRSbnUdw/95uSoMTMevm3foDX+iJrqBj3YjdITTpa7+bD2ErIQc50qBjW2cLSvgEWdTB5g5C/u+OTVe0cPJGfmM2bIMCUDwQMJANJACIR5Vw1mZE9O7k3JD7YXlu11oibKom2GvKcXttoXTIs1x3nSgwe/GmRAJSNMRTXBg1oEAMCgO6fGVBo3zE3UxflLa7PvbMtxhnGLVYV40lFJR8dMLO1Q0agh5xQsqWQsheCYcTUS1Ua5abD+nBxwdMxEXsJpgKh9NzTskNaRk1UhJ3PpHU/cfmV620sFrAH5dEvk9vyAueiGiopqJ5fWWkvPcaXcX8iQlI6T73nzX0cV2m3l89Ezm066MtI8ZlCpb7v21Hkj173ZbnOwOHIGUmPWVVlJvXnqyclUQWU9XfCJM4yaqAkQgTNMO+r40dG/L6kGpUHpJg4Pn1jTnVPaUyWUC0C6aNBKYYTWUBdhjy+pNG0OJuYLevuA97OpsVkNdnWE9+blf77LvLo5FzIYFHFKAK+pqKZD6HfEHW8vaLUvnR4fUykMhj0F/f72wmOrklKDKZgqOQ4g0tKzYxU7Vrxz7if/MIV4buZ52WTf3B/evrDCvpOqnJ/eUVPb6OYyzDCJyBCmx1jfi/desmvpbrQ+n3VW5YKzOZFy8zwUQ87T6axSOogyWMlGIIDgaHDGgDgDjkCAmogjKAJFAAQvn1U3qtpwXSU4IyKGxBlTioAUMH7QWg1FMIhAxBlqTb4G5GxTlzO6UoQjDCSQIuQIAm5+b+D1LbmYydTBCG/I/RaDOXHxtLJbjkgAA/I0AQ23javmWdPrzMvf6VVEDDCAa5q0YYUGU/2jVrwcIvnoIaePPe4CoeTqyrp9nz91daz7v8/e1nfO7TUtYwrpfmFYBdLp5++5cNsnn0Sbdiy5rvWQWTKbVJpQGMrNgaa4JRAFEZEmxjCA+yX0U8RVqrTopKvLTIzbLCRYbZSBVIKXYiRgsog7eFGaAukY8pYEgExpTQABdJhSb2kirxAoL3quthmb3WS/tDHLGGpd1Cco+T6EojojpdYrrZQmVpRZ9DWFYvzR5cl7v0qWh7gKbKWSPFrW+/YjS756/vVR82ov+hO6ea21HS1r3/iN89r9N2Dfo7o8e+q1o6bMS+czyZf/dvaWDz+qGJU85/b6+lY3m0LG9VAsTcXICw4GzEM4sniDQwGgI+nsCdGfTIlX2ZB2dVWIGRyGkGQDdr0YKv7IowFpItKERVWlUhQBAGQKBI6XvdGzbE8hanINQASBIdelaKSIJPzBtfDjDw6AGqO9g+qMl7BIG2ao58COcU/dkLTjfZfeV56oUNIHQCJlhuLZvvbd//3jmekdYEdeXnBF2e7vT9z48Yr68c75v68qr3byWcbFj5c4lH74/wBdyV4E56o1CYZpjy6YFLnlqApwQWniDKUqCkzg0zUBKwVyP3JKxexEEKhrAsNAYAgB+gi2mLMgvuxNy398nXppUzZqsiAsDvIZMGTYS6sSRVtfCsAAAUgzYpURURHmPVkpOAIxD9Fc+qzOZg4subappsnLJpkQpAmAe/l0tKqh+eI/bnjhjtaBfRct/de2nPNR7Tj7Z3+qile4hWJIVDzVIIY9uDvFOJExpP9v84poQWsdt5iSgETcYACB8wwMOWhNBgelQalApwgRiYqKpLUiIMGFYcPXuwoDBd0Wx5DBTM4cSYMu7E3633e6y/e5PXkVtTgACAYAoAm1JgBC9v+FyWIolwXFnQzyGJRzVU9OuooMDjwS61+zbPq2FRsnLayautDPAECGoAGF8J1sRVV939m3vfXAVfdXsa+1iWfdXJao9Ao55PxHEhPIKZXirWImBIkBECINyUUAmjRAzOZP/JD7dK9bHuKB6wQAX5MrwdOQdNSxI8NXzE5wk0BpUKUjIAKOgAgMfV+/9H3u7i+TrtQhgYIBZ+hr8hR4CgAobPLyEPeVLnja1wAIFmchA3XJNGBJGEVJval4K8CIkDgu3+eMrDCjJlvT6diek13+2hd5XTbtaFtw7YMeUlssOgsFkFn++m9Czq39duL8W+vrWtxCjjE+ZIKKUHhI/4aQMRDnIDVIBYIBQ9AUpJ6C9B4jgO19ngbUeigzSQjAEBnDf6xMfbvfOWF0aEyVUWVj1OIMwFU65ar9Kbml3/9kl7O+x4sYLGRwpUFr0hoR0TYgbBABQ8S8r7WmCTXWyErDYLC+x9/a70dNpkgPrQGAxNBOAQAAAyDOUHo0q8k+Y1wEDfz9Z6nHVvZEMn3HlBlv7d1sjJ7j5WU8bPKSeSWlrUh859rlx6x/10EqO/nKxomHOck+xkUp8kcqJcwQhxKkQ7uNaVfHLV4TZQN5nfNUSKAuyWKQZQuZrBRU/NgHBCtnKzvcFQeckIFRk4UEcoau1DlP5zwtCUMGS1hcaa2CZA7H/++7CQq+ais3bzuibEa9yQ0EAM/XdyxNvbolHzNRl+AHAIqDppHxIZjPEFoT3JNkEJ47PrQ8ZczIXT3DNi278Nrz87zy5Q0ZR4JgqEkL0xxI9jV+/PhIcu6fePrI2ce66X4UYihmCmA1FgNAAADGkAVIGyDr09kTohdOjVXY0FOAP3+R/L7TDQnw1UEcQICAoIMkVCljN5QAjZqIyDRBwaecR0GyhDOMWoIhaArCxVK6ESBYi6+1p8BgGDH5X4+qGFNv+HmpJGhA22TXz4l/ud/JeMSL7gMhiCWLW/fj4yaSCjhj0qPhZfzl82rvufq0V7OwuNCz5ePXrj2y4Y/zYp6iYorPsLPvPHJGetfTtVNbTryE8hlAhsW8aIAMaUjtGEPGAhHBgoKevD682frDkWVtCRZmMLJG3DAnlnZ1xiXGEAOLxoq+gXHGSz8CFr8EkREW016coSnQEszgDBEIQWrSNFRIACz9ddbX5SExttp0FU2us8bUGm5OMWSMgWCoLine truncated
required: false
description: A reference to the customer photo.
- in: query
@@ -1559,7 +1615,7 @@ paths:
required: true
description: The id of the personal account data.
patch:
summary: P5. Update personal account data.
summary: Update personal account data.
description: Update personal account data.
tags:
- Order Line
@@ -1588,16 +1644,90 @@ paths:
"personalAccountDataId": "47041fde-7044-42e6-9ab5-091c05ce32f5",
}
delete:
summary: P5. Delete personal account data.
summary: Delete personal account data.
description: Delete personal account data.
tags:
- Order Line
responses:
"200":
description: Ok
/orderlines/{orderLineId}/orderLineTerms:
parameters:
- in: path
name: orderLineId
schema:
type: string
format: uuid
example: 9ff2e034-ed4f-44d5-8f6c-d703bd4df332
required: true
description: The id of the order line to process.
post:
summary: Add a orderLine term to an order line.
description: Add a orderLine term to an order line.
tags:
- Order Line
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
termsUrl": "generalTermsAndConditions.pdf",
}
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{ "orderLineTermsId": "eeec597c-36c4-41b2-aeeb-ab5c32f2365d" }
/orderLineTerms/{orderLineTermsId}:
parameters:
- in: path
name: orderLineTermsId
schema:
type: string
format: uuid
example: 9ff2e034-ed4f-44d5-8f6c-d703bd4df332
required: true
description: The id of the order line terms to process.
patch:
summary: Update a orderLine term to an order line.
description: Update a orderLine term to an order line.
tags:
- Order Line
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"termsUrl": "generalTermsAndConditions.pdf",
}
responses:
"200":
description: Ok
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{ "orderLineTermsId": "eeec597c-36c4-41b2-aeeb-ab5c32f2365d" }
delete:
summary: Remove a orderLine term from an order line.
description: Remove a orderLine term from an order line.
tags:
- Order Line
responses:
"200":
description: OK
/payments:
get:
summary: P2. Find payments.
summary: Find payments.
description: Find payments.
tags:
- Payment
@@ -1752,7 +1882,7 @@ paths:
required: true
description: The id of the payment to process.
patch:
summary: P2. Update a payment.
summary: Update a payment.
description: Update a payment.
tags:
- Payment
@@ -1785,7 +1915,7 @@ paths:
required: true
description: The id of the payment to process.
post:
summary: P2. Add a payment status.
summary: Add a payment status.
description: Add a payment status.
tags:
- Payment
@@ -1794,14 +1924,23 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
}
examples:
Minimum orderPaymentStatus requestBody:
value:
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success"
}
Maximum orderPaymentStatus requestBody:
value:
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
}
responses:
"201":
description: Created
@@ -1816,7 +1955,7 @@ paths:
}
/mandateinputs:
get:
summary: P2. Find mandate inputs.
summary: Find mandate inputs.
description: Find mandate inputs.
tags:
- Payment
@@ -1923,7 +2062,7 @@ paths:
required: true
description: The id of the payment to process.
post:
summary: P2. Create a mandateInput.
summary: Create a mandateInput.
description: Create a mandateInput..
tags:
- Payment
@@ -1960,7 +2099,7 @@ paths:
required: true
description: The id of the mandate input to process.
delete:
summary: P2. Delete a mandate input.
summary: Delete a mandate input.
description: Delete a mandate input.
tags:
- Payment
@@ -1969,7 +2108,7 @@ paths:
description: Ok
/ordercustomers:
get:
summary: P3. Find customers on an order.
summary: Find customers on an order.
description: Find customers on an order.
tags:
- Customer
@@ -2070,7 +2209,7 @@ paths:
required: true
description: The id of the customer.
patch:
summary: P3. Update a customer on an order.
summary: Update a customer on an order.
description: Update a customer on an order.
tags:
- Customer
@@ -2107,7 +2246,7 @@ paths:
required: true
description: The id of the customer on the order.
post:
summary: P3. Add an addresses to a customer of the order.
summary: Add an addresses to a customer of the order.
description: Add an addresses to a customer of the order.
tags:
- Customer
@@ -2139,7 +2278,7 @@ paths:
}
/ordercustomeraddresses:
get:
summary: P3. Find addresses of a customer on an order.
summary: Find addresses of a customer on an order.
description: Find addresses of a customer on an order.
tags:
- Customer
@@ -2244,7 +2383,7 @@ paths:
required: true
description: The id of the customer address.
patch:
summary: P3. Update an address of a customer on an order.
summary: Update an address of a customer on an order.
description: Update an address of a customer on an order.
tags:
- Customer
@@ -2275,7 +2414,7 @@ paths:
"orderCustomerAddressId": "d5005529-d4f2-4552-a5b8-477dab7836ec",
}
delete:
summary: P3. Delete an address of a customer on an order.
summary: Delete an address of a customer on an order.
description: Delete an address of a customer on an order.
tags:
- Customer