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

Order create v2. Init.

Browse Source
This commit is contained in:
Bas Boterman 2024-09-20 10:14:40 +02:00
parent b563dd3839
commit b30b432207
1 changed files with 73 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -210,12 +210,12 @@ paths:
}, },
], ],
} }
/orders/{orderId}/fulfillment: /orders:
post: post:
tags: tags:
- Order Fulfillment v2 - Order Create v2
summary: Order fulfillment summary: Create an order.
description: Order fulfillment. description: Create an order.
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: X-HTM-JWT-AUTH-HEADER
in: header in: header
@ -224,54 +224,86 @@ paths:
explode: false explode: false
schema: schema:
type: string type: string
- name: orderId
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/postOrderFulfillment" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"customerProfileID": 123415, "externalOrderId": "371940c1-4b58-40dd-aa59-608503a35efb",
"customerProfileData": { "dateOfBirth": "09-03-1989" }, "createdOn": "2024-03-22T09:00:00",
"personalAccountData": { "birthdate": "09-03-1989" }, "lastUpdatedOn": "2024-03-22T09:00:00",
"directDebitMandate": "orderNumber": "123456",
{ "customerProfileId": 1337,
"consumerName": "J. de Tèster", "totalAmount": 121,
"consumerBic": "RABONL2U", "touchPointId": 1,
"consumerIban": "NL44RABO0123456789", "billingAddressId": 1,
}, "shippingAddressId": 1,
"orderContents": "languageId": 1,
"orderStatus": 4,
"orderLines":
[ [
{ {
"ovPayTokenId": 123, "externalOrderLineid": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
"serviceReferenceId": "NLOV1234567ABCDEFG", "createdOn": "2024-03-22T09:00:00",
"amount": 450, "lastUpdatedOn": "2024-03-22T09:00:00",
"ovpasNumber": "63AW974", "productId": 1,
"productId": 2, "productName": "HTM Maandkorting 20%",
"startDate": "2024-03-22T09:00:00Z", "productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%",
"amountExclTax": 100,
"taxAmount": 21,
"taxCodeId": "V21",
"amountInclTax": 121,
"quantity": 1, "quantity": 1,
"orderlineId": "2d7fadc9-b64b-4516-9a7d-cf550f201372", "terms": "generalTermsAndConditions.pdf",
}, "validFrom": "2024-03-22T09:00:00",
{ "validUntil": null,
"ovPayTokenId": 123, "orderLineStatusId": 4,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 450,
"ovpasNumber": "63AW974",
"productId": 3,
"startDate": "2024-03-16T09:00:00Z",
"quantity": 1,
"orderlineId": "9d7fadc9-b64b-4516-9a7d-cf550f201378",
}, },
], ],
"orderStatus": "succeededPayment", "payments":
[
{
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
},
],
"customer":
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
[
{
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
} }
responses: responses:
"200": "200":