added AGO status to order response

This commit is contained in:
Mirjam Herald 2026-09-09 10:54:38 +02:00
parent 1ac734de96
commit b6a490c979
3 changed files with 569 additions and 440 deletions

View File

View File

@ -263,7 +263,8 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device": {
"device":
{
"externalDeviceId": "123e4567-e89b-12d3-a456-426614174000",
"alias": null,
},
@ -430,6 +431,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -494,11 +500,7 @@ paths:
{
"externalOrderLineId": null,
"productId": 1,
"vouchers":[
{
"voucherCode": "Voucher1234"
}
],
"vouchers": [{ "voucherCode": "Voucher1234" }],
"quantity": 1,
"validFrom": "2024-03-22T09:00:00",
"validUntil": null,
@ -540,9 +542,11 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "9d03ca60-d2ab-4429-830d-49e12d0a29d4",
"alias": null },
"alias": null,
},
"vouchers": [],
"totalAmount": 121,
"touchPoint":
@ -703,6 +707,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -795,9 +804,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -947,6 +957,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -1142,6 +1157,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -1176,9 +1196,10 @@ paths:
"externalOrderId": "bac3958b-804a-43e3-b5f7-0b0fffaae5b7",
"orderNumber": "123456",
"customerProfileId": 42,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": null
"alias": null,
},
"vouchers": [],
"totalAmount": 121,
@ -1387,7 +1408,8 @@ paths:
Add externalDeviceId:
summary: Add order externalDeviceId
description: Add order externalDeviceId
value: { "externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0"}
value:
{ "externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0" }
responses:
"200":
description: OK
@ -1565,6 +1587,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -1597,9 +1624,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device": {
"device":
{
"externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0",
"alias": null
"alias": null,
},
"vouchers": [],
"totalAmount": 121,
@ -1761,6 +1789,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -1877,11 +1910,7 @@ paths:
{
"externalOrderLineId": null,
"productId": 2,
"vouchers":[
{
"voucherCode": "HTM-787466"
}
],
"vouchers": [{ "voucherCode": "HTM-787466" }],
"quantity": 1,
"validFrom": "2024-03-22T09:00:00",
"validUntil": null,
@ -1969,7 +1998,8 @@ paths:
"taxAmount": null,
"amountExclTax": null,
"amountInclTax": 121,
"vouchers":[
"vouchers":
[
{
"issuedVoucherId": "8e405272-470f-4ed6-8303-791ab40e72b5",
"voucherCode": "HTM-787466",
@ -2018,14 +2048,14 @@ paths:
[
{
"mandatoryCustomerDataItemId": 8,
"customerDataItem": "padBirthDate"
"customerDataItem": "padBirthDate",
},
{
"mandatoryCustomerDataItemId": 4,
"customerDataItem": "emailAddress"
"customerDataItem": "emailAddress",
},
],
}
},
],
"quantity": 1,
"orderLineTerms":
@ -2132,6 +2162,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -2160,9 +2195,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -2312,6 +2348,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -2420,9 +2461,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -2551,9 +2593,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 0,
@ -2675,9 +2718,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -2827,6 +2871,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -2876,10 +2925,7 @@ paths:
Add voucher to orderLine:
summary: Add voucher to orderLine to receive voucher benefits for a specific product
description: Add voucher to orderLine to receive voucher benefits for a specific product
value:
{
"voucherCode": "VOUCHER786"
}
value: { "voucherCode": "VOUCHER786" }
responses:
"200":
description: OK
@ -2899,8 +2945,7 @@ paths:
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device": null,
"vouchers":[
],
"vouchers": [],
"totalAmount": 121,
"touchPoint":
{
@ -2942,7 +2987,8 @@ paths:
"taxAmount": null,
"amountExclTax": null,
"amountInclTax": 121,
"vouchers":[
"vouchers":
[
{
"orderVoucherId": "d271c79d-2d3f-477b-8e29-73c9b409a758",
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
@ -2992,14 +3038,14 @@ paths:
[
{
"mandatoryCustomerDataItemId": 8,
"customerDataItem": "padBirthDate"
"customerDataItem": "padBirthDate",
},
{
"mandatoryCustomerDataItemId": 4,
"customerDataItem": "emailAddress"
"customerDataItem": "emailAddress",
},
],
}
},
],
"quantity": 1,
"orderLineTerms":
@ -3106,6 +3152,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -3183,10 +3234,7 @@ paths:
Add voucher to concept order:
summary: Add voucher to orderLine to receive voucher benefits for a whole order
description: Add voucher to orderLine to receive voucher benefits for a whole order
value:
{
"voucherCode": "VOUCHER123"
}
value: { "voucherCode": "VOUCHER123" }
responses:
"200":
description: OK
@ -3206,7 +3254,8 @@ paths:
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device": null,
"vouchers":[
"vouchers":
[
{
"orderVoucherId": "d271c79d-2d3f-477b-8e29-73c9b409a758",
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
@ -3227,14 +3276,10 @@ paths:
"name": "Voucher",
},
"amountInclTax": -1000,
"requiredProducts":
[
],
"requiredProducts": [],
},
"mandatoryCustomerDataItems": [],
},
"mandatoryCustomerDataItems":
[
],
}
],
"totalAmount": 21,
"touchPoint":
@ -3383,6 +3428,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -3411,9 +3461,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -3563,6 +3614,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -3671,9 +3727,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -3820,12 +3877,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "valid",
"additionalRemarks": [],
"validationErrors": [],
},
],
@ -3853,9 +3916,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -3988,9 +4052,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -4148,12 +4213,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "valid",
"additionalRemarks": [],
"validationErrors": [],
},
],
@ -4208,9 +4279,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": null
"alias": null,
},
"vouchers": [],
"totalAmount": 121,
@ -4368,12 +4440,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "invalid",
"additionalRemarks": [],
"validationErrors":
[
{
@ -4407,9 +4485,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -4559,12 +4638,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "valid",
"additionalRemarks": [],
"validationErrors": [],
},
],
@ -4630,9 +4715,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -4917,9 +5003,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -5125,9 +5212,10 @@ paths:
"externalOrderId": "be8160b3-a7f7-4a63-ad63-09503b2fc4a3",
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -5399,9 +5487,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -5563,12 +5652,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "valid",
"additionalRemarks": [],
"validationErrors": [],
},
],
@ -5652,9 +5747,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -5816,12 +5912,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "valid",
"additionalRemarks": [],
"validationErrors": [],
},
],
@ -5907,9 +6009,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -6071,6 +6174,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -6168,9 +6276,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -6332,6 +6441,11 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
@ -6409,9 +6523,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 0,
@ -6514,9 +6629,10 @@ paths:
"externalOrderId": null,
"orderNumber": "ORD-123456",
"customerProfileId": 1337,
"device":{
"device":
{
"externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0",
"alias": "Mijn Android"
"alias": "Mijn Android",
},
"vouchers": [],
"totalAmount": 121,
@ -6666,12 +6782,18 @@ paths:
"ageFromInclusive": 4,
"ageToInclusive": 11,
},
"tatSecurity":
{
"isSecured": false,
"isAuthorized": false,
},
},
},
],
"orderAccountingStatuses": [],
"validationResult": "valid",
"additionalRemarks": [],
"validationErrors": [],
},
],

View File

@ -233,6 +233,13 @@ paths:
schema:
type: integer
example: 321
- name: touchpointId
in: query
required: false
description: Return only issued vouchers that were issued by a specific touchpoint.
schema:
type: integer
example: 3
- name: statusChangedAfter
in: query
required: false