diff options
author | Jonathan Buchanan <jonathan.russ.buchanan@gmail.com> | 2020-07-17 02:54:13 -0400 |
---|---|---|
committer | Jonathan Buchanan <jonathan.russ.buchanan@gmail.com> | 2020-07-17 02:54:13 -0400 |
commit | 8a4460bfaaa22b0df490d621c35504690109874f (patch) | |
tree | b1f95ca982634e2c92afd957797945e6359dff74 /core/api-merchant.rst | |
parent | 8918201896dba4d55f7344ab0190252d57720633 (diff) | |
download | docs-8a4460bfaaa22b0df490d621c35504690109874f.tar.gz docs-8a4460bfaaa22b0df490d621c35504690109874f.tar.bz2 docs-8a4460bfaaa22b0df490d621c35504690109874f.zip |
spec merchant forget contract terms
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r-- | core/api-merchant.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index c56cff0c..9be0b2d6 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1046,6 +1046,39 @@ Payment processing } +.. http:patch:: /private/orders/$ORDER_ID/forget + + Forget fields in an order's contract terms that the merchant no + longer needs. + + **Request:** + + The request must be a `forget request <ForgetRequest>`. The fields specified + must have been marked as forgettable when the contract was created. + + **Response:** + + :status 200 OK: + The merchant deleted the specified fields from the contract of + order $ORDER_ID. + :status 400 Bad request: + The request is malformed or one of the paths is invalid. + :status 404 Not found: + The merchant backend could not find the order or the instance + and thus cannot process the abort request. + :status 409 Conflict: + The request includes a field that was not marked as forgettable, so + the merchant cannot delete that field. + + .. ts:def:: ForgetRequest + + interface ForgetRequest { + + // Array of valid JSON paths to forgettable fields in the order's + // contract terms. + fields: string[]; + } + .. http:get:: /private/orders/$ORDER_ID |