summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorpriscilla <priscilla.huang@efrei.net>2022-11-15 07:21:44 -0500
committerpriscilla <priscilla.huang@efrei.net>2022-11-15 07:21:44 -0500
commit51d2eec1ead9ee198eee6bceaed11e6f70ba8afa (patch)
tree9e3eb5729b68f55529b576b99d8413c027876ea9 /core
parent4b30065f69615f18f89e1be7073a7e751f7c45eb (diff)
downloaddocs-51d2eec1ead9ee198eee6bceaed11e6f70ba8afa.tar.gz
docs-51d2eec1ead9ee198eee6bceaed11e6f70ba8afa.tar.bz2
docs-51d2eec1ead9ee198eee6bceaed11e6f70ba8afa.zip
Update
Diffstat (limited to 'core')
-rw-r--r--core/api-merchant.rst67
1 files changed, 32 insertions, 35 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 65caa491..1d0bb528 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -856,7 +856,7 @@ Instance management
-------------------
Instances allow one merchant backend to be shared by multiple merchants.
-Every backend must have at least one instance, typcially the "default"
+Every backend must have at least one instance, typically the "default"
instance setup before it can be used to manage inventory or process payments.
@@ -2976,12 +2976,12 @@ The QR code will be used for the merchant who does not have electronics devices.
The customers will be able to scan the QR code and will redirect to the payment page.
-Create statics QR code
+Create static QR code
----------------------
.. http:post:: [/instances/$INSTANCE]/public/staticsQRcode
- Create statics QR code.
+ Create static QR code.
If the merchant repeat, it will create another static QR code.
This is generally without danger but merchant may want to eventually delete the unused
static QR code to avoid clutter.
@@ -2999,12 +2999,12 @@ Create statics QR code
A QR code already exists for this store. There will have a lot of QR code for one store.
-Create dynamics QR code
+Create dynamic QR code
-----------------------
.. http:post:: [/instances/$INSTANCE]/public/dynamicsQRcode
- Create dynamics QR code.
+ Create dynamic QR code.
If the merchant repeat, it will create a real conflict. Dynamic QR code is unique
for every merchant.
@@ -3023,7 +3023,7 @@ Create dynamics QR code
-Scaning the QR code
+Scanning the QR code
------------------
.. http:get:: [/instances/$INSTANCE]/public/QRcode/$QRcode_ID
@@ -3044,8 +3044,8 @@ Scaning the QR code
Template
--------
-The templates is a bakckend feature that is used to create an order. The template is define by the merchant.
-It cannot be change by the customer.
+The templates is a backend feature that is used to create an order. We use the template to have some static information that cannot be changed by the customer.
+The template is private and allows us to be flexible. The private template allows for greater security and allows us to have a minimum information we need for each store.
@@ -3054,7 +3054,7 @@ Adding templates
.. http:post:: [/instances/$INSTANCE]/private/templates
- This is used to create template.
+ This is used to create a template.
**Request:**
@@ -3064,8 +3064,8 @@ Adding templates
**Response:**
:http:statuscode:`204 No content`:
- The creation of the template is successfull.
- :http:statuscode:`404 Not found`
+ The creation of the template is successful.
+ :http:statuscode:`404 Not found`:
The merchant instance is unknown or it is not in our data.
@@ -3079,20 +3079,31 @@ Adding templates
// Human-readable description for the template.
template_descripton: string;
- // The price is imposed by the merchant and cannot be changed by the customer.
- // This parametrer is optional.
- amount?: Amount;
-
// A base64-encoded image selected by the merchant.
// This parameter is optional.
// We are not sure about it.
image?: ImageDataUrl;
+ // Additional information in a separate template.
+ template_detail: TemplateSeparateDetail[];
+ }
+
+
+ .. ts:def:: TemplateSeparateDetail
+
+ interface TemplateSeparateDetail {
+
+ // Human-readable summary for the template.
+ summary: string;
+
+ // The price is imposed by the merchant and cannot be changed by the customer.
+ // This parametrer is optional.
+ amount?: Amount;
+
// Minimum age buyer must have (in years). Default is 0.
minimum_age: Integer;
- }
-
+ }
Editing templates
@@ -3125,20 +3136,13 @@ Editing templates
// Human-readable description for the template.
template_descripton: string;
- // The price is imposed by the merchant and cannot be changed by the customer.
- // This parametrer is optional.
- amount?: Amount;
-
// A base64-encoded image selected by the merchant.
// This parameter is optional.
// We are not sure about it.
image?: ImageDataUrl;
- // Minimum age buyer must have (in years). Default is 0.
- minimum_age: Integer;
-
- // Another template that complete the main one.
- template_details: TemplateSeparateDetail[];
+ // Additional information in a separate template.
+ template_detail: TemplateSeparateDetail[];
}
@@ -3206,20 +3210,13 @@ The `TemplatesEntry` object describes a template. It has the following structure
// Human-readable description for the template.
template_descripton: string;
- // The price is imposed by the merchant and cannot be changed by the customer.
- // This parametrer is optional.
- amount: Amount;
-
// A base64-encoded image selected by the merchant.
// This parameter is optional.
// We are not sure about it.
image?: ImageDataUrl;
- // Minimum age buyer must have (in years). Default is 0.
- minimum_age: Integer;
-
- // Another template that complete the main one.
- template_details: TemplateSeparateDetail[];
+ // Additional information in a separate template.
+ template_detail: TemplateSeparateDetail[];
}