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

Merge branch 'develop' into version/1

Browse Source
This commit is contained in:
Max Martens 2024-12-02 11:09:59 +01:00
commit 6a0f11a7fe
8 changed files with 7376 additions and 551 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/openapi/contracts/contracts-crud.yaml
View File

@ -27,7 +27,7 @@ paths:
type: integer type: integer
example: 1 example: 1
required: false required: false
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated. description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated, 6 = pending cancellation, 7 = pending termination.
responses: responses:
"200": "200":
description: OK description: OK
@ -53,7 +53,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
{ {
@ -70,7 +69,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
], ],
@ -98,7 +96,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 0, "highestInvoiceTerm": 0,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractVersions": "contractVersions":
[ [
{ {
@ -152,7 +149,7 @@ paths:
type: integer type: integer
explode: false explode: false
required: false required: false
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated. description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated, 6 = pending cancellation, 7 = pending termination.
- in: query - in: query
name: billingDay name: billingDay
schema: schema:
@ -206,7 +203,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractInvoices": "contractInvoices":
[ [
{ {
@ -265,7 +261,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractInvoices": "contractInvoices":
[ [
{ {
@ -351,7 +346,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractVersions": "contractVersions":
[ [
{ {
@ -429,7 +423,6 @@ paths:
"productName": "HTM 20% korting 2024", "productName": "HTM 20% korting 2024",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 2, "highestInvoiceTerm": 2,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
}, },
} }
responses: responses:
@ -878,6 +871,8 @@ paths:
{ "contractStatusId": 3, "name": "suspended" }, { "contractStatusId": 3, "name": "suspended" },
{ "contractStatusId": 4, "name": "cancelled" }, { "contractStatusId": 4, "name": "cancelled" },
{ "contractStatusId": 5, "name": "terminated" }, { "contractStatusId": 5, "name": "terminated" },
{ "contractStatusId": 6, "name": "pending cancellation" },
{ "contractStatusId": 7, "name": "pending termination" },
], ],
} }
/actiontypes: /actiontypes:
@ -892,7 +887,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ContractStatus" $ref: "#/components/schemas/ActionType"
example: example:
{ {
"actionTypes": "actionTypes":
@ -957,10 +952,6 @@ components:
highestInvoiceTerm: highestInvoiceTerm:
type: integer type: integer
example: 1 example: 1
xSpit:
type: string
format: uuid
example: 1c345237-4d84-47f0-93c2-7b94338e3355
contractVersions: contractVersions:
type: array type: array
items: items:
@ -1077,7 +1068,7 @@ components:
example: 2 example: 2
name: name:
type: string type: string
enum: [new, active, suspended, cancelled, terminated] enum: [new, active, suspended, cancelled, terminated, pending cancellation, pending termination]
example: active example: active
ActionType: ActionType:
type: object type: object

3
src/openapi/contracts/contracts-se.yaml
View File

@ -43,7 +43,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
{ {
@ -59,7 +58,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
] ]
@ -128,7 +126,6 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractVersions": "contractVersions":
[ [
{ {

285
src/openapi/customers/customers-crud-v2.yaml Normal file
View File

@ -0,0 +1,285 @@
openapi: "3.0.3"
info:
title: ABT Customers CRUD APIs v2
version: "1.0"
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
servers:
- url: https://api.integratielaag.nl/v1
paths:
/ovpaytokens:
get:
tags:
- Token
summary: Find OVpay tokens.
description: Find OVpay tokens.
parameters:
- in: query
name: ovPayTokenId
schema:
type: integer
example: 71
required: false
description: The id of the token.
- in: query
name: customerProfileId
schema:
type: integer
example: 12
required: false
description: The id of the customer profile.
- in: query
name: tokenTypeId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
required: false
description: Filter on possible token types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital.
- in: query
name: xTat
schema:
type: string
format: uuid
example: 700b0516-bf8b-4e6e-bf16-13bfeb078e23
explode: false
required: false
description: The XTAT of the token.
- in: query
name: xBot
schema:
type: string
format: uuid
example: de1a9a7a-a777-4473-889c-44a3bb07daae
explode: false
required: false
description: The XBOT of the token.
- in: query
name: alias
schema:
type: string
example: Mijn OV-pas
required: false
description: The alias of the token.
- in: query
name: lastDigits
schema:
type: integer
example: 3301
required: false
description: The last digits of the token.
- in: query
name: ovpasNumber
schema:
type: string
example: 63AW974
required: false
description: Number of the OVpas.
- in: query
name: tokenStatusId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
required: false
description: Filter on possible token statuses. 1 = expired, 2 = active, 3 = replaced, 4 = inactive, 5 = suspended, 6 = removed by customer.
- in: query
name: expirationDate
schema:
type: string
format: date-time
example: 2029-03-22T09:00:00
required: false
description: The expiration date of the token.
- in: query
name: replacedByTokenId
schema:
type: integer
example: 12
required: false
description: The id of the token that replaced this token.
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"ovPayTokens":
[
{
"ovPayTokenId": 71,
"customerProfileId": 12,
"tokenType":
{ "tokenTypeId": 2, "name": "OV-pas physical" },
"xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23",
"xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae",
"alias": "Mijn OV-pas",
"lastDigits": 3301,
"ovpasNumber": "63AW974",
"tokenStatus": { "tokenStatusId": 2, "name": "Active" },
"expirationDate": "2029-03-22T09:00:00",
"replacedByTokenId": 12,
},
],
"href": null,
}
/directdebitmandates:
get:
tags:
- Mandates
summary: Find direct debit mandates.
description: Find direct debit mandates.
parameters:
- in: query
name: directDebitMandateId
schema:
type: integer
example: 71
required: false
description: The id of the direct debit mandate.
- in: query
name: customerProfileId
schema:
type: integer
example: 12
required: false
description: The id of the customer related to the mandate.
- in: query
name: billingInformationId
schema:
type: integer
example: 51
required: false
description: The id of the billing information related to the mandate.
- in: query
name: directDebitMandateTypeId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
required: false
description: The id of the direct debit mandate type. 1 = Paper contract, 2 = PIN transaction, 3 = SEPA eMandate, 4 = Digital signature, 5 = iDEAL transaction.
- in: query
name: mandateAddressId
schema:
type: integer
example: 21
required: false
description: The id of the address related to the mandate.
- in: query
name: createdBefore
schema:
type: string
format: date-time
example: 2020-12-31T23:59:59
required: false
description: Filter on created before.
- in: query
name: createdAfter
schema:
type: string
format: date-time
example: 2020-01-01T00:00:00
required: false
description: Filter on created after.
- in: query
name: mandateReference
schema:
type: string
example: CORE01
required: false
description: Filter on mandate reference.
- in: query
name: mandateState
schema:
type: array
items:
type: string
example: [SIGNED, PREPARED]
explode: false
required: false
description: Filter on possible states of the mandate. SIGNED = signed, PREPARED = prepared, CANCELLED = cancelled.
- in: query
name: updatedBefore
schema:
type: string
format: date-time
example: 2020-12-31T23:59:59
required: false
description: Filter on updated before.
- in: query
name: updatedAfter
schema:
type: string
format: date-time
example: 2020-01-01T00:00:00
required: false
description: Filter on updated after.
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
[
{
"directDebitMandateId": 71,
"customerProfileId": 12,
"billingInformationId": 51,
"directDebitMandateType": {
"directDebitMandateTypeId": 1,
"name": "import",
"description": "import"
},
"mandateAddressId": 21,
"created": "2024-03-22T08:55:00",
"mandateReference": "CORE01",
"mandateState": "SINGED",
"updateTimestamp": "2024-03-22T08:55:00"
},
]
components:
securitySchemes:
bearerToken:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
unavailable:
type: object
rfc9457:
type: object
properties:
type:
type: string
format: url
example: https://example.com/probs/out-of-credit
title:
type: string
example: You do not have enough credit.
detail:
type: string
example: Your current balance is 30, but that costs 50.
instance:
type: string
example: /account/12345/msgs/abc
balance:
type: string
example: 30
accounts:
type: array
items:
type: string
example:
- /account/12345
- /account/67890

5376
src/openapi/customers/customers.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

1047
src/openapi/customers/customers_reference-crud.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -9,23 +9,60 @@ paths:
/orders/validation: /orders/validation:
post: post:
tags: tags:
- Order Validation v2 - Order Validation v1 & v2
summary: Validate order. summary: Validate order.
description: Validate order. description: Validate order.
parameters: parameters:
- in: header - in: header
name: X-HTM-JWT-AUTH-HEADER name: X-HTM-JWT-AUTH-HEADER
required: true required: false
style: simple style: simple
explode: false explode: false
schema: schema:
type: string type: string
- in: header
name: Accept-version
required: false
style: simple
explode: false
schema:
type: string
example: "2.0"
description: The version of the API.
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: examples:
v1:
summary: Order validation v1
description: Order validation v1
value:
[
{
"ovPayTokenId": 2,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"productId": 2,
"startDate": "2024-03-22T09:00:00z",
"quantity": 1,
},
{
"ovPayTokenId": 3,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 89,
"ovpasNumber": "OV34567",
"productId": 4,
"startDate": "2024-03-22T09:00:00z",
"quantity": 4,
},
]
v2:
summary: Order validation v2
description: Order validation v2
value:
{ {
"purchaseDate": "2024-03-22", "purchaseDate": "2024-03-22",
"customerProfileId": 1337, "customerProfileId": 1337,
@ -89,13 +126,50 @@ paths:
}, },
} }
responses: responses:
"201": "200":
description: Created description: OK
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: examples:
v1:
summary: Order validation v1
description: Order validation v1
value:
{
"validContents": true,
"amountExclTax": 0,
"taxPercentage": 0,
"amountInclTax": 0,
"contents":
[
{
"ovPayTokenId": 0,
"serviceReferenceId": "string",
"ovpasNumber": "string",
"productId": 0,
"quantity": 0,
"amountExclTax": 0,
"taxPercentage": 0,
"amountInclTax": 0,
"startDate": "string",
"endDate": "string",
"isRenewable": true,
"nextDebitDate": "string",
"termAmountExclTax": 0,
"termAmountInclTax": 0,
"additionalRemarks":
[{ "code": "string", "parameter": "string" }],
"validationErrors":
[{ "detail": "string", "pointer": "string" }],
},
],
}
v2:
summary: Order validation v2
description: Order validation v2
value:
{ {
"validContents": true, "validContents": true,
"purchaseDate": "2024-03-22", "purchaseDate": "2024-03-22",
@ -213,13 +287,13 @@ paths:
/orders/{orderId}/fulfillment: /orders/{orderId}/fulfillment:
post: post:
tags: tags:
- Order Fulfillment v2 - Order Fulfillment v1 & v2
summary: Fulfill an order. summary: Fulfill an order.
description: Fulfill an order. description: Fulfill an order.
parameters: parameters:
- in: header - in: header
name: X-HTM-JWT-AUTH-HEADER name: X-HTM-JWT-AUTH-HEADER
required: true required: false
style: simple style: simple
explode: false explode: false
schema: schema:
@ -233,12 +307,64 @@ paths:
type: string type: string
format: uuid format: uuid
example: a0ef57fa-395c-4a03-96e9-234c26dccea9 example: a0ef57fa-395c-4a03-96e9-234c26dccea9
- in: header
name: Accept-version
required: false
style: simple
explode: false
schema:
type: string
example: "2.0"
description: The version of the API.
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: examples:
v1:
summary: Order fulfillment v1
description: Order fulfillment v1
value:
{
"customerProfileID": 123415,
"customerProfileData": { "dateOfBirth": "09-03-1989" },
"personalAccountData": { "birthdate": "09-03-1989" },
"directDebitMandate":
{
"consumerName": "J. de Tèster",
"consumerBic": "RABONL2U",
"consumerIban": "NL44RABO0123456789",
},
"orderContents":
[
{
"ovPayTokenId": 123,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 450,
"ovpasNumber": "63AW974",
"productId": 2,
"startDate": "2024-03-22T09:00:00Z",
"quantity": 1,
"orderlineId": "2d7fadc9-b64b-4516-9a7d-cf550f201372",
},
{
"ovPayTokenId": 123,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 450,
"ovpasNumber": "63AW974",
"productId": 3,
"startDate": "2024-03-16T09:00:00Z",
"quantity": 1,
"orderlineId": "9d7fadc9-b64b-4516-9a7d-cf550f201378",
},
],
"orderStatus": "succeededPayment",
}
v2:
summary: Order fulfillment v2
description: Order fulfillment v2
value:
{ {
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9", "orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
"customerProfileId": 1337, "customerProfileId": 1337,
@ -350,7 +476,15 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: examples:
v1:
summary: Order fulfillment v1
description: Order fulfillment v1
value: {}
v2:
summary: Order fulfillment v2
description: Order fulfillment v2
value:
{ {
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9", "orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
"orderNumber": "123456", "orderNumber": "123456",
@ -485,6 +619,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"orders":
[ [
{ {
"orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d", "orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
@ -492,7 +628,13 @@ paths:
"orderNumber": "123456", "orderNumber": "123456",
"customerProfileId": 42, "customerProfileId": 42,
"totalAmount": 121, "totalAmount": 121,
"touchPointId": 1, "touchPoint":
{
"salesTouchpointId": 3,
"name": "Website (Perplex)",
"isActive": true,
"retailerId": 1001,
},
"language": "language":
{ {
"languageId": 1, "languageId": 1,
@ -505,103 +647,19 @@ paths:
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus": "order_OrderStatus":
[
{ {
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"orderStatus": { "orderStatusId": 4, "name": "paid" }, "orderStatus":
{ "orderStatusId": 4, "name": "paid" },
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"description": "Order succesvol betaald", "description": "Order succesvol betaald",
}, },
{
"order_orderStatusId": "2b9b7943-3a74-4f2e-ad65-012b62c80821",
"orderStatus":
{ "orderStatusId": 3, "name": "pendingPayment" },
"createdOn": "2024-03-22T08:55:00",
"description": "Betaling in behandeling",
},
],
"orderLines":
[
{
"orderLineId": "7a7a9d1a-3fc8-4058-a28b-082860aaa311",
"externalOrderLineId": "f5fddff0-7fbd-4285-bccb-e584f431ea69",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxMetadata":
{
"taxMetadataId": "06270769-a263-4325-82d6-f49396f39d03",
"taxCode": "V21",
"taxPercentageAmount": 21,
"description": "21% BTW",
},
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"orderLineTerms":
[
{
"orderLineTermsId": "fe354db7-12ad-4fc1-bc63-a704c4e0d91e",
"termsUrl": "generalTermsAndConditions.pdf",
},
],
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatus":
{ "orderLineStatusId": 4, "name": "delivered" },
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenType":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"personalAccountData":
{
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{ "challengeTypeId": 1, "name": "email" },
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
"orderAccountingStatuses":
[
{
"orderAccountingStatusId": "7c5118d0-8535-4464-9239-83a7ba8fd2db",
"accountingStatus":
{ "accountingStatusId": 1, "name": "open" },
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
},
],
"payments": "payments":
[ [
{ {
"paymentId": "3ba4a3c7-0803-4214-800b-365851b8903d",
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"amountDebit": 121, "amountDebit": 121,
"paymentMethod":
{
"paymentMethodId": 1, "paymentMethodId": 1,
"name": "ideal",
"provider": "Buckaroo",
},
"touchPointId": 1, "touchPointId": 1,
"isRefund": false, "isRefund": false,
"htmPaymentReference": "HTM-1234", "htmPaymentReference": "HTM-1234",
@ -609,7 +667,6 @@ paths:
"paymentStatuses": "paymentStatuses":
[ [
{ {
"paymentStatusId": 1,
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"statusCode": "190", "statusCode": "190",
"statusDescription": "Success", "statusDescription": "Success",
@ -618,13 +675,8 @@ paths:
}, },
], ],
"mandateInput": "mandateInput":
{
"mandateInputId": "0a875e67-dc9f-4825-a030-d732a2adbfbc",
"directDebitMandateType":
{ {
"directDebitMandateTypeId": 1, "directDebitMandateTypeId": 1,
"name": "import",
},
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U", "bic": "RABONL2U",
"iban": "NL44RABO0123456789", "iban": "NL44RABO0123456789",
@ -633,31 +685,28 @@ paths:
}, },
}, },
], ],
"orderCustomer": "_links":
{ {
"orderCustomerId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50", "self":
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{ {
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", "href": "https://api.example.com/items/1",
"addressType": "method": "GET",
{ "addressTypeId": 1, "name": "Billing" }, "templated": true,
"street": "Kon. Julianaplein", },
"houseNumber": 10, },
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
}, },
], ],
"_links":
{
"self":
{
"href": "https://api.example.com/items",
"method": "GET",
"templated": true,
}, },
}, },
] "href": "string",
}
/orders: /orders:
parameters: parameters:
- in: header - in: header
@ -681,7 +730,13 @@ paths:
"externalOrderId": null, "externalOrderId": null,
"customerProfileId": 1337, "customerProfileId": 1337,
"totalAmount": 121, "totalAmount": 121,
"touchPointId": 1, "touchPoint":
{
"salesTouchpointId": 3,
"name": "Website (Perplex)",
"isActive": true,
"retailerId": 1001,
},
"languageId": 1, "languageId": 1,
"billingAddressId": 1, "billingAddressId": 1,
"shippingAddressId": 1, "shippingAddressId": 1,
@ -1036,7 +1091,7 @@ paths:
example: example:
{ {
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
"orderNumber": "ORD-123456" "orderNumber": "ORD-123456",
} }
delete: delete:
tags: tags:

48
src/openapi/products/products-crud-v2.2.yaml
View File

@ -59,6 +59,12 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": null, "sellableTouchPointIds": null,
"amountInclTax": null, "amountInclTax": null,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
@ -83,6 +89,7 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
1, 1,
2, 2,
@ -112,6 +119,7 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@ -139,6 +147,12 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": null, "sellableTouchPointIds": null,
"amountInclTax": null, "amountInclTax": null,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
@ -154,6 +168,7 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
1, 1,
2, 2,
@ -174,6 +189,12 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": [ "sellableTouchPointIds": [
1, 1,
2 2
@ -192,6 +213,12 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@ -219,6 +246,7 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@ -237,6 +265,12 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@ -2074,6 +2108,20 @@ components:
name: name:
type: string type: string
example: Kortingsabonnement example: Kortingsabonnement
tokenTypes:
type: array
items:
type: object
required:
- tokenTypeId
- name
properties:
tokenTypeId:
type: integer
example: 1
name:
type: string
example: EMV
sellableTouchPointIds: sellableTouchPointIds:
type: array type: array
items: items:

26
src/openapi/util/util-crud.yaml
View File

@ -86,6 +86,20 @@ paths:
example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf
required: false required: false
description: Pointer to executor of this action (e.g. the batch job). description: Pointer to executor of this action (e.g. the batch job).
- in: query
name: role
schema:
type: string
example: customer
required: false
description: Role of the user or process that initiated the action.
- in: query
name: user
schema:
type: string
example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
required: false
description: User that initiated the action. In case of a customer this is the customer id.
- in: query - in: query
name: resourceName name: resourceName
schema: schema:
@ -123,6 +137,8 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399", "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
"role": "customer",
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
"scheduledActionResources": "scheduledActionResources":
[ [
{ {
@ -157,6 +173,8 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399", "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
"role": "customer",
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
"scheduledActionResources": "scheduledActionResources":
[ [
{ {
@ -217,6 +235,8 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399", "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
"role": "customer",
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
"scheduledActionResources": "scheduledActionResources":
[ [
{ {
@ -390,6 +410,12 @@ components:
type: string type: string
format: uuid format: uuid
example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f
role:
type: string
example: customer
user:
type: string
example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
ScheduledActionType: ScheduledActionType:
type: object type: object
properties: properties: