diff options
author | priscilla <priscilla.huang@efrei.net> | 2022-11-25 05:52:40 -0500 |
---|---|---|
committer | priscilla <priscilla.huang@efrei.net> | 2022-11-25 05:52:40 -0500 |
commit | 137f2ce43a7e62aaeab409a52527ff0ea69071f3 (patch) | |
tree | 3355a954ec208835a912686dba00eae1365764c2 /core/api-merchant.rst | |
parent | 2179ee1d9742011875c52ddf21d52334e895f2d3 (diff) | |
download | docs-137f2ce43a7e62aaeab409a52527ff0ea69071f3.tar.gz docs-137f2ce43a7e62aaeab409a52527ff0ea69071f3.tar.bz2 docs-137f2ce43a7e62aaeab409a52527ff0ea69071f3.zip |
update
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r-- | core/api-merchant.rst | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 1469c815..53ffffcf 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -2982,19 +2982,19 @@ Adding templates .. http:post:: [/instances/$INSTANCE]/private/templates - This is used to create a template. + This is used to create a template. - **Request:** + **Request:** - The request must be a `TemplateAddDetails`. + The request must be a `TemplateAddDetails`. - **Response:** + **Response:** - :http:statuscode:`204 No content`: - The creation of the template is successful. - :http:statuscode:`404 Not found`: - The merchant instance is unknown or it is not in our data. + :http:statuscode:`204 No content`: + The creation of the template is successful. + :http:statuscode:`404 Not found`: + The merchant instance is unknown or it is not in our data. .. ts:def:: TemplateAddDetails @@ -3047,19 +3047,19 @@ Editing templates This is used to update a template. - **Request:** + **Request:** - The request must be a `TemplatePatchDetails`. + The request must be a `TemplatePatchDetails`. - **Response:** + **Response:** - :http:statuscode:`204 No content`: - The template has successfully modified. - :http:statuscode:`404 Not found`: - The template(ID) is unknown to the backend. - :http:statuscode:`409 Conflict`: - The provided information is inconsistent with the current state of the template. Changes made is the same with - another store. + :http:statuscode:`204 No content`: + The template has successfully modified. + :http:statuscode:`404 Not found`: + The template(ID) is unknown to the backend. + :http:statuscode:`409 Conflict`: + The provided information is inconsistent with the current state of the template. Changes made is the same with + another store. .. ts:def:: TemplatePatchDetails @@ -3086,14 +3086,14 @@ Inspecting template .. http:get:: [/instances/$INSTANCE]/private/templates - This is used to return the list of all the templates. + This is used to return the list of all the templates. - **Response:** + **Response:** - :http:statuscode:`200 OK`: + :http:statuscode:`200 OK`: The backend has successfully returned all the templates. Returns a `TemplateSummaryResponse`. - :http:statuscode:`404 Not found`: + :http:statuscode:`404 Not found`: The backend has does not know about the instance. @@ -3130,13 +3130,13 @@ The `TemplatesEntry` object describes a template. It has the following structure This is used to obtain detailed information about a specific template. - **Response:** + **Response:** - :http:statuscode:`200 OK`: - The backend has successfully returned the detailed information about a specific template. - Returns a `TemplateDetails`. - :http:statuscode:`404 Not found`: - The template(ID) is unknown to the backend. + :http:statuscode:`200 OK`: + The backend has successfully returned the detailed information about a specific template. + Returns a `TemplateDetails`. + :http:statuscode:`404 Not found`: + The template(ID) is unknown to the backend. .. ts:def:: TemplateDetails @@ -3164,12 +3164,12 @@ Removing template This is used to delete information about a template. - **Response:** + **Response:** - :http:statuscode:`204 No content`: - The backend has successfully deleted the template. - :http:statuscode:`404 Not found`: - The backend does not know the instance or the template. + :http:statuscode:`204 No content`: + The backend has successfully deleted the template. + :http:statuscode:`404 Not found`: + The backend does not know the instance or the template. @@ -3178,22 +3178,22 @@ Using template .. http:post:: [/instances/$INSTANCES]/templates/$TEMPLATE_ID - This using template can be modified by everyone and will be used to create order. + This using template can be modified by everyone and will be used to create order. - **Request:** + **Request:** - The request must be a `UsingTemplateDetails` and we accept JSON application and URL encoded. + The request must be a `UsingTemplateDetails` and we accept JSON application and URL encoded. - **Response:** + **Response:** - :http:statuscode:`200 OK`: - The using template is successful. Returns a `UsingTemplateResponse`. - :http:statuscode:`302 Found`: - The client should go to the indicated location. Only returned if the content type was HTML. The target site may allow the client to pay his order. - :http:statuscode:`404 Not found`: - The merchant instance is unknown or the template is unknown. + :http:statuscode:`200 OK`: + The using template is successful. Returns a `UsingTemplateResponse`. + :http:statuscode:`302 Found`: + The client should go to the indicated location. Only returned if the content type was HTML. The target site may allow the client to pay his order. + :http:statuscode:`404 Not found`: + The merchant instance is unknown or the template is unknown. .. ts:def:: UsingTemplateDetails @@ -3325,7 +3325,7 @@ Inspecting webhook This is used to return the list of all the webhooks. - **Response:** + **Response:** :http:statuscode:`200 OK`: The backend has successfully returned all the webhooks. Returns a `WebhookSummaryResponse`. @@ -3361,7 +3361,7 @@ Inspecting webhook This is used to obtain detailed information about apecific template. - **Response:** + **Response:** :http:statuscode:`200 OK`: The backend has successfully returned the detailed information about a specific webhook. Returns a `Webhookdetails`. @@ -3399,7 +3399,7 @@ Removing template This is used to delete information about a webhook. - **Response:** + **Response:** :http:statuscode:`204 No content`: The backend has successfully deleted the template. |