-
Notifications
You must be signed in to change notification settings - Fork 0
Refund (offers) request & delivery - 20260702 #72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
edwinvandenbelt
wants to merge
1
commit into
main
Choose a base branch
from
Refund
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+214
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| type: object | ||
| properties: | ||
| requestId: | ||
| type: string | ||
| description: a-sync | a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | ||
| packageId: | ||
| type: string | ||
| description: the reference of the package | ||
| version: | ||
| type: string | ||
| description: the new version of the package | ||
| summary: | ||
| type: string | ||
| description: textual explanaition, which parts are refunded | ||
| status: | ||
| type: string | ||
| description: enumeration for tracking the refund (offer status = refunded or scheduled_refund) | ||
| enum: | ||
| - offered | ||
| - refund_in_progress # for a-sync responses | ||
| - refunded | ||
| - scheduled_refund | ||
| delayedReimbursement: | ||
| type: string | ||
| format: date-time | ||
| description: in case the reimbursement will be settled in the future | ||
| problems: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: a list of string, describing blocking issues, in the requested language (or local if not the requested language is not supported) | ||
| warnings: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: a list of string, describing non-blocking issues, in the requested language (or local if not the requested language is not supported) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| type: object | ||
| required: | ||
| - refundOfferId | ||
| - packageId | ||
| - version | ||
| - refundableAmount | ||
| properties: | ||
| requestId: | ||
| type: string | ||
| description: a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | ||
| refundOfferId: | ||
| type: string | ||
| description: a unique ID, to identify the offer | ||
| summary: | ||
| type: string | ||
| description: human readable clarification of the offer, in the requested content language, if possible | ||
| fee: | ||
| $ref: '#/components/schemas/Price' | ||
| description: the fee to pay | ||
| refundableAmount: | ||
| $ref: '#/components/schemas/Price' | ||
| description: the amount that can be refunded | ||
|
|
||
| packageId: | ||
| type: string | ||
| description: the reference of the package | ||
| version: | ||
| type: string | ||
| description: the version of the package to (partial) refund | ||
| expiryTime: | ||
| type: string | ||
| format: date-time | ||
| description: expiry time of rollback window, ISO 8601 | ||
| problems: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: a list of string, describing blocking issues, in the requested language (or local if not the requested language is not supported) | ||
| warnings: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: a list of string, describing non-blocking issues, in the requested language (or local if not the requested language is not supported) | ||
| delayedReimbursement: | ||
| type: string | ||
| format: date-time | ||
| description: in case the reimbursement will be settled in the future | ||
| paymentMethod: | ||
| type: string | ||
| description: the method of payment used for the refund | ||
| status: | ||
| type: string | ||
| description: enumeration for tracking the offer | ||
| const: offered |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| type: object | ||
| required: | ||
| - packageId | ||
| - version | ||
| properties: | ||
| contentLanguage: | ||
| type: string | ||
| description: (policy) The language/localization of user-facing content, One IETF BCP 47 (RFC 5646) language tag. If missing, the local accepted language | ||
| requestId: | ||
| type: string | ||
| description: a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | ||
| packageId: | ||
| type: string | ||
| description: the reference of the package to refund | ||
| version: | ||
| type: string | ||
| description: the version of the package to (partial) refund | ||
| packageElementRefs: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: parts to refund | ||
| travellingEntityRefs: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: travelling entities to refund | ||
| fulfillmentRefs: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: fullfillments to refund | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| type: object | ||
| required: | ||
| - refundOfferId | ||
| - packageId | ||
| - version | ||
| properties: | ||
| contentLanguage: | ||
| type: string | ||
| description: (policy) The language/localization of user-facing content, One IETF BCP 47 (RFC 5646) language tag. If missing, the local accepted language | ||
| refundOfferId: | ||
| type: string | ||
| description: a unique ID, to identify the offer | ||
| packageId: | ||
| type: string | ||
| description: the reference of the package | ||
| version: | ||
| type: string | ||
| description: the version of the package to (partial) refund |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Refund Offers Request - delivery | ||
|
|
||
| _Required items_ | ||
|
|
||
| | object | description | | ||
| | --- | --- | | ||
| | REFUND OFFERS REQUEST | The request to obtain refund offers | | ||
| | REFUND OFFERS DELIVERY | The accompaning response | | ||
| | REFUND REQUEST | The request to claim a refund offers | | ||
| | REFUND DELIVERY | The accompaning response | | ||
|
|
||
| ## REFUND OFFERS REQUEST DETAILS | ||
|
|
||
| | field | type | optional/conditions | description | | ||
| | --- | --- | --- | --- | | ||
| | requestId | string | condition: a-sync | a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | | ||
| | contentLanguage | string | optional | (policy) The language/localization of user-facing content, One IETF BCP 47 (RFC 5646) language tag. If missing, the local accepted language | | ||
| | packageId | string | required | the reference of the package to refund | | ||
| | version | string | required | the version of the package to (partial) refund | | ||
| | packageElementRefs | list of string | optional | parts to refund | | ||
| | travellingEntityRefs | list of string | optional | travelling entities to refund | | ||
| | fulfillmentRefs | list of string | optional | fullfillments to refund | | ||
|
|
||
| ### Example (indicative) | ||
|
|
||
| ```json | ||
| { | ||
| "requestId": "32490-df324", | ||
| "packageId": "offer-1", | ||
| "version": "305e50bfa0767185c3f0987277b60f53" | ||
| } | ||
| ``` | ||
|
|
||
| ## REFUND OFFER DELIVERY DETAILS | ||
|
|
||
| | field | type | optional/conditions | description | | ||
| | --- | --- | --- | --- | | ||
| | requestId | string | condition: a-sync | a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | | ||
| | refundOfferId | string | required | a unique ID, to identify the offer | | ||
| | summary | string | required | human readable clarification of the offer, in the requested content language, if possible | | ||
| | fee | Price | required | the fee to pay | | ||
| | refundableAmount | Price | required | the amount that can be refunded | | ||
| | packageId | string | required | the reference of the package | | ||
| | version | string | required | the version of the package to (partial) refund | | ||
| | expiryTime | date-time | required | expiry time of rollback window, ISO 8601 | | ||
| | problems | list of string | required | a list of string, describing blocking issues, in the requested language (or local if not the requested language is not supported) | | ||
| | warnings | list of string | required | a list of string, describing non-blocking issues, in the requested language (or local if not the requested language is not supported) | | ||
| | delayedReimbursement | date-time | optional | in case the reimbursement will be settled in the future | | ||
| | paymentMethod | string | optional | | | ||
| | status | string | optional | enumeration for tracking the offer | | ||
|
|
||
| # REFUND | ||
|
|
||
| ## REFUND REQUEST DETAILS | ||
|
|
||
| | field | type | optional/conditions | description | | ||
| | --- | --- | --- | --- | | ||
| | requestId | string | condition: a-sync | a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | | ||
| | contentLanguage | string | optional | (policy) The language/localization of user-facing content, One IETF BCP 47 (RFC 5646) language tag. If missing, the local accepted language | | ||
| | refundOfferId | string | required | a unique ID, to identify the offer | | ||
| | packageId | string | required | the reference of the package | | ||
| | version | string | required | the version of the package to (partial) refund | | ||
|
|
||
| ## REFUND DELIVERY DETAILS | ||
|
|
||
| | field | type | optional/conditions | description | | ||
| | --- | --- | --- | --- | | ||
| | requestId | string | condition: a-sync | a unique ID, the response to this request MUST have the same ID (in case of a-sync call) | | ||
| | packageId | string | required | the reference of the package | | ||
| | version | string | required | the new version of the package | | ||
| | summary | string | required | textual explanaition, which parts are refunded | | ||
| | status | string | optional | enumeration for tracking the refund (offer status = refunded or scheduled_refund) | | ||
| | problems | list of string | required | a list of string, describing blocking issues, in the requested language (or local if not the requested language is not supported) | | ||
| | warnings | list of string | required | a list of string, describing non-blocking issues, in the requested language (or local if not the requested language is not supported) | |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An aftersales is a change on a transport contract = a fulfillment. A package is not a contract. Thus the fulfillment should be the central object of the request. Package Elements and Travellings parties are parts of the fulfillment to me canceled.