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

added get example orders register

Browse Source
This commit is contained in:
Mirjam Herald 2025-08-29 16:53:37 +02:00
parent 9d950f2f02
commit 30e789ac2c
1 changed files with 137 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -129,8 +129,6 @@ paths:
"iso639Code": "nl-NL",
"ietfCode": "nl",
},
"billingAddressId": 1,
"shippingAddressId": 1,
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatuses":
@ -325,6 +323,143 @@ paths:
},
"href": "string",
}
v2-register:
summary: Find orders v2 when called by a register touchpoint on HS
description: Find orders v2 when called by a register touchpoint on HS
value:
{
"orders":
[
{
"validContents": null,
"orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
"externalOrderId": "bac3958b-804a-43e3-b5f7-0b0fffaae5b7",
"orderNumber": "123456",
"customerProfileId": 42,
"totalAmount": 121,
"touchPoint":
{
"salesTouchpointId": 4,
"name": "SMP HS (Service Medewerker Portaal Holland Spoor)",
"isActive": true,
"retailerId": 1000,
},
"language":
{
"languageId": 1,
"name": "Nederlands",
"iso639Code": "nl-NL",
"ietfCode": "nl",
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatuses":
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"orderStatus":
{ "orderStatusId": 2, "name": "awaitingPayment"},
"createdOn": "2024-03-22T09:00:00",
"description": "Order succesvol betaald",
},
"orderLines": [
{
"orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468",
"externalOrderLineId": null,
"productId": 1,
"productName": "HTM Maandkorting 20%",
"fikoArticleNumber": "6609",
"productDescription": "HTM Maandkorting 20%",
"taxCode": "V21",
"taxPercentage": 21.0000,
"taxAmount": 21,
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"orderLineTerms":
[
{
"orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468",
"termsUrl": "generalTermsAndConditions.pdf",
},
{
"orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87",
"termsUrl": "productTermsAndConditions.pdf",
},
],
"createdOn": "2024-03-22T09:00:00",
"validFrom": "2024-03-22T09:00:00",
"validUntil":"2024-04-22T09:00:00",
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"customerTokens":
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenType":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6"
},
]
}
],
"payments":
[
{
"paymentId": "1a973c85-7a96-41b5-bbf2-7919d6a6db15",
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethod":
{
"paymentMethodId": 3,
"name": "pos",
"provider": "register",
},
"touchPoint":
{
"salesTouchpointId": 4,
"name": "SMP HS (Service Medewerker Portaal Holland Spoor)",
"isActive": true,
"retailerId": 1000,
},
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "",
"paymentStatuses": [],
"mandateInput": null
},
],
"_links":
{
"self":
{
"href": "https://api.example.com/items/1",
"method": "GET",
"templated": true,
},
"updatePayment":
{
"href": "https://api.example.com/items/1",
"method": "POST",
"templated": true,
}
}
}
],
"_links":
{
"self":
{
"href": "https://api.example.com/items",
"method": "GET",
"templated": true,
}
}
}
post:
tags:
- Order Creation v2