summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorpriscilla <priscilla.huang@efrei.net>2022-11-15 05:56:07 -0500
committerpriscilla <priscilla.huang@efrei.net>2022-11-15 05:56:07 -0500
commitde0077b0a28c931e6ed23d1ea99a156996e5a0fd (patch)
tree3e41543f3580f0b055015cf4159958b705892717 /core/api-merchant.rst
parent2e7dab3b1573e04ef51de24cdcdbdfcafd5badd6 (diff)
downloaddocs-de0077b0a28c931e6ed23d1ea99a156996e5a0fd.tar.gz
docs-de0077b0a28c931e6ed23d1ea99a156996e5a0fd.tar.bz2
docs-de0077b0a28c931e6ed23d1ea99a156996e5a0fd.zip
Update
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst84
1 files changed, 38 insertions, 46 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 8214fde4..726e4c2f 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -3075,29 +3075,38 @@ Adding templates
interface TemplateAddDetail {
// Template ID to use.
- tenplate_id: string;
-
- // Name of the store.
- name_store: string;
-
- // Human-readable summary for the template.
- summary: string;
+ template_id: string;
// The price is imposed by the merchant and cannot be changed by the customer.
// This parametrer is optional.
price_imposed?: Amount;
// A base64-encoded image selected by the merchant.
- image: ImageDataUrl;
-
- // Identifies where the store is.
- address_store: Location;
+ // 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[];
+
}
-
+
+
+ .. ts:def:: TemplateSeparateDetail
+
+ interface TemplateSeparateDetail {
+
+ // Identifies where the store is.
+ address_store: Location;
+
+ // Human-readable summary for the template.
+ template_descripton: string;
+
+ }
+
Editing templates
-----------------
@@ -3128,28 +3137,21 @@ Editing templates
interface TemplatePatchDetail {
- // Template ID to use.
- tenplate_id: string;
-
- // Name of the store.
- name_store: string;
-
- // 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.
price_imposed?: Amount;
// A base64-encoded image selected by the merchant.
- image: ImageDataUrl;
-
- // Identifies where the store is.
- address_store: Location;
+ // 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[];
+
}
@@ -3175,9 +3177,8 @@ Inspecting template
interface TemplateSummaryResponse {
- // List of templates that are present in our backend.
- templates: TemplateEntry[];
-
+ // List of templates that are present in our backend.
+ templates_list: TemplateEntry[];
}
@@ -3190,6 +3191,8 @@ Inspecting template
// Template identifier, as found in the template.
template_id: string;
+ }
+
.. http:get:: [/instances/$INSTANCE]/private/templates/$TEMPLATE_ID
@@ -3205,38 +3208,27 @@ Inspecting template
:http:statuscode:`404 Not found`:
The template(ID) is unknown to the backend.
-
+
.. ts:def:: TemplateDetail
interface TemplateDetail {
- // Template ID to use.
- tenplate_id: string;
-
- // Name of the store.
- name_store: string;
-
- // Name of the owner.
- name_owner: string;
-
- // 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.
price_imposed: Amount;
// A base64-encoded image selected by the merchant.
- image: ImageDataUrl;
-
- // Identifies where the store is.
- address_store: Location;
+ // 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[];
+ }