diff --git a/config.yml b/config.yml index f94bfe83..b3bf8bea 100644 --- a/config.yml +++ b/config.yml @@ -1,6 +1,6 @@ -introspection: https://graphql-pokemon2.vercel.app +introspection: http://puripuri000.sirclo.me.dmmy.me/graphql servers: - - url: https://graphql-pokemon2.vercel.app + - url: http://puripuri000.sirclo.me.dmmy.me/graphql description: Test Server info: description: | @@ -11,37 +11,19 @@ info: GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools. version: 1.0.0 title: Pokémon API - termsOfService: 'https://graphql-pokemon2.vercel.app/terms' + termsOfService: 'http://puripuri000.sirclo.me.dmmy.me/graphql' contact: - email: dmiasoutov@wayfair.com + email: irna@sirclo.com license: name: Apache 2.0 url: 'http://www.apache.org/licenses/LICENSE-2.0.html' domains: - - name: Fetching Pokémons + - name: Fetching Tenant information description: Base methods to fetch pokemon information. usecases: - - name: Fetch Pokémons - description: Query list of Pokémon - query: query.pokemons - expand: weight,height - - name: Fetch single Pokémon - description: Query any Pokémon by number or name - query: query.pokemon - expand: weight,height - - name: Evolution & Attacks - description: Custom methods to fetch pokemon - usecases: - - name: Query Attack Rating - description: Query Pokémon - query: query.pokemon - select: id name - expand: attacks,fast,special - - name: Query Evolutions - description: Query Pokémon evolutions - query: query.pokemon - select: id name - expand: evolutions + - name: Fetch tenant 123 + description: Query tenant information with given id + query: query.tenant # securityDefinitions: # cheesy_auth: # type: oauth2 diff --git a/docs/images/eevee.png b/docs/images/eevee.png deleted file mode 100644 index 755e55df..00000000 Binary files a/docs/images/eevee.png and /dev/null differ diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index e63c29b8..00000000 --- a/docs/index.html +++ /dev/null @@ -1,1372 +0,0 @@ - - - - - - Pokémon API | API Reference - - - - - - - -
- -
- -
-
-

Pokémon API - API Reference -

-
-
-
-

Welcome to the sample Pokémon API reference. This is a live example of how you can use - DociQL in conjunction with - GraphQL to generate beautiful static documentation for your own APIs.

-

The Pokémon API is GraphQL API. It's schema can be fetched using introspection query and can be used for generating code, documentations, tests etc.

-

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

-
-
-
-
API Endpoints
- 
Test Server:
-https://graphql-pokemon2.vercel.app
-
- -
Terms of Service: - https://graphql-pokemon2.vercel.app/terms -
-
Contact: - dmiasoutov@wayfair.com -
-
Version: - 1.0.0 -
-
-
-
-
-

Fetching Pokémons

-
-
-

Base methods to fetch pokemon information.

-
-
-
- - -
- Fetching Pokémons - -
- - -

- Fetch Pokémons -

-
-
-
-

Query list of Pokémon

-
-
-
-
-
-
-
-
-
- first: -
integer
- -
-
-
-
-
-
-
-
first: - -
integer
- - -
-
-
-

(no description)

-
-
-
-
-
-
-

Example

-
Request Content-Types: - application/json -
-
Query
- - - - 
query pokemons($first: Int!){
-  pokemons(first: $first){
-    id
-    number
-    name
-    weight{
-      minimum
-      maximum
-    }
-    height{
-      minimum
-      maximum
-    }
-    classification
-    types
-    resistant
-    weaknesses
-    fleeRate
-    maxCP
-    maxHP
-    image
-  }
-}
-
- - -
Variables
- - - - 
{
-  "first": "integer"
-}
-
- - - Try it now -
-
-
-
-
-
-
-
-
200 OK
-
-
-

Successful operation

-
-
-
-
type
-
-
-
- Pokemon -
-
- -
-
-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- - - - 
{
-  "data": {
-    "pokemons": [
-      {
-        "id": "string",
-        "number": "string",
-        "name": "string",
-        "weight": {
-          "minimum": "string",
-          "maximum": "string"
-        },
-        "height": {
-          "minimum": "string",
-          "maximum": "string"
-        },
-        "classification": "string",
-        "types": [
-          "string"
-        ],
-        "resistant": [
-          "string"
-        ],
-        "weaknesses": [
-          "string"
-        ],
-        "fleeRate": "number",
-        "maxCP": "integer",
-        "maxHP": "integer",
-        "image": "string"
-      }
-    ]
-  }
-}
-
- - -
-
-
-
-
- - -
- Fetching Pokémons - -
- - -

- Fetch single Pokémon -

-
-
-
-

Query any Pokémon by number or name

-
-
-
-
-
-
-
-
-
- id: -
string
- -
-
- name: -
string
- -
-
-
-
-
-
-
-
id: - -
string
- - -
-
-
-

(no description)

-
-
-
-
-
name: - -
string
- - -
-
-
-

(no description)

-
-
-
-
-
-
-

Example

-
Request Content-Types: - application/json -
-
Query
- - - - 
query pokemon($id: String, $name: String){
-  pokemon(id: $id, name: $name){
-    id
-    number
-    name
-    weight{
-      minimum
-      maximum
-    }
-    height{
-      minimum
-      maximum
-    }
-    classification
-    types
-    resistant
-    weaknesses
-    fleeRate
-    maxCP
-    maxHP
-    image
-  }
-}
-
- - -
Variables
- - - - 
{
-  "id": "string",
-  "name": "string"
-}
-
- - - Try it now -
-
-
-
-
-
-
-
-
200 OK
-
-
-

Successful operation

-
-
-
-
type
-
-
- -
- -
-
-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- - - - 
{
-  "data": {
-    "pokemon": {
-      "id": "string",
-      "number": "string",
-      "name": "string",
-      "weight": {
-        "minimum": "string",
-        "maximum": "string"
-      },
-      "height": {
-        "minimum": "string",
-        "maximum": "string"
-      },
-      "classification": "string",
-      "types": [
-        "string"
-      ],
-      "resistant": [
-        "string"
-      ],
-      "weaknesses": [
-        "string"
-      ],
-      "fleeRate": "number",
-      "maxCP": "integer",
-      "maxHP": "integer",
-      "image": "string"
-    }
-  }
-}
-
- - -
-
-
-
-

Evolution & Attacks

-
-
-

Custom methods to fetch pokemon

-
-
-
- - -
- Evolution & Attacks - -
- - -

- Query Attack Rating -

-
-
-
-

Query Pokémon

-
-
-
-
-
-
-
-
-
- id: -
string
- -
-
- name: -
string
- -
-
-
-
-
-
-
-
id: - -
string
- - -
-
-
-

(no description)

-
-
-
-
-
name: - -
string
- - -
-
-
-

(no description)

-
-
-
-
-
-
-

Example

-
Request Content-Types: - application/json -
-
Query
- - - - 
query pokemon($id: String, $name: String){
-  pokemon(id: $id, name: $name){
-    id
-    name
-    attacks{
-      fast{
-        name
-        type
-        damage
-      }
-      special{
-        name
-        type
-        damage
-      }
-    }
-  }
-}
-
- - -
Variables
- - - - 
{
-  "id": "string",
-  "name": "string"
-}
-
- - - Try it now -
-
-
-
-
-
-
-
-
200 OK
-
-
-

Successful operation

-
-
-
-
type
-
-
- -
- -
-
-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- - - - 
{
-  "data": {
-    "pokemon": {
-      "id": "string",
-      "name": "string",
-      "attacks": {
-        "fast": [
-          {
-            "name": "string",
-            "type": "string",
-            "damage": "integer"
-          }
-        ],
-        "special": [
-          {
-            "name": "string",
-            "type": "string",
-            "damage": "integer"
-          }
-        ]
-      }
-    }
-  }
-}
-
- - -
-
-
-
-
- - -
- Evolution & Attacks - -
- - -

- Query Evolutions -

-
-
-
-

Query Pokémon evolutions

-
-
-
-
-
-
-
-
-
- id: -
string
- -
-
- name: -
string
- -
-
-
-
-
-
-
-
id: - -
string
- - -
-
-
-

(no description)

-
-
-
-
-
name: - -
string
- - -
-
-
-

(no description)

-
-
-
-
-
-
-

Example

-
Request Content-Types: - application/json -
-
Query
- - - - 
query pokemon($id: String, $name: String){
-  pokemon(id: $id, name: $name){
-    id
-    name
-    evolutions{
-      id
-      number
-      name
-      classification
-      types
-      resistant
-      weaknesses
-      fleeRate
-      maxCP
-      evolutions{
-        ...RecursivePokemonFragment
-      }
-      maxHP
-      image
-    }
-  }
-}
-
- - -
Variables
- - - - 
{
-  "id": "string",
-  "name": "string"
-}
-
- - - Try it now -
-
-
-
-
-
-
-
-
200 OK
-
-
-

Successful operation

-
-
-
-
type
-
-
- -
- -
-
-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- - - - 
{
-  "data": {
-    "pokemon": {
-      "id": "string",
-      "name": "string",
-      "evolutions": [
-        {
-          "id": "string",
-          "number": "string",
-          "name": "string",
-          "classification": "string",
-          "types": [
-            "string"
-          ],
-          "resistant": [
-            "string"
-          ],
-          "weaknesses": [
-            "string"
-          ],
-          "fleeRate": "number",
-          "maxCP": "integer",
-          "maxHP": "integer",
-          "image": "string"
-        }
-      ]
-    }
-  }
-}
-
- - -
-
-
-
-

Schema Definitions

-
-

- Pokemon: object - -

-
-
-
-

Represents a Pokémon

-
-
-
-
- id: -
object
- - -
-
-

The ID of an object

-
-
- number: -
string
- -
-
-

The identifier of this Pokémon

-
-
- name: -
string
- -
-
-

The name of this Pokémon

-
-
- weight: -
- -
- -
-
-

The minimum and maximum weight of this Pokémon

-
-
- height: -
- -
- -
-
-

The minimum and maximum weight of this Pokémon

-
-
- classification: -
string
- -
-
-

The classification of this Pokémon

-
-
- types: -
string[]
- -
-
-

The type(s) of this Pokémon

-
-
- resistant: -
string[]
- -
-
-

The type(s) of Pokémons that this Pokémon is resistant to

-
-
- attacks: -
- -
- -
-
-

The attacks of this Pokémon

-
-
- weaknesses: -
string[]
- -
-
-

The type(s) of Pokémons that this Pokémon weak to

-
-
- fleeRate: -
number
- -
-
- maxCP: -
number
- -
-
-

The maximum CP of this Pokémon

-
-
- evolutions: -
-
- Pokemon -
-
- -
-
-

The evolutions of this Pokémon

-
-
- evolutionRequirements: -
- -
- -
-
-

The evolution requirements of this Pokémon

-
-
- maxHP: -
number
- -
-
-

The maximum HP of this Pokémon

-
-
- image: -
string
- -
-
-
-
-
-
-
Example
- - - - 
{
-  "number": "string",
-  "name": "string",
-  "weight": {
-    "minimum": "string",
-    "maximum": "string"
-  },
-  "height": {
-    "minimum": "string",
-    "maximum": "string"
-  },
-  "classification": "string",
-  "types": [
-    "string"
-  ],
-  "resistant": [
-    "string"
-  ],
-  "attacks": {
-    "fast": [
-      {
-        "name": "string",
-        "type": "string",
-        "damage": "number"
-      }
-    ],
-    "special": [
-      {
-        "name": "string",
-        "type": "string",
-        "damage": "number"
-      }
-    ]
-  },
-  "weaknesses": [
-    "string"
-  ],
-  "fleeRate": "number",
-  "maxCP": "number",
-  "evolutions": [
-    {
-      "number": "string",
-      "name": "string",
-      "weight": {
-        "minimum": "string",
-        "maximum": "string"
-      },
-      "height": {
-        "minimum": "string",
-        "maximum": "string"
-      },
-      "classification": "string",
-      "types": [
-        "string"
-      ],
-      "resistant": [
-        "string"
-      ],
-      "attacks": {
-        "fast": [
-          {
-            "name": "string",
-            "type": "string",
-            "damage": "number"
-          }
-        ],
-        "special": [
-          {
-            "name": "string",
-            "type": "string",
-            "damage": "number"
-          }
-        ]
-      },
-      "weaknesses": [
-        "string"
-      ],
-      "fleeRate": "number",
-      "maxCP": "number",
-      "evolutions": [
-        {
-          "number": "string",
-          "name": "string",
-          "weight": {
-            "minimum": "string",
-            "maximum": "string"
-          },
-          "height": {
-            "minimum": "string",
-            "maximum": "string"
-          },
-          "classification": "string",
-          "types": [
-            "string"
-          ],
-          "resistant": [
-            "string"
-          ],
-          "attacks": {
-            "fast": [
-              {
-                "name": "string",
-                "type": "string",
-                "damage": "number"
-              }
-            ],
-            "special": [
-              null
-            ]
-          }
-        }
-      ]
-    }
-  ]
-}
-
- - -
-
-
-
-
-

- PokemonDimension: object - -

-
-
-
-

Represents a Pokémon's dimensions

-
-
-
-
- minimum: -
string
- -
-
-

The minimum value of this dimension

-
-
- maximum: -
string
- -
-
-

The maximum value of this dimension

-
-
-
-
-
-
-
Example
- - - - 
{
-  "minimum": "string",
-  "maximum": "string"
-}
-
- - -
-
-
-
-
-

- PokemonAttack: object - -

-
-
-
-

Represents a Pokémon's attack types

-
-
-
-
- fast: -
-
- Attack -
-
- -
-
-

The fast attacks of this Pokémon

-
-
- special: -
-
- Attack -
-
- -
-
-

The special attacks of this Pokémon

-
-
-
-
-
-
-
Example
- - - - 
{
-  "fast": [
-    {
-      "name": "string",
-      "type": "string",
-      "damage": "number"
-    }
-  ],
-  "special": [
-    {
-      "name": "string",
-      "type": "string",
-      "damage": "number"
-    }
-  ]
-}
-
- - -
-
-
-
-
-

- Attack: object - -

-
-
-
-

Represents a Pokémon's attack types

-
-
-
-
- name: -
string
- -
-
-

The name of this Pokémon attack

-
-
- type: -
string
- -
-
-

The type of this Pokémon attack

-
-
- damage: -
number
- -
-
-

The damage of this Pokémon attack

-
-
-
-
-
-
-
Example
- - - - 
{
-  "name": "string",
-  "type": "string",
-  "damage": "number"
-}
-
- - -
-
-
-
-
-

- PokemonEvolutionRequirement: object - -

-
-
-
-

Represents a Pokémon's requirement to evolve

-
-
-
-
- amount: -
number
- -
-
-

The amount of candy to evolve

-
-
- name: -
string
- -
-
-

The name of the candy to evolve

-
-
-
-
-
-
-
Example
- - - - 
{
-  "amount": "number",
-  "name": "string"
-}
-
- - -
-
-
-
-
-
- Documentation by - DociQL - -
-
-
-
-
- - \ No newline at end of file diff --git a/docs/javascripts/spectacle.min.js b/docs/javascripts/spectacle.min.js deleted file mode 100644 index f8d0b1fb..00000000 --- a/docs/javascripts/spectacle.min.js +++ /dev/null @@ -1 +0,0 @@ -function Traverse(t,e){this.$element=t,this.options=$.extend({},Traverse.defaults,this.$element.data(),e),this._init()}$(function(){var t=$("#sidebar");if(t.length){$("#docs");var s=t.find("nav");new Traverse(s,{threshold:10,barOffset:t.position().top});s.on("update.traverse",function(t,e){s.find("section").removeClass("expand");var i=e.parents("section:first");i.length&&i.addClass("expand")});var a=$(".drawer-layout"),n=a.find(".drawer"),r=function(){return n.removeClass("slide-right slide-left"),n.find(".drawer-overlay").remove(),a.removeClass("drawer-open drawer-slide-left-large drawer-slide-right-large"),!1};a.find("[data-drawer-slide]").click(function(t){var e=$(this).data("drawer-slide");a.addClass("drawer-open"),n.addClass("slide-"+e);var i=$('');return n.append(i),i.click(r),!1}),a.find("[data-drawer-close]").click(r)}}),Traverse.defaults={animationDuration:500,animationEasing:"linear",threshold:50,activeClass:"active",deepLinking:!1,barOffset:0},Traverse.prototype._init=function(){var t=this.$element[0].id;this.$targets=$("[data-traverse-target]"),this.$links=this.$element.find("a"),this.$element.attr({"data-resize":t,"data-scroll":t,id:t}),this.$active=$(),this.scrollPos=parseInt(window.pageYOffset,10),this._events()},Traverse.prototype.calcPoints=function(){var i=this,t=document.body,e=document.documentElement;this.points=[],this.winHeight=Math.round(Math.max(window.innerHeight,e.clientHeight)),this.docHeight=Math.round(Math.max(t.scrollHeight,t.offsetHeight,e.clientHeight,e.scrollHeight,e.offsetHeight)),this.$targets.each(function(){var t=$(this),e=t.offset().top;t.targetPoint=e,i.points.push(e)})},Traverse.prototype._events=function(){var s=this,a=$("html, body"),n={duration:s.options.animationDuration,easing:s.options.animationEasing};$(window).one("load",function(){s.calcPoints(),s._updateActive(),$(this).resize(function(t){s.reflow()}).scroll(function(t){s._updateActive()})}),this.$element.on("click",'a[href^="#"]',function(t){t.preventDefault();var e=this.getAttribute("href").replace(".","\\."),i=$(e).offset().top-s.options.barOffset;a.stop(!0).animate({scrollTop:i},n)})},Traverse.prototype.reflow=function(){this.calcPoints(),this._updateActive()},Traverse.prototype._updateActive=function(){var t,i=parseInt(window.pageYOffset,10);if(i+this.winHeight===this.docHeight)t=this.points.length-1;else if(i + + + + + Pokémon API | API Reference + + + + + + + +
+ +
+ +
+
+

Pokémon API + API Reference +

+
+
+
+

Welcome to the sample Pokémon API reference. This is a live example of how you can use + DociQL in conjunction with + GraphQL to generate beautiful static documentation for your own APIs.

+

The Pokémon API is GraphQL API. It's schema can be fetched using introspection query and can be used for generating code, documentations, tests etc.

+

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

+
+
+
+
API Endpoints
+ 
Test Server:
+http://puripuri000.sirclo.me.dmmy.me/graphql
+
+ +
Terms of Service: + http://puripuri000.sirclo.me.dmmy.me/graphql +
+
Contact: + irna@sirclo.com +
+
Version: + 1.0.0 +
+
+
+
+
+

Paths

+ +
+ + +
+ Fetching Tenant information + +
+ + +

+ Fetch tenant 123 +

+
+
+
+

Query tenant information with given id

+
+
+
+
+
+
+
+
+
+
ID: + +
string
+ + +
+
+
+

(no description)

+
+
+
+
+
+
+

Example

+
Request Content-Types: + application/json +
+
Query
+ + + + 
query tenant($ID: ID){
+  tenant(ID: $ID){
+    ID
+    name
+    language
+    currencyCode
+  }
+}
+
+ + +
Variables
+ + + + 
{
+  "ID": "string"
+}
+
+ + + Try it now +
+
+
+
+
+
+
+
+
200 OK
+
+
+

Successful operation

+
+
+
+
type
+
+
+ +
+ +
+
+
+
+
+
Response Content-Types: + application/json +
+
+
Response Example + (200 OK) +
+ + + + 
{
+  "data": {
+    "tenant": {
+      "ID": "string",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string"
+    }
+  }
+}
+
+ + +
+
+
+
+

Schema Definitions

+
+

+ APIKey: object + +

+
+
+
+
+
+ clientId: +
+
+ String +
+
+ + +
+
+ clientSecret: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "clientId": "string",
+  "clientSecret": "string"
+}
+
+ + +
+
+
+
+
+

+ AWBStatusInput: object + +

+
+
+
+
+
+ specs: +
+
+ AWBStatusInputSpec +
+
+ +
+
+

Specifications for airway bill status input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "AWBNumber": "string",
+      "orderID": "string",
+      "isAutoAwb": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ AWBStatusInputSpec: object + +

+
+
+
+
+
+ AWBNumber: +
+
+ String +
+
+ +
+
+

The number of the airway bill.

+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The target order ID.

+
+
+ isAutoAwb: +
+
+ Boolean +
+
+ +
+
+

The order use auto awb or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "AWBNumber": "string",
+  "orderID": "string",
+  "isAutoAwb": "boolean"
+}
+
+ + +
+
+
+
+
+

+ AcceptOrderReq: object + +

+
+
+
+
+
+ orderIDs: +
+
+ String +
+
+ +
+
+ notes: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderIDs": [
+    "string"
+  ],
+  "notes": "string"
+}
+
+ + +
+
+
+
+
+

+ AccessSpec: object + +

+
+
+
+
+
+ action: +
+
+ String +
+
+ + +
+
+ resource: +
+
+ ID +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "action": "string",
+  "resource": "object"
+}
+
+ + +
+
+
+
+
+

+ AccessToken: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ +
+
+ account: +
+
+ Member +
+
+ +
+
+ accessToken: +
+
+ String +
+
+ + +
+
+ tenantID: +
+
+ String +
+
+ +
+
+ tenant: +
+
+ Tenant +
+
+ +
+
+ allowedActions: +
+
+ String +
+
+ +
+
+ isAdmin: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "account": {
+    "accountID": "string",
+    "ID": "string",
+    "addresses": [
+      {
+        "addressLabel": "string",
+        "contactName": "string",
+        "districtCode": "string",
+        "location": "string",
+        "street": "string",
+        "latitude": "string",
+        "longitude": "string",
+        "postalCode": "string",
+        "isPrimary": "boolean",
+        "salesChannel": "string"
+      }
+    ],
+    "email": "string",
+    "firstName": "string",
+    "lastName": "string",
+    "gender": "string",
+    "phone": "string",
+    "dateOfBirth": "number",
+    "createdAt": "number",
+    "updatedAt": "number",
+    "level": "string",
+    "loyaltyPoint": {
+      "amount": "number",
+      "history": [
+        {
+          "delta": "number",
+          "happenedAt": "number",
+          "info": "string"
+        }
+      ]
+    },
+    "membership": {
+      "point": "number",
+      "history": [
+        {
+          "delta": "number",
+          "happenedAt": "number",
+          "info": "string"
+        }
+      ]
+    },
+    "haveAccessTo": "boolean",
+    "haveAccessToWithReason": {
+      "allowed": "boolean",
+      "reason": "string"
+    },
+    "orders": {
+      "items": [
+        {
+          "ID": "string",
+          "brandID": "object",
+          "channelID": "string",
+          "brand": {
+            "ID": "string"
+          }
+        }
+      ]
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ AccountDetails: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ brandID: +
+
+ ID +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ firstName: +
+
+ String +
+
+ +
+
+ lastName: +
+
+ String +
+
+ +
+
+ gender: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+ dateOfBirth: +
+
+ Timestamp +
+
+ +
+
+ addresses: +
+
+ Addresses +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "email": "string",
+  "firstName": "string",
+  "lastName": "string",
+  "gender": "string",
+  "phone": "string",
+  "createdAt": "number",
+  "updatedAt": "number",
+  "dateOfBirth": "object",
+  "addresses": [
+    {
+      "addressLabel": "string",
+      "contactName": "string",
+      "location": "string",
+      "street": "string",
+      "latitude": "string",
+      "longitude": "string",
+      "postalCode": "string",
+      "isPrimary": "boolean",
+      "districtCode": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ActivateBrandInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of brand IDs to be activated.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ ActivateTemplateInput: object + +

+
+
+
+
+
+ email: +
+
+ Boolean +
+
+ +
+
+ sms: +
+
+ Boolean +
+
+ +
+
+ whatsApp: +
+
+ Boolean +
+
+ +
+
+ IDs: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "boolean",
+  "sms": "boolean",
+  "whatsApp": "boolean",
+  "IDs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ AddAdminInput: object + +

+
+
+
+
+
+ spec: +
+
+ AdminSpec +
+
+ +
+
+

List of specs to be added as admin

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "spec": [
+    {
+      "info": {
+        "email": "string",
+        "phone": "string",
+        "name": "string",
+        "tenantID": "string",
+        "brandIDs": [
+          "string"
+        ],
+        "allBrand": "boolean"
+      },
+      "permission": {
+        "actions": [
+          "string"
+        ],
+        "allAction": "boolean"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ AddMembershipPointInput: object + +

+
+
+
+
+
+ specs: +
+
+ AddMembershipPointSpecInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "brandID": "object",
+      "memberID": "object",
+      "value": "number",
+      "pointProvider": "string",
+      "info": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ AddMembershipPointSpecInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ memberID: +
+
+ ID +
+
+ + +
+
+ value: +
+
+ Int +
+
+ + +
+
+ pointProvider: +
+
+ String +
+
+ +
+
+ info: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "memberID": "object",
+  "value": "number",
+  "pointProvider": "string",
+  "info": "string"
+}
+
+ + +
+
+
+
+
+

+ AddStockReminderCustomerInput: object + +

+
+
+
+
+
+ productID: +
+
+ String +
+
+ + +
+
+ sku: +
+
+ String +
+
+ + +
+
+ contact: +
+
+ String +
+
+ + +
+
+ type: +
+ +
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "productID": "string",
+  "sku": "string",
+  "contact": "string",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ AddressInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+ email: +
+
+ String +
+
+ + +
+
+ phone: +
+
+ String +
+
+ + +
+
+ country: +
+
+ String +
+
+ + +
+
+ province: +
+
+ String +
+
+ + +
+
+ city: +
+
+ String +
+
+ + +
+
+ subDistrict: +
+
+ String +
+
+ + +
+
+ street: +
+
+ String +
+
+ + +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ postalCode: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "email": "string",
+  "phone": "string",
+  "country": "string",
+  "province": "string",
+  "city": "string",
+  "subDistrict": "string",
+  "street": "string",
+  "districtCode": "string",
+  "postalCode": "string"
+}
+
+ + +
+
+
+
+
+

+ Addresses: object + +

+
+
+
+
+
+ addressLabel: +
+
+ String +
+
+ + +
+
+ contactName: +
+
+ String +
+
+ + +
+
+ location: +
+
+ String +
+
+ + +
+
+ street: +
+
+ String +
+
+ + +
+
+ latitude: +
+
+ String +
+
+ + +
+
+ longitude: +
+
+ String +
+
+ + +
+
+ postalCode: +
+
+ String +
+
+ + +
+
+ isPrimary: +
+
+ Boolean +
+
+ +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "addressLabel": "string",
+  "contactName": "string",
+  "location": "string",
+  "street": "string",
+  "latitude": "string",
+  "longitude": "string",
+  "postalCode": "string",
+  "isPrimary": "boolean",
+  "districtCode": "string"
+}
+
+ + +
+
+
+
+
+

+ Admin: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+ ID: +
+
+ String +
+
+ +
+
+ addresses: +
+
+ AdminAddress +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ firstName: +
+
+ String +
+
+ +
+
+ lastName: +
+
+ String +
+
+ +
+
+ gender: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ dateOfBirth: +
+
+ Int +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "ID": "string",
+  "addresses": [
+    {
+      "addressLabel": "string",
+      "contactName": "string",
+      "districtCode": "string",
+      "street": "string",
+      "latitude": "string",
+      "longitude": "string",
+      "postalCode": "string",
+      "isPrimary": "boolean",
+      "salesChannel": "string"
+    }
+  ],
+  "email": "string",
+  "firstName": "string",
+  "lastName": "string",
+  "gender": "string",
+  "phone": "string",
+  "dateOfBirth": "number",
+  "createdAt": "number",
+  "updatedAt": "number"
+}
+
+ + +
+
+
+
+
+

+ AdminActions: object + +

+
+
+
+
+
+ actions: +
+
+ String +
+
+ +
+
+ allAction: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "actions": [
+    "string"
+  ],
+  "allAction": "boolean"
+}
+
+ + +
+
+
+
+
+

+ AdminAddress: object + +

+
+
+
+
+
+ addressLabel: +
+
+ String +
+
+ +
+
+ contactName: +
+
+ String +
+
+ +
+
+ districtCode: +
+
+ String +
+
+ +
+
+ street: +
+
+ String +
+
+ +
+
+ latitude: +
+
+ String +
+
+ +
+
+ longitude: +
+
+ String +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+ isPrimary: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "addressLabel": "string",
+  "contactName": "string",
+  "districtCode": "string",
+  "street": "string",
+  "latitude": "string",
+  "longitude": "string",
+  "postalCode": "string",
+  "isPrimary": "boolean",
+  "salesChannel": "string"
+}
+
+ + +
+
+
+
+
+

+ AdminAddressInput: object + +

+
+
+
+
+
+ addressLabel: +
+
+ String +
+
+ +
+
+

Label for this address.

+
+
+ contactName: +
+
+ String +
+
+ +
+
+

Contact name for this address.

+
+
+ districtCode: +
+
+ String +
+
+ +
+
+

District code for this address.

+
+
+ street: +
+
+ String +
+
+ +
+
+

This address' street name.

+
+
+ latitude: +
+
+ String +
+
+ +
+
+

This address' latitude.

+
+
+ longitude: +
+
+ String +
+
+ +
+
+

This address' longitude.

+
+
+ postalCode: +
+
+ String +
+
+ +
+
+

Postal code for this address.

+
+
+ isPrimary: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this is a primary address or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "addressLabel": "string",
+  "contactName": "string",
+  "districtCode": "string",
+  "street": "string",
+  "latitude": "string",
+  "longitude": "string",
+  "postalCode": "string",
+  "isPrimary": "boolean"
+}
+
+ + +
+
+
+
+
+

+ AdminInfo: object + +

+
+
+
+
+
+ email: +
+
+ String +
+
+ + +
+
+ phone: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ + +
+
+ tenantID: +
+
+ String +
+
+ + +
+
+ brandIDs: +
+
+ String +
+
+ +
+
+ allBrand: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "string",
+  "phone": "string",
+  "name": "string",
+  "tenantID": "string",
+  "brandIDs": [
+    "string"
+  ],
+  "allBrand": "boolean"
+}
+
+ + +
+
+
+
+
+

+ AdminLoginByIdTokenInput: object + +

+
+
+
+
+
+ idToken: +
+
+ String +
+
+ + +
+
+

idToken from the login provider response

+
+
+ provider: +
+
+ String +
+
+ + +
+
+

provider that gives the id token

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "idToken": "string",
+  "provider": "string"
+}
+
+ + +
+
+
+
+
+

+ AdminNotification: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ content: +
+
+ String +
+
+ +
+
+ link: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "title": "string",
+  "content": "string",
+  "link": "string"
+}
+
+ + +
+
+
+
+
+

+ AdminPermission: object + +

+
+
+
+
+
+ actions: +
+
+ String +
+
+ +
+
+ administeredBrandIDs: +
+
+ String +
+
+ +
+
+ allAction: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "actions": [
+    "string"
+  ],
+  "administeredBrandIDs": [
+    "string"
+  ],
+  "allAction": "boolean"
+}
+
+ + +
+
+
+
+
+

+ AdminProfile: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ firstName: +
+
+ String +
+
+ +
+
+ lastName: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ passwordIsSet: +
+
+ Boolean +
+
+ + +
+
+ permission: +
+ +
+ +
+
+ apiKey: +
+
+ APIKey +
+
+ +
+
+ lastLogin: +
+
+ Int +
+
+ +
+
+ role: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "firstName": "string",
+  "lastName": "string",
+  "email": "string",
+  "phone": "string",
+  "passwordIsSet": "boolean",
+  "permission": {
+    "actions": [
+      "string"
+    ],
+    "administeredBrandIDs": [
+      "string"
+    ],
+    "allAction": "boolean"
+  },
+  "apiKey": {
+    "clientId": "string",
+    "clientSecret": "string"
+  },
+  "lastLogin": "number",
+  "role": "string"
+}
+
+ + +
+
+
+
+
+

+ AdminSpec: object + +

+
+
+
+
+
+ info: +
+
+ AdminInfo +
+
+ +
+
+ permission: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "info": {
+    "email": "string",
+    "phone": "string",
+    "name": "string",
+    "tenantID": "string",
+    "brandIDs": [
+      "string"
+    ],
+    "allBrand": "boolean"
+  },
+  "permission": {
+    "actions": [
+      "string"
+    ],
+    "allAction": "boolean"
+  }
+}
+
+ + +
+
+
+
+
+

+ Airwaybill: object + +

+
+
+
+
+
+ products: +
+
+ ProductLineData +
+
+ +
+
+ recipientData: +
+ +
+ +
+
+ extraAttributes: +
+ +
+ +
+
+ providerService: +
+
+ String +
+
+ +
+
+ customerSMCode: +
+
+ String +
+
+ +
+
+ providerName: +
+
+ String +
+
+ +
+
+ orderNumber: +
+
+ String +
+
+ +
+
+ senderPhone: +
+
+ String +
+
+ +
+
+ senderName: +
+
+ String +
+
+ +
+
+ awbNumber: +
+
+ String +
+
+ +
+
+ orderDate: +
+
+ String +
+
+ +
+
+ remarks: +
+
+ String +
+
+ +
+
+ smCode: +
+
+ String +
+
+ +
+
+ logo: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "products": [
+    {
+      "productCode": "string",
+      "productFid": "string",
+      "quantity": "number",
+      "title": "string",
+      "price": "number"
+    }
+  ],
+  "recipientData": {
+    "phoneNumber": "string",
+    "postCode": "string",
+    "district": "string",
+    "address": "string",
+    "name": "string"
+  },
+  "extraAttributes": {
+    "customerSMCode": "string",
+    "isDropship": "boolean",
+    "SMCode": "string"
+  },
+  "providerService": "string",
+  "customerSMCode": "string",
+  "providerName": "string",
+  "orderNumber": "string",
+  "senderPhone": "string",
+  "senderName": "string",
+  "awbNumber": "string",
+  "orderDate": "string",
+  "remarks": "string",
+  "smCode": "string",
+  "logo": "string"
+}
+
+ + +
+
+
+
+
+

+ AnalyticsSetting: object + +

+
+
+
+
+
+ facebookSetting: +
+ +
+ +
+
+ googleSetting: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "facebookSetting": {
+    "accessToken": "string",
+    "catalogId": "string",
+    "pixelId": "string"
+  },
+  "googleSetting": {
+    "universalAnalytics": {
+      "trackingId": "string"
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ AnalyticsSettingInput: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string"
+}
+
+ + +
+
+
+
+
+

+ AppliedInput: object + +

+
+
+
+
+
+ brandIds: +
+
+ String +
+
+ +
+
+ slug: +
+
+ String +
+
+ +
+
+ SKUs: +
+
+ String +
+
+ +
+
+ collectionIDs: +
+
+ String +
+
+ +
+
+ query: +
+ +
+ +
+
+ filter: +
+ +
+ +
+
+ source: +
+
+ Boolean +
+
+ +
+
+ sort: +
+
+ ProductSort +
+
+ +
+
+ page: +
+
+ Page +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandIds": [
+    "string"
+  ],
+  "slug": "string",
+  "SKUs": [
+    "string"
+  ],
+  "collectionIDs": [
+    "string"
+  ],
+  "query": {
+    "text": "string",
+    "language": "string"
+  },
+  "filter": {
+    "channelID": "string",
+    "minimumPrice": "number",
+    "maximumPrice": "number",
+    "maximumStock": "number",
+    "minimumStock": "number",
+    "currencyCode": "string",
+    "published": "boolean",
+    "tagName": "string",
+    "tagNames": [
+      "string"
+    ],
+    "collectionSlugs": [
+      "string"
+    ],
+    "openOrder": "boolean",
+    "openOrderScheduled": "boolean",
+    "variantOptionSpecs": [
+      {
+        "optionKey": "string",
+        "optionValue": "string"
+      }
+    ]
+  },
+  "source": "boolean",
+  "sort": [
+    {
+      "fieldName": "string",
+      "isAscending": "boolean"
+    }
+  ],
+  "page": {
+    "pageNumber": "number",
+    "itemPerPage": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ ArrayIntValueParameter: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ values: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "values": [
+    "number"
+  ]
+}
+
+ + +
+
+
+
+
+

+ ArrayStringValueParameter: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ names: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "names": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ Article: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+ articleID: +
+
+ String +
+
+ +
+
+ categoryID: +
+
+ String +
+
+ +
+
+ category: +
+ +
+ +
+
+ slug: +
+
+ String +
+
+ + +
+
+ descriptions: +
+
+ ArticleDescription +
+
+ +
+
+ SEOs: +
+
+ SEO +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "articleID": "string",
+  "categoryID": "string",
+  "category": {
+    "categoryID": "string",
+    "imageURL": "string",
+    "translations": [
+      {
+        "language": "string",
+        "name": "string"
+      }
+    ],
+    "SEOs": [
+      {
+        "language": "string",
+        "title": "string",
+        "description": "string",
+        "keywords": [
+          "string"
+        ]
+      }
+    ],
+    "isActive": "boolean",
+    "displayType": "string",
+    "slug": "string"
+  },
+  "slug": "string",
+  "descriptions": [
+    {
+      "language": "string",
+      "title": "string",
+      "content": "string"
+    }
+  ],
+  "SEOs": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ]
+    }
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ArticleCategory: object + +

+
+
+
+
+
+ categoryID: +
+
+ String +
+
+ +
+
+ imageURL: +
+
+ String +
+
+ +
+
+ translations: +
+
+ ArticleCategoryTranslation +
+
+ +
+
+ SEOs: +
+
+ SEO +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ displayType: +
+ +
+ +
+
+ slug: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "categoryID": "string",
+  "imageURL": "string",
+  "translations": [
+    {
+      "language": "string",
+      "name": "string"
+    }
+  ],
+  "SEOs": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ]
+    }
+  ],
+  "isActive": "boolean",
+  "displayType": "string",
+  "slug": "string"
+}
+
+ + +
+
+
+
+
+

+ ArticleCategoryFilterInput: object + +

+
+
+
+
+
+ displayType: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "displayType": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ArticleCategorySortInput: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ArticleCategoryTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ ArticleCategoryTranslationInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+

Target language translation. Should be a code and capitalized (e.g: 'ID' / 'EN').

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the category.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ ArticleDescription: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ content: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "title": "string",
+  "content": "string"
+}
+
+ + +
+
+
+
+
+

+ ArticleDescriptionInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+

Language for this article. Should be a code and capitalized (e.g: 'ID' / 'EN')

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of this article.

+
+
+ content: +
+
+ String +
+
+ + +
+
+

The content of this article.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "title": "string",
+  "content": "string"
+}
+
+ + +
+
+
+
+
+

+ ArticleFilterInput: object + +

+
+
+
+
+
+ displayType: +
+ +
+ +
+
+ categoryID: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "displayType": "string",
+  "categoryID": "string"
+}
+
+ + +
+
+
+
+
+

+ ArticleSortInput: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ AuthorizeAccess: object + +

+
+
+
+
+
+ allowed: +
+
+ Boolean +
+
+ + +
+
+ reason: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "allowed": "boolean",
+  "reason": "string"
+}
+
+ + +
+
+
+
+
+

+ Bank: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ accountNumber: +
+
+ String +
+
+ +
+
+ accountName: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "accountNumber": "string",
+  "accountName": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ BankAccount: object + +

+
+
+
+
+
+ banks: +
+
+ Bank +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "banks": [
+    {
+      "name": "string",
+      "accountNumber": "string",
+      "accountName": "string",
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BankAccountInput: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ +
+
+ bank: +
+
+ String +
+
+ +
+
+ accountNumber: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ expiry: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string",
+  "bank": "string",
+  "accountNumber": "string",
+  "name": "string",
+  "expiry": "number"
+}
+
+ + +
+
+
+
+
+

+ BankInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the bank.

+
+
+ accountNumber: +
+
+ String +
+
+ + +
+
+

Account number for that bank.

+
+
+ accountName: +
+
+ String +
+
+ + +
+
+

Account name for that bank.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this bank is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "accountNumber": "string",
+  "accountName": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ BankSettingInput: object + +

+
+
+
+
+
+ banks: +
+
+ BankInput +
+
+ +
+
+

Banks for the bank setting.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "banks": [
+    {
+      "name": "string",
+      "accountNumber": "string",
+      "accountName": "string",
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ Banner: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ imageURL: +
+
+ String +
+
+ +
+
+ targetURL: +
+
+ String +
+
+ +
+
+ translations: +
+
+ BannerTranslation +
+
+ +
+
+ activeStartTime: +
+
+ Int +
+
+ +
+
+ activeEndTime: +
+
+ Int +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ ordering: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "imageURL": "string",
+  "targetURL": "string",
+  "translations": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string"
+    }
+  ],
+  "activeStartTime": "number",
+  "activeEndTime": "number",
+  "published": "boolean",
+  "ordering": "number"
+}
+
+ + +
+
+
+
+
+

+ BannerFilterInput: object + +

+
+
+
+
+
+ translation: +
+ +
+ +
+
+ activeAtTime: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "translation": {
+    "language": "string",
+    "title": "string",
+    "description": "string"
+  },
+  "activeAtTime": "number"
+}
+
+ + +
+
+
+
+
+

+ BannerInput: object + +

+
+
+
+
+
+ bannerID: +
+
+ String +
+
+ +
+
+

Omit this to create a new banner

+
+
+ imageURL: +
+
+ String +
+
+ + +
+
+ targetURL: +
+
+ String +
+
+ + +
+
+ activeStartTime: +
+
+ Int +
+
+ + +
+
+ activeEndTime: +
+
+ Int +
+
+ + +
+
+ published: +
+
+ Boolean +
+
+ + +
+
+ ordering: +
+
+ Int +
+
+ + +
+
+ translations: +
+
+ BannerTranslationInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "bannerID": "string",
+  "imageURL": "string",
+  "targetURL": "string",
+  "activeStartTime": "number",
+  "activeEndTime": "number",
+  "published": "boolean",
+  "ordering": "number",
+  "translations": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BannerTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "title": "string",
+  "description": "string"
+}
+
+ + +
+
+
+
+
+

+ BannerTranslationInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ title: +
+
+ String +
+
+ + +
+
+ description: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "title": "string",
+  "description": "string"
+}
+
+ + +
+
+
+
+
+

+ BasicInfo: object + +

+
+
+
+
+
+ email: +
+
+ String +
+
+ + +
+
+ firstName: +
+
+ String +
+
+ + +
+
+ lastName: +
+
+ String +
+
+ + +
+
+ gender: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ dateOfBirth: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "string",
+  "firstName": "string",
+  "lastName": "string",
+  "gender": "string",
+  "phone": "string",
+  "dateOfBirth": "number"
+}
+
+ + +
+
+
+
+
+

+ BestSellingProduct: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ orderCount: +
+
+ Int +
+
+ +
+
+ productName: +
+
+ String +
+
+ +
+
+ productSKU: +
+
+ String +
+
+ +
+
+ revenue: +
+
+ Money +
+
+ +
+
+ soldQuantity: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "orderCount": "number",
+  "productName": "string",
+  "productSKU": "string",
+  "revenue": {
+    "code": "string",
+    "value": "number"
+  },
+  "soldQuantity": "number"
+}
+
+ + +
+
+
+
+
+

+ BestSellingProductFilterInput: object + +

+
+
+
+
+
+ endOrderDate: +
+
+ Int +
+
+ +
+
+ productSKUs: +
+
+ String +
+
+ +
+
+ startOrderDate: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "endOrderDate": "number",
+  "productSKUs": [
+    "string"
+  ],
+  "startOrderDate": "number"
+}
+
+ + +
+
+
+
+
+

+ Billing: object + +

+
+
+
+
+
+ tenants: +
+ +
+ +
+
+ marketingTenants: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "tenants": {
+    "items": [
+      {
+        "ID": "object",
+        "name": "string",
+        "email": "string",
+        "phone": "string",
+        "balance": "string"
+      }
+    ],
+    "pageInfo": {
+      "totalItems": "number",
+      "itemPerPage": "number",
+      "pageNumber": "number"
+    }
+  },
+  "marketingTenants": {
+    "items": [
+      {
+        "ID": "object",
+        "dateCreated": "string",
+        "salutation": "string",
+        "firstName": "string",
+        "dateOfBirth": "string",
+        "email": "string",
+        "alternatifEmail": "string",
+        "phoneNumber": "string",
+        "alternatifPhoneNumber": "string",
+        "addressLine": "string",
+        "postalCode": "string",
+        "state": "string",
+        "country": "string"
+      }
+    ],
+    "pageInfo": {
+      "totalItems": "number",
+      "itemPerPage": "number",
+      "pageNumber": "number"
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ BillingInfo: object + +

+
+
+
+
+
+ salutation: +
+
+ String +
+
+ +
+
+ fullName: +
+
+ String +
+
+ +
+
+ addressLine: +
+
+ String +
+
+ +
+
+ district: +
+
+ String +
+
+ +
+
+ city: +
+
+ String +
+
+ +
+
+ province: +
+
+ String +
+
+ +
+
+ country: +
+
+ String +
+
+ +
+
+ phoneNumber: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "salutation": "string",
+  "fullName": "string",
+  "addressLine": "string",
+  "district": "string",
+  "city": "string",
+  "province": "string",
+  "country": "string",
+  "phoneNumber": "string",
+  "email": "string",
+  "postalCode": "string"
+}
+
+ + +
+
+
+
+
+

+ BillingTenant: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ balance: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "name": "string",
+  "email": "string",
+  "phone": "string",
+  "balance": "string"
+}
+
+ + +
+
+
+
+
+

+ BirthdayCoupon: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ couponID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ code: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ isValid: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ couponType: +
+ +
+ + +
+
+ maximumUsageCount: +
+
+ Int +
+
+ +
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ +
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ +
+
+ discountValue: +
+ +
+ +
+
+ usages: +
+
+ Usage +
+
+ +
+
+ validityPeriod: +
+
+ Int +
+
+ +
+
+ minimumPurchase: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "couponID": "string",
+  "brandID": "string",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ Boolean: boolean + +

+
+
+
+

The Boolean scalar type represents true or false.

+
+
+
+
+
Example
+ + + + 
boolean
+
+ + +
+
+
+
+
+

+ BootstrapBrandInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+ email: +
+
+ String +
+
+ + +
+
+ firstName: +
+
+ String +
+
+ + +
+
+ lastName: +
+
+ String +
+
+ + +
+
+ password: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ + +
+
+ country: +
+
+ String +
+
+ + +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ template: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "email": "string",
+  "firstName": "string",
+  "lastName": "string",
+  "password": "string",
+  "phone": "string",
+  "country": "string",
+  "districtCode": "string",
+  "template": "string"
+}
+
+ + +
+
+
+
+
+

+ BootstrapBrandTask: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+ result: +
object
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string"
+}
+
+ + +
+
+
+
+
+

+ BootstrapBrandTaskError: object + +

+
+
+
+
+
+ message: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ BootstrapBrandTaskInfo: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string"
+}
+
+ + +
+
+
+
+
+

+ Brand: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ +
+
+ tenantID: +
+
+ String +
+
+ + +
+
+ tenant: +
+
+ Tenant +
+
+ +
+
+

Query tenant related to Brand

+
+
+ logoURL: +
+
+ String +
+
+ +
+
+ settings: +
+ +
+ +
+
+

Query setting for specific brand

+
+
+ orders: +
+ +
+ +
+
+

Query order within brand.

+

'query' is prioritized, 'filter' is only used if 'query' is not specfied

+
+
+ products: +
+ +
+ +
+
+

Query products within brand.

+
+
+ productReviews: +
+ +
+ + +
+
+

Query product reviews within brand.

+
+
+ productVariants: +
+
+ ProductVariant +
+
+ +
+
+

Query product variants

+
+
+ collections: +
+ +
+ +
+
+

Query collections from procol service

+
+
+ members: +
+ +
+ +
+
+

Query members from account service (Raiden)

+

'query' is prioritized, 'filter' is only used if 'query' is not specfied

+
+
+ widgets: +
+ +
+ +
+
+

Query widgets

+
+
+ articles: +
+ +
+ +
+
+

Query articles

+
+
+ article: +
+
+ Article +
+
+ +
+
+

Query article by its slug

+
+
+ cart: +
+
+ StoreCart +
+
+ +
+
+

Query saved cart

+
+
+ memberCart: +
+
+ StoreCart +
+
+ +
+
+

Query saved member cart

+
+
+ dryRunImport: +
+ +
+ +
+
+

Query dry run import

+
+
+ exportExcel: +
+
+ Job +
+
+ +
+
+

General Query to generate excel files

+
+
+ eximHistory: +
+ +
+ +
+
+ report: +
+ +
+ +
+
+ discounts: +
+ +
+ +
+
+

Query discounts

+
+
+ articleCategories: +
+ +
+ +
+
+

Query article's categories

+
+
+ analyticsSetting: +
+ +
+ +
+
+

Query analytic's setting

+
+
+ navigations: +
+ +
+ +
+
+

Query navigations

+
+
+ notificationTemplates: +
+ +
+ +
+
+

Query templates for notification

+
+
+ notificationTemplatesV2: +
+ +
+ +
+
+

Query templates for notificationV2

+
+
+ notificationHistory: +
+ +
+ +
+
+

Query history for notification

+
+
+ bundles: +
+ +
+ +
+
+

Query bundles

+
+
+ coupons: +
+ +
+ +
+
+

Query coupons

+
+
+ validCoupons: +
object[]
+ +
+
+

Query valid coupons for specific cart condition

+
+
+ lookbook: +
+
+ Lookbook +
+
+ +
+
+

Query lookbook by slug

+
+
+ lookbooks: +
+ +
+ +
+
+

Query lookbooks

+
+
+ paymentProviders: +
+
+ BrandPaymentProvider +
+
+ +
+
+

Query payment provider

+
+
+ paymentAvailability: +
+
+ BrandPaymentAvailabilityTuple +
+
+ +
+
+ shippingCost: +
+ +
+ +
+
+

Query shipping cost

+
+
+ shippings: +
+ +
+ +
+
+

Query shipping provider

+
+
+ banners: +
+ +
+ +
+
+

Query banners

+
+
+ promotions: +
+ +
+ +
+
+

Query promotions

+
+
+ marketplaces: +
+
+ MarketplaceConnection +
+
+ +
+
+

Query all marketplaces channels

+
+
+ marketplaceConnectionForms: +
+
+ MarketplaceConnectionForm +
+
+ +
+
+

Query all marketplaces integration fields

+
+
+ salesChannels: +
+ +
+ +
+
+

Query all sales channels

+
+
+ socmedSetting: +
+ +
+ +
+
+

Query socmed's setting

+
+
+ testimonials: +
+ +
+ +
+
+

Query testimonials

+
+
+ isExpired: +
+
+ Boolean +
+
+ + +
+
+

Expiry status of the brand

+
+
+ fqdn: +
+
+ String +
+
+ +
+
+

Fully qualified domain name of the brand

+
+
+ newsletter: +
+ +
+ +
+
+

Query newsletters

+
+
+ linkspage: +
+
+ Linkspage +
+
+ +
+
+

Query linkspage

+
+
+ productTags: +
+
+ ProductTag +
+
+ +
+
+

Query productTags

+
+
+ googleAdsWebsiteMetaToken: +
+
+ String +
+
+ +
+
+

Get website meta token for googleads

+
+
+ googleAccountLoginURL: +
+
+ String +
+
+ +
+
+

Get login url

+
+
+ googleAdsReport: +
+ +
+ +
+
+

Get google ads report

+
+
+ googleAdsRelatedAccounts: +
+ +
+ +
+
+

Get google ads related account

+
+
+ googleAdsEligibilityStatus: +
+
+ Int +
+
+ +
+
+

Get google ads brand eligibility status

+
+
+ googleAdsCampaign: +
+ +
+ +
+
+

Get google ads campaign

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "name": "string",
+  "tenantID": "string",
+  "tenant": {
+    "ID": "object",
+    "name": "string",
+    "language": "string",
+    "currencyCode": "string",
+    "brands": {
+      "items": [
+        {
+          "ID": "string",
+          "name": "string",
+          "tenantID": "string",
+          "tenant": {
+            "ID": "object",
+            "name": "string",
+            "language": "string",
+            "currencyCode": "string",
+            "brands": {
+              "items": [
+                {
+                  "ID": "string",
+                  "name": "string",
+                  "tenantID": "string",
+                  "tenant": {
+                    "ID": "object",
+                    "name": "string",
+                    "language": "string",
+                    "currencyCode": "string",
+                    "brands": {
+                      "items": [
+                        {
+                          "ID": "string",
+                          "name": "string",
+                          "tenantID": "string",
+                          "tenant": {
+                            "ID": "object",
+                            "name": "string",
+                            "language": "string",
+                            "currencyCode": "string",
+                            "brands": {
+                              "items": [
+                                {
+                                  "ID": "string",
+                                  "name": "string",
+                                  "tenantID": "string",
+                                  "tenant": {
+                                    "ID": "object",
+                                    "name": "string",
+                                    "language": "string"
+                                  }
+                                }
+                              ]
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      ]
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ BrandPaymentAvailabilityTuple: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+ isAvailable: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "isAvailable": "boolean"
+}
+
+ + +
+
+
+
+
+

+ BrandPaymentProvider: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ ID +
+
+ +
+
+ name: +
+
+ String +
+
+ + +
+
+ logo: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ paymentMethods: +
+
+ BrandPaymentProviderMethod +
+
+ +
+
+ formFields: +
+
+ PaymentField +
+
+ +
+
+ configs: +
+
+ PaymentAdminConfig +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "name": "string",
+  "logo": "string",
+  "isActive": "boolean",
+  "paymentMethods": [
+    {
+      "ID": "object",
+      "providerID": "object",
+      "brandID": "object",
+      "name": "string",
+      "logo": "string",
+      "isActive": "boolean",
+      "formFields": [
+        {
+          "label": "string",
+          "name": "string",
+          "type": "string",
+          "description": "string",
+          "isRequired": "boolean",
+          "options": [
+            "string"
+          ],
+          "conditionalShows": [
+            {
+              "formFieldName": "string",
+              "condition": "string"
+            }
+          ]
+        }
+      ],
+      "configs": [
+        {
+          "ID": "string",
+          "providerID": "string",
+          "method": "string",
+          "configs": [
+            {
+              "name": "string",
+              "value": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "formFields": [
+    {
+      "label": "string",
+      "name": "string",
+      "type": "string",
+      "description": "string",
+      "isRequired": "boolean",
+      "options": [
+        "string"
+      ],
+      "conditionalShows": [
+        {
+          "formFieldName": "string",
+          "condition": "string"
+        }
+      ]
+    }
+  ],
+  "configs": [
+    {
+      "ID": "string",
+      "providerID": "string",
+      "method": "string",
+      "configs": [
+        {}
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BrandPaymentProviderMethod: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ providerID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ ID +
+
+ +
+
+ name: +
+
+ String +
+
+ + +
+
+ logo: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ formFields: +
+
+ PaymentField +
+
+ +
+
+ configs: +
+
+ PaymentAdminConfig +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "providerID": "object",
+  "brandID": "object",
+  "name": "string",
+  "logo": "string",
+  "isActive": "boolean",
+  "formFields": [
+    {
+      "label": "string",
+      "name": "string",
+      "type": "string",
+      "description": "string",
+      "isRequired": "boolean",
+      "options": [
+        "string"
+      ],
+      "conditionalShows": [
+        {
+          "formFieldName": "string",
+          "condition": "string"
+        }
+      ]
+    }
+  ],
+  "configs": [
+    {
+      "ID": "string",
+      "providerID": "string",
+      "method": "string",
+      "configs": [
+        {
+          "name": "string",
+          "value": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BrandReport: object + +

+
+
+
+
+
+ salesByMember: +
+ +
+ +
+
+ bestSellingProduct: +
+ +
+ +
+
+ monthlySales: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "salesByMember": {
+    "items": [
+      {
+        "brandID": "string",
+        "email": "string",
+        "memberID": "string",
+        "orderCount": "number",
+        "orderDate": "number",
+        "totalDiscount": {
+          "code": "string",
+          "value": "number"
+        },
+        "totalOrderAmount": {
+          "code": "string",
+          "value": "number"
+        },
+        "totalShippingFee": {
+          "code": "string",
+          "value": "number"
+        }
+      }
+    ],
+    "pageInfo": {
+      "totalItems": "number",
+      "itemPerPage": "number",
+      "pageNumber": "number"
+    }
+  },
+  "bestSellingProduct": {
+    "items": [
+      {
+        "brandID": "string",
+        "orderCount": "number",
+        "productName": "string",
+        "productSKU": "string",
+        "revenue": {
+          "code": "string",
+          "value": "number"
+        },
+        "soldQuantity": "number"
+      }
+    ],
+    "pageInfo": {
+      "totalItems": "number",
+      "itemPerPage": "number",
+      "pageNumber": "number"
+    }
+  },
+  "monthlySales": {
+    "items": [
+      {
+        "brandID": "string",
+        "orderCount": "number",
+        "productSales": [
+          {
+            "orderCount": "number",
+            "productName": "string",
+            "productSKU": "string",
+            "soldQuantity": "number",
+            "totalNetRevenue": {
+              "code": "string",
+              "value": "number"
+            }
+          }
+        ],
+        "soldQuantity": "number"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ BrandSetting: object + +

+
+
+
+
+
+ adminEmail: +
+
+ String +
+
+ +
+
+ bankAccount: +
+ +
+ +
+
+ brandID: +
+
+ String +
+
+ + +
+
+ checkoutAsGuestEnabled: +
+
+ Boolean +
+
+ +
+
+ confirmPaymentMessage: +
+ +
+ +
+
+ faviconURL: +
+
+ String +
+
+ +
+
+ hideFromSearchEngine: +
+
+ Boolean +
+
+ +
+
+ newsletter: +
+ +
+ +
+
+ paymentMethods: +
+ +
+ +
+
+ productFilterAndSort: +
+ +
+ +
+
+ productOption: +
+ +
+ +
+
+ reviewsAndRatingEnabled: +
+
+ Boolean +
+
+ +
+
+ setAsMaintenance: +
+ +
+ +
+
+ socialMediaLink: +
+ +
+ +
+
+ instagramToken: +
+
+ String +
+
+ +
+
+ instagramTokenLastUpdated: +
+
+ String +
+
+ +
+
+ websiteDescription: +
+
+ String +
+
+ +
+
+ websiteTitle: +
+
+ String +
+
+ +
+
+ defaultMembershipLevel: +
+ +
+ +
+
+ facebookAnalytics: +
+ +
+ +
+
+ googleAnalytics: +
+ +
+ +
+
+ privyID: +
+
+ String +
+
+ +
+
+ notificationCCEmail: +
+
+ String +
+
+ +
+
+ pushNotification: +
+ +
+ +
+
+ googleAuth: +
+ +
+ +
+
+ defaultExchangePointSettingID: +
+
+ String +
+
+ +
+
+ exchangePointSetting: +
+ +
+ +
+
+

'query' is prioritized, 'filter' is only used if 'query' is not specfied

+
+
+ stockReminderEnabled: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "adminEmail": "string",
+  "bankAccount": {
+    "banks": [
+      {
+        "name": "string",
+        "accountNumber": "string",
+        "accountName": "string",
+        "isActive": "boolean"
+      }
+    ]
+  },
+  "brandID": "string",
+  "checkoutAsGuestEnabled": "boolean",
+  "confirmPaymentMessage": {
+    "isActive": "boolean",
+    "message": "string"
+  },
+  "faviconURL": "string",
+  "hideFromSearchEngine": "boolean",
+  "newsletter": {
+    "popupOnFirstVisit": "boolean",
+    "content": "string"
+  },
+  "paymentMethods": {
+    "paymentMethods": [
+      {
+        "name": "string",
+        "merchantID": "string",
+        "clientKey": "string",
+        "serverKey": "string",
+        "acquiringBank": "string",
+        "payPalAccount": "string",
+        "specs": [
+          {
+            "method": "string",
+            "isActive": "boolean",
+            "chargeFeeToCustomer": "boolean",
+            "expiryHour": "number"
+          }
+        ]
+      }
+    ]
+  },
+  "productFilterAndSort": {
+    "filters": [
+      {
+        "name": "string",
+        "isActive": "boolean",
+        "type": "string",
+        "variantSpecs": [
+          {
+            "key": "string",
+            "translations": [
+              {
+                "language": "string",
+                "text": "string"
+              }
+            ],
+            "options": [
+              {
+                "attributes": [
+                  {
+                    "key": "string",
+                    "value": "string"
+                  }
+                ],
+                "isActive": "boolean",
+                "translations": [
+                  null
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ BucketPath: string + +

+
+
+
+
+
+
object
+ + CHAT + + +
+
+
+
object
+ + TDK_STORE + + +
+
+
+
object
+ + PRIUS + + +
+
+
+
object
+ + EXIM + + +
+
+
+
+
+
+
+
+

+ BundleFilterCriteriaSpec: object + +

+
+
+
+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ priority: +
+
+ Int +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ bundleType: +
+
+ BundleRuleType +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "isActive": "boolean",
+  "priority": "number",
+  "startTime": "number",
+  "endTime": "number",
+  "bundleType": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ BundleRuleType: string + +

+
+
+
+
+
+
object
+ + BuyNItemRule + + +
+
+
+
object
+ + BuyMinQuantityGetFreeItemsRule + + +
+
+
+
object
+ + BuyMinAmountGetFreeItemsRule + + +
+
+
+
+
+
+
+
+

+ BundleSortCriteriaSpec: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ +
+
+ isAscending: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ BundleType: string + +

+
+
+
+
+
+
object
+ + BuyNItemRule + + +
+
+
+
object
+ + BuyMinQuantityGetFreeItemsRule + + +
+
+
+
object
+ + BuyMinAmountGetFreeItemsRule + + +
+
+
+
+
+
+
+
+

+ BusinessHour: object + +

+
+
+
+
+
+ day: +
+
+ Int +
+
+ + +
+
+ shortName: +
+
+ String +
+
+ + +
+
+ longName: +
+
+ String +
+
+ + +
+
+ openAt: +
+
+ String +
+
+ + +
+
+ closeAt: +
+
+ String +
+
+ + +
+
+ isOpen: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "day": "number",
+  "shortName": "string",
+  "longName": "string",
+  "openAt": "string",
+  "closeAt": "string",
+  "isOpen": "boolean"
+}
+
+ + +
+
+
+
+
+

+ BuyMinAmountGetFreeItemsBundle: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ ruleType: +
+ +
+ + +
+
+ priority: +
+
+ Int +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ minAmountToBuy: +
+
+ Money +
+
+ +
+
+ eligibleProducts: +
+
+ Product +
+
+ +
+
+ bundledProductsList: +
+
+ ProductInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "title": "string",
+  "startTime": "number",
+  "endTime": "number",
+  "isActive": "boolean",
+  "ruleType": "string",
+  "priority": "number",
+  "salesChannel": "string",
+  "minAmountToBuy": {
+    "code": "string",
+    "value": "number"
+  },
+  "eligibleProducts": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string"
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BuyMinAmountGetFreeItemsBundleInput: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ priority: +
+
+ Int +
+
+ +
+
+ minAmountToBuy: +
+ +
+ +
+
+ eligibleProductIDs: +
+
+ String +
+
+ +
+
+ bundledProducts: +
+
+ ProductInfoInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "title": "string",
+  "startTime": "number",
+  "endTime": "number",
+  "isActive": "boolean",
+  "priority": "number",
+  "minAmountToBuy": {
+    "code": "string",
+    "value": "number"
+  },
+  "eligibleProductIDs": [
+    "string"
+  ],
+  "bundledProducts": [
+    {
+      "ID": "string",
+      "price": {
+        "code": "string",
+        "value": "number"
+      },
+      "quantity": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BuyMinQuantityGetFreeItemsBundle: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ ruleType: +
+ +
+ + +
+
+ priority: +
+
+ Int +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ minQuantityToBuy: +
+
+ Int +
+
+ +
+
+ eligibleProducts: +
+
+ Product +
+
+ +
+
+ bundledProductsList: +
+
+ ProductInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "title": "string",
+  "startTime": "number",
+  "endTime": "number",
+  "isActive": "boolean",
+  "ruleType": "string",
+  "priority": "number",
+  "salesChannel": "string",
+  "minQuantityToBuy": "number",
+  "eligibleProducts": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {}
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BuyMinQuantityGetFreeItemsBundleInput: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ priority: +
+
+ Int +
+
+ +
+
+ minQuantityToBuy: +
+
+ Int +
+
+ +
+
+ eligibleProductIDs: +
+
+ String +
+
+ +
+
+ bundledProducts: +
+
+ ProductInfoInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "title": "string",
+  "startTime": "number",
+  "endTime": "number",
+  "isActive": "boolean",
+  "priority": "number",
+  "minQuantityToBuy": "number",
+  "eligibleProductIDs": [
+    "string"
+  ],
+  "bundledProducts": [
+    {
+      "ID": "string",
+      "price": {
+        "code": "string",
+        "value": "number"
+      },
+      "quantity": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BuyNItemBundle: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ ruleType: +
+ +
+ + +
+
+ priority: +
+
+ Int +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ numOfItemToBuy: +
+
+ Int +
+
+ +
+
+ eligibleProducts: +
+
+ Product +
+
+ +
+
+ fixedPrice: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "title": "string",
+  "startTime": "number",
+  "endTime": "number",
+  "isActive": "boolean",
+  "ruleType": "string",
+  "priority": "number",
+  "salesChannel": "string",
+  "numOfItemToBuy": "number",
+  "eligibleProducts": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {}
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ BuyNItemBundleInput: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ startTime: +
+
+ Int +
+
+ +
+
+ endTime: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ priority: +
+
+ Int +
+
+ +
+
+ numOfItemToBuy: +
+
+ Int +
+
+ +
+
+ eligibleProductIDs: +
+
+ String +
+
+ +
+
+ fixedPrice: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "title": "string",
+  "startTime": "number",
+  "endTime": "number",
+  "isActive": "boolean",
+  "priority": "number",
+  "numOfItemToBuy": "number",
+  "eligibleProductIDs": [
+    "string"
+  ],
+  "fixedPrice": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ Buyer: object + +

+
+
+
+
+
+ id: +
+
+ ID +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ +
+
+ isRead: +
+
+ Boolean +
+
+ +
+
+ lastMessage: +
+
+ String +
+
+ +
+
+ lastAlert: +
+
+ String +
+
+ +
+
+ timestamp: +
+
+ Int +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ lastMessageId: +
+
+ Int +
+
+ +
+
+ isArchived: +
+
+ Boolean +
+
+ +
+
+ createdAt: +
+
+ String +
+
+ +
+
+ updatedAt: +
+
+ String +
+
+ +
+
+ unreadCount: +
+
+ Int +
+
+ +
+
+ message_id: +
+
+ String +
+
+ +
+
+ attributes: +
+
+ ChatRoomAttribute +
+
+ +
+
+ session: +
+
+ String +
+
+ +
+
+ userId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "object",
+  "name": "string",
+  "channel": "string",
+  "isRead": "boolean",
+  "lastMessage": "string",
+  "lastAlert": "string",
+  "timestamp": "number",
+  "type": "string",
+  "lastMessageId": "number",
+  "isArchived": "boolean",
+  "createdAt": "string",
+  "updatedAt": "string",
+  "unreadCount": "number",
+  "message_id": "string",
+  "attributes": [
+    {
+      "id": "number",
+      "chatRoomId": "number",
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "session": "string",
+  "userId": "string"
+}
+
+ + +
+
+
+
+
+

+ BuyerDetail: object + +

+
+
+
+
+
+ id: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ +
+
+ isRead: +
+
+ Boolean +
+
+ +
+
+ lastMessageId: +
+
+ Int +
+
+ +
+
+ isArchived: +
+
+ Boolean +
+
+ +
+
+ createdAt: +
+
+ String +
+
+ +
+
+ updatedAt: +
+
+ String +
+
+ +
+
+ unreadCount: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "string",
+  "name": "string",
+  "channel": "string",
+  "isRead": "boolean",
+  "lastMessageId": "number",
+  "isArchived": "boolean",
+  "createdAt": "string",
+  "updatedAt": "string",
+  "unreadCount": "number"
+}
+
+ + +
+
+
+
+
+

+ BuyersInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ ID +
+
+ + +
+
+ channel: +
+
+ String +
+
+ +
+
+ scroll: +
+
+ String +
+
+ +
+
+ id: +
+
+ String +
+
+ +
+
+ buyerId: +
+
+ ID +
+
+ +
+
+ limit: +
+
+ Int +
+
+ +
+
+ userId: +
+
+ String +
+
+ +
+
+ show: +
+ +
+ +
+
+ session: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "object",
+  "channel": "string",
+  "scroll": "string",
+  "id": "string",
+  "buyerId": "object",
+  "limit": "number",
+  "userId": "string",
+  "show": "string",
+  "session": "string"
+}
+
+ + +
+
+
+
+
+

+ BuyersInputShow: string + +

+
+
+
+
+
+
object
+ + ALL + + +
+
+
+
object
+ + ARCHIVED + + +
+
+
+
object
+ + UNARCHIVED + + +
+
+
+
+
+
+
+
+

+ CancelOrderReq: object + +

+
+
+
+
+
+ specs: +
+
+ CancelOrderSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "orderId": "string",
+      "notes": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CancelOrderSpec: object + +

+
+
+
+
+
+ orderId: +
+
+ String +
+
+ + +
+
+ notes: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderId": "string",
+  "notes": "string"
+}
+
+ + +
+
+
+
+
+

+ Cart: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ +
+
+ buyerId: +
+
+ String +
+
+ +
+
+ items: +
+
+ CartItem +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string",
+  "items": [
+    {
+      "sku": "string",
+      "quantity": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CartAddress: object + +

+
+
+
+
+
+ districtCode: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+ street: +
+
+ String +
+
+ +
+
+ location: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "districtCode": "string",
+  "email": "string",
+  "name": "string",
+  "phone": "string",
+  "postalCode": "string",
+  "street": "string",
+  "location": {
+    "country": "string",
+    "province": "string",
+    "city": "string",
+    "district": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ CartAddressInput: object + +

+
+
+
+
+
+ districtCode: +
+
+ String +
+
+ + +
+
+

The district code of this cart's address.

+
+
+ email: +
+
+ String +
+
+ +
+
+

The email used for this cart's address.

+
+
+ name: +
+
+ String +
+
+ +
+
+

The name used for this cart's address.

+
+
+ phone: +
+
+ String +
+
+ +
+
+

The phone number used for this cart's address.

+
+
+ postalCode: +
+
+ String +
+
+ +
+
+

The postal code of this cart's address.

+
+
+ street: +
+
+ String +
+
+ +
+
+

The street name of this cart's address.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "districtCode": "string",
+  "email": "string",
+  "name": "string",
+  "phone": "string",
+  "postalCode": "string",
+  "street": "string"
+}
+
+ + +
+
+
+
+
+

+ CartAddressLocation: object + +

+
+
+
+
+
+ country: +
+
+ String +
+
+ +
+
+ province: +
+
+ String +
+
+ +
+
+ city: +
+
+ String +
+
+ +
+
+ district: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "country": "string",
+  "province": "string",
+  "city": "string",
+  "district": "string"
+}
+
+ + +
+
+
+
+
+

+ CartAppliedPromo: object + +

+
+
+
+
+
+ typeId: +
+
+ String +
+
+ + +
+
+ type: +
+ +
+ + +
+
+ title: +
+
+ String +
+
+ +
+
+ code: +
+
+ String +
+
+ +
+
+ priceCut: +
+
+ Money +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "typeId": "string",
+  "type": "string",
+  "title": "string",
+  "code": "string",
+  "priceCut": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ CartCoupon: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ couponID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ code: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ isValid: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ couponType: +
+ +
+ + +
+
+ maximumUsageCount: +
+
+ Int +
+
+ +
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ +
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ +
+
+ discountValue: +
+ +
+ +
+
+ usages: +
+
+ Usage +
+
+ +
+
+ isMemberOnly: +
+
+ Boolean +
+
+ +
+
+ allowedMemberLevels: +
+
+ String +
+
+ +
+
+ minimumPurchase: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "couponID": "string",
+  "brandID": "string",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ CartItem: object + +

+
+
+
+
+
+ sku: +
+
+ String +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sku": "string",
+  "quantity": "number"
+}
+
+ + +
+
+
+
+
+

+ CartLineItem: object + +

+
+
+
+
+
+ imageURL: +
+
+ String +
+
+ +
+
+ price: +
+
+ Money +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+ SKU: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ availableStock: +
+
+ Int +
+
+ +
+
+ ignoreStock: +
+
+ Boolean +
+
+ +
+
+ errorMessage: +
+
+ String +
+
+ +
+
+ discount: +
+
+ Money +
+
+ +
+
+ slug: +
+
+ String +
+
+ +
+
+ salePrice: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "imageURL": "string",
+  "price": {
+    "code": "string",
+    "value": "number"
+  },
+  "quantity": "number",
+  "SKU": "string",
+  "title": "string",
+  "availableStock": "number",
+  "ignoreStock": "boolean",
+  "errorMessage": "string",
+  "discount": {
+    "code": "string",
+    "value": "number"
+  },
+  "slug": "string",
+  "salePrice": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ CartLineItemInput: object + +

+
+
+
+
+
+ imageURL: +
+
+ String +
+
+ +
+
+

URL of this line item's image.

+
+
+ price: +
+ +
+ +
+
+

The price for this line item.

+
+
+ quantity: +
+
+ Int +
+
+ + +
+
+

The quantity for this line item.

+
+
+ SKU: +
+
+ String +
+
+ + +
+
+

SKU for this line item.

+
+
+ title: +
+
+ String +
+
+ +
+
+

The title for this line item.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "imageURL": "string",
+  "price": {
+    "code": "string",
+    "value": "number"
+  },
+  "quantity": "number",
+  "SKU": "string",
+  "title": "string"
+}
+
+ + +
+
+
+
+
+

+ CartPayment: object + +

+
+
+
+
+
+ fee: +
+
+ Money +
+
+ +
+
+ provider: +
+
+ String +
+
+ +
+
+ service: +
+
+ String +
+
+ +
+
+ uniqueCode: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fee": {
+    "code": "string",
+    "value": "number"
+  },
+  "provider": "string",
+  "service": "string",
+  "uniqueCode": "number"
+}
+
+ + +
+
+
+
+
+

+ CartPaymentInput: object + +

+
+
+
+
+
+ fee: +
+ +
+ +
+
+

Fee of this payment.

+
+
+ provider: +
+
+ String +
+
+ + +
+
+

The provider used for this payment.

+
+
+ service: +
+
+ String +
+
+ + +
+
+

The service used for this payment.

+
+
+ uniqueCode: +
+
+ Int +
+
+ +
+
+

The unique code for this payment.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "fee": {
+    "code": "string",
+    "value": "number"
+  },
+  "provider": "string",
+  "service": "string",
+  "uniqueCode": "number"
+}
+
+ + +
+
+
+
+
+

+ CartPromo: object + +

+
+
+
+
+
+ totalDiscount: +
+
+ Money +
+
+ + +
+
+ appliedPromos: +
+
+ CartAppliedPromo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "totalDiscount": {
+    "code": "string",
+    "value": "number"
+  },
+  "appliedPromos": [
+    {
+      "typeId": "string",
+      "type": "string",
+      "title": "string",
+      "code": "string",
+      "priceCut": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CartPromoType: string + +

+
+
+
+
+
+
object
+ + DISCOUNT + + +
+
+
+
object
+ + BUNDLE + + +
+
+
+
object
+ + COUPON + + +
+
+
+
+
+
+
+
+

+ CartShipping: object + +

+
+
+
+
+
+ awbNumber: +
+
+ String +
+
+ +
+
+ cost: +
+
+ Money +
+
+ +
+
+ provider: +
+
+ String +
+
+ +
+
+ service: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "awbNumber": "string",
+  "cost": {
+    "code": "string",
+    "value": "number"
+  },
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ CartShippingInput: object + +

+
+
+
+
+
+ awbNumber: +
+
+ String +
+
+ +
+
+

Airway bill number of this cart's shipping.

+
+
+ cost: +
+ +
+ +
+
+

The cost of shipping.

+
+
+ provider: +
+
+ String +
+
+ + +
+
+

The provider used for this shipping.

+
+
+ service: +
+
+ String +
+
+ + +
+
+

The service used for this shipping.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "awbNumber": "string",
+  "cost": {
+    "code": "string",
+    "value": "number"
+  },
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ ChangeChatRoomStatusInput: object + +

+
+
+
+
+
+ buyerId: +
+
+ ID +
+
+ + +
+
+ sellerId: +
+
+ ID +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyerId": "object",
+  "sellerId": "object"
+}
+
+ + +
+
+
+
+
+

+ ChangePasswordData: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+

The ID of the affected account.

+
+
+ oldPassword: +
+
+ String +
+
+ + +
+
+

The old password of that account.

+
+
+ newPassword: +
+
+ String +
+
+ + +
+
+

The new password for that account.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "oldPassword": "string",
+  "newPassword": "string"
+}
+
+ + +
+
+
+
+
+

+ ChangePasswordInput: object + +

+
+
+
+
+
+ data: +
+ +
+ +
+
+

Required data for changing password.

+
+
+ isAdmin: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this user is an admin or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "data": {
+    "accountID": "string",
+    "oldPassword": "string",
+    "newPassword": "string"
+  },
+  "isAdmin": "boolean"
+}
+
+ + +
+
+
+
+
+

+ Channel: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ name: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ ChannelAttribute: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ChatCart: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+ cartId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string",
+  "cartId": "string"
+}
+
+ + +
+
+
+
+
+

+ ChatExchangeTransactionIdInput: object + +

+
+
+
+
+
+ transactionId: +
+
+ String +
+
+ + +
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+ customOrderSummary: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "transactionId": "string",
+  "sellerId": "string",
+  "buyerId": "string",
+  "customOrderSummary": "string",
+  "channel": "string"
+}
+
+ + +
+
+
+
+
+

+ ChatQueue: object + +

+
+
+
+
+
+ action: +
+
+ String +
+
+ +
+
+ buyerId: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ +
+
+ sellerId: +
+
+ String +
+
+ +
+
+ queueCount: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "action": "string",
+  "buyerId": "string",
+  "channel": "string",
+  "sellerId": "string",
+  "queueCount": "number"
+}
+
+ + +
+
+
+
+
+

+ ChatRoomAttribute: object + +

+
+
+
+
+
+ id: +
+
+ Int +
+
+ +
+
+ chatRoomId: +
+
+ Int +
+
+ +
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "number",
+  "chatRoomId": "number",
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ChatRoomAttributeInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ChatSettings: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ +
+
+ about: +
+
+ String +
+
+ +
+
+ photoUrl: +
+
+ String +
+
+ +
+
+ address: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ vertical: +
+
+ String +
+
+ +
+
+ websites: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "about": "string",
+  "photoUrl": "string",
+  "address": "string",
+  "description": "string",
+  "email": "string",
+  "vertical": "string",
+  "websites": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ ChatUser: object + +

+
+
+
+
+
+ id: +
+
+ ID +
+
+ +
+
+ userEmail: +
+
+ String +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ phoneNumber: +
+
+ String +
+
+ +
+
+ storeName: +
+
+ String +
+
+ +
+
+ whatsappNamespace: +
+
+ String +
+
+ +
+
+ brandId: +
+
+ String +
+
+ +
+
+ isNotifOn: +
+
+ Boolean +
+
+ +
+
+ buyersInputShow: +
+ +
+ +
+
+ buyers: +
+
+ Buyer +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "object",
+  "userEmail": "string",
+  "createdAt": "number",
+  "phoneNumber": "string",
+  "storeName": "string",
+  "whatsappNamespace": "string",
+  "brandId": "string",
+  "isNotifOn": "boolean",
+  "buyersInputShow": "string",
+  "buyers": [
+    {
+      "id": "object",
+      "name": "string",
+      "channel": "string",
+      "isRead": "boolean",
+      "lastMessage": "string",
+      "lastAlert": "string",
+      "timestamp": "number",
+      "type": "string",
+      "lastMessageId": "number",
+      "isArchived": "boolean",
+      "createdAt": "string",
+      "updatedAt": "string",
+      "unreadCount": "number",
+      "message_id": "string",
+      "attributes": [
+        {
+          "id": "number",
+          "chatRoomId": "number",
+          "key": "string",
+          "value": "string"
+        }
+      ],
+      "session": "string",
+      "userId": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ City: object + +

+
+
+
+
+
+ locationCode: +
+
+ String +
+
+ +
+
+ providerData: +
+
+ String +
+
+ +
+
+ districts: +
+
+ District +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "locationCode": "string",
+  "providerData": "string",
+  "districts": [
+    {
+      "locationCode": "string",
+      "providerData": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CityDistrictOption: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+ provinceName: +
+
+ String +
+
+ +
+
+ cityName: +
+
+ String +
+
+ +
+
+ districtName: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string",
+  "provinceName": "string",
+  "cityName": "string",
+  "districtName": "string"
+}
+
+ + +
+
+
+
+
+

+ ClaimChatQueueInput: object + +

+
+
+
+
+
+ userId: +
+
+ String +
+
+ + +
+
+ sellerId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "userId": "string",
+  "sellerId": "string"
+}
+
+ + +
+
+
+
+
+

+ ClaimChatQueueRes: object + +

+
+
+
+
+
+ buyerId: +
+
+ String +
+
+ +
+
+ buyerName: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ +
+
+ isRead: +
+
+ Boolean +
+
+ +
+
+ lastMessageId: +
+
+ Int +
+
+ +
+
+ lastMessage: +
+
+ String +
+
+ +
+
+ lastAlert: +
+
+ String +
+
+ +
+
+ timestamp: +
+
+ Int +
+
+ +
+
+ messageType: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyerId": "string",
+  "buyerName": "string",
+  "channel": "string",
+  "isRead": "boolean",
+  "lastMessageId": "number",
+  "lastMessage": "string",
+  "lastAlert": "string",
+  "timestamp": "number",
+  "messageType": "string"
+}
+
+ + +
+
+
+
+
+

+ ClaimGoogleMerchantWebsiteInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ CloseChatQueueInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+ userId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string",
+  "userId": "string"
+}
+
+ + +
+
+
+
+
+

+ CloseChatQueueRes: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string"
+}
+
+ + +
+
+
+
+
+

+ Collection: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ slug: +
+
+ String +
+
+ +
+
+ details: +
+
+ CollectionDetail +
+
+ +
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ channelIDs: +
+
+ ID +
+
+ +
+
+ SEOs: +
+
+ CollectionSEO +
+
+ +
+
+ attributes: +
+
+ CollectionAttribute +
+
+ +
+
+ parentIDs: +
+
+ ID +
+
+ +
+
+ aggregate: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "slug": "string",
+  "details": [
+    {
+      "name": "string",
+      "description": "string",
+      "language": "string"
+    }
+  ],
+  "imageURLs": [
+    "string"
+  ],
+  "published": "boolean",
+  "channelIDs": [
+    "object"
+  ],
+  "SEOs": [
+    {
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ],
+      "language": "string"
+    }
+  ],
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "parentIDs": [
+    "object"
+  ],
+  "aggregate": {
+    "totalPublishedProduct": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ CollectionAggregate: object + +

+
+
+
+
+
+ totalPublishedProduct: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "totalPublishedProduct": "number"
+}
+
+ + +
+
+
+
+
+

+ CollectionAttribute: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ CollectionAttributeInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ CollectionDeleteInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ CollectionDetail: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "description": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ CollectionDetailInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+ description: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "description": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ CollectionFilterInput: object + +

+
+
+
+
+
+ channelID: +
+
+ ID +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+ collectionName: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "object",
+  "language": "string",
+  "collectionName": "string",
+  "published": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CollectionSEO: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ keywords: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "description": "string",
+  "keywords": [
+    "string"
+  ],
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ CollectionSEOInput: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ + +
+
+ description: +
+
+ String +
+
+ + +
+
+ keywords: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ + +
+
+

Should be a code and capitalized (e.g: 'ID' / 'EN')

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "description": "string",
+  "keywords": [
+    "string"
+  ],
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ CollectionSortFieldNameEnum: string + +

+
+
+
+
+
+
object
+ + NAME + + +
+
+
+
+
+
+
+
+

+ CollectionSortInput: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CollectionUpsertInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ ID: +
+
+ ID +
+
+ +
+
+

Omit this to create a new collection

+
+
+ slug: +
+
+ String +
+
+ + +
+
+

Must be unique per product

+
+
+ details: +
+
+ CollectionDetailInput +
+
+ +
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ + +
+
+ channelIDs: +
+
+ ID +
+
+ +
+
+ SEOs: +
+
+ CollectionSEOInput +
+
+ +
+
+ attributes: +
+
+ CollectionAttributeInput +
+
+ +
+
+ parentIDs: +
+
+ ID +
+
+ +
+
+

Omit this to create new parent collection

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "ID": "object",
+  "slug": "string",
+  "details": [
+    {
+      "name": "string",
+      "description": "string",
+      "language": "string"
+    }
+  ],
+  "imageURLs": [
+    "string"
+  ],
+  "published": "boolean",
+  "channelIDs": [
+    "object"
+  ],
+  "SEOs": [
+    {
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ],
+      "language": "string"
+    }
+  ],
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "parentIDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ CompleteOrderReq: object + +

+
+
+
+
+
+ orderIDs: +
+
+ String +
+
+ +
+
+ notes: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderIDs": [
+    "string"
+  ],
+  "notes": "string"
+}
+
+ + +
+
+
+
+
+

+ Configs: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+

The name of the configuration.

+
+
+ value: +
+
+ String +
+
+ +
+
+

The value of the configuration.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ConfirmPaymentMessage: object + +

+
+
+
+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "isActive": "boolean",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ ConfirmPaymentMessageInput: object + +

+
+
+
+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the confirm payment message is active or not.

+
+
+ message: +
+
+ String +
+
+ + +
+
+

The message of the confirm payment message.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "isActive": "boolean",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ ContactType: string + +

+
+
+
+
+
+
object
+ + EMAIL + + +
+
+
+
object
+ + PHONE + + +
+
+
+
+
+
+
+
+

+ Country: object + +

+
+
+
+
+
+ locationCode: +
+
+ String +
+
+ +
+
+ providerData: +
+
+ String +
+
+ +
+
+ provinces: +
+
+ Province +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "locationCode": "string",
+  "providerData": "string",
+  "provinces": [
+    {
+      "locationCode": "string",
+      "providerData": "string",
+      "cities": [
+        {
+          "locationCode": "string",
+          "providerData": "string",
+          "districts": [
+            {
+              "locationCode": "string",
+              "providerData": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CouponFilterInput: object + +

+
+
+
+
+
+ salesChannels: +
+
+ String +
+
+ +
+
+ isMemberOnly: +
+
+ Boolean +
+
+ +
+
+ memberLevel: +
+
+ String +
+
+ +
+
+ shippingMethod: +
+
+ String +
+
+ +
+
+ paymentMethod: +
+
+ String +
+
+ +
+
+ applicableSKUs: +
+
+ String +
+
+ +
+
+ couponType: +
+ +
+ +
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ +
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "salesChannels": [
+    "string"
+  ],
+  "isMemberOnly": "boolean",
+  "memberLevel": "string",
+  "shippingMethod": "string",
+  "paymentMethod": "string",
+  "applicableSKUs": [
+    "string"
+  ],
+  "couponType": "string",
+  "applicableStartTimestamp": "number",
+  "applicableEndTimestamp": "number",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CouponSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CouponType: string + +

+
+
+
+
+
+
object
+ + PRODUCT + + +
+
+
+
object
+ + CART + + +
+
+
+
object
+ + SHIPPING + + +
+
+
+
object
+ + BIRTHDAY + + +
+
+
+
object
+ + NEW_MEMBER + + +
+
+
+
+
+
+
+
+

+ CouponValidInput: object + +

+
+
+
+
+
+ memberID: +
+
+ String +
+
+ +
+
+ memberLevel: +
+
+ String +
+
+ +
+
+ items: +
+
+ Item +
+
+ +
+
+ shippingMethod: +
+
+ String +
+
+ +
+
+ paymentMethod: +
+
+ String +
+
+ +
+
+ date: +
+
+ Int +
+
+ +
+
+ totalCost: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "memberID": "string",
+  "memberLevel": "string",
+  "items": [
+    {
+      "sku": "string",
+      "quantity": "number",
+      "basePrice": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ],
+  "shippingMethod": "string",
+  "paymentMethod": "string",
+  "date": "number",
+  "totalCost": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ CreateArticlesInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this article in.

+
+
+ specs: +
+
+ CreateArticlesSpec +
+
+ +
+
+

Specifications for creating articles.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "categoryID": "object",
+      "slug": "string",
+      "descriptions": [
+        {
+          "language": "string",
+          "title": "string",
+          "content": "string"
+        }
+      ],
+      "SEOs": [
+        {
+          "language": "string",
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ]
+        }
+      ],
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateArticlesSpec: object + +

+
+
+
+
+
+ categoryID: +
+
+ ID +
+
+ + +
+
+

Category ID to put this article in.

+
+
+ slug: +
+
+ String +
+
+ + +
+
+

Slug for this article.

+
+
+ descriptions: +
+
+ ArticleDescriptionInput +
+
+ +
+
+

Descriptions for this article.

+
+
+ SEOs: +
+
+ SEOInput +
+
+ +
+
+

Article's search engine optimations.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this article is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "categoryID": "object",
+  "slug": "string",
+  "descriptions": [
+    {
+      "language": "string",
+      "title": "string",
+      "content": "string"
+    }
+  ],
+  "SEOs": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ]
+    }
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CreateBrandInput: object + +

+
+
+
+
+
+ tenantID: +
+
+ String +
+
+ + +
+
+

Tenant ID to put this brand in.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of this brand.

+
+
+ logoURL: +
+
+ String +
+
+ +
+
+

URL of this brand's logo.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this brand is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "tenantID": "string",
+  "name": "string",
+  "logoURL": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CreateEnquiryInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ specs: +
+
+ CreateEnquirySpec +
+
+ +
+
+

Specifications for create testimonials input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "specs": [
+    {
+      "email": "string",
+      "message": "string",
+      "name": "string",
+      "phone": "string",
+      "referer": "string",
+      "subject": "string",
+      "customFields": [
+        {
+          "key": "string",
+          "value": "string"
+        }
+      ],
+      "createdAt": "number",
+      "updatedAt": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateEnquirySpec: object + +

+
+
+
+
+
+ email: +
+
+ String +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ referer: +
+
+ String +
+
+ +
+
+ subject: +
+
+ String +
+
+ +
+
+ customFields: +
+
+ CustomFieldInput +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "string",
+  "message": "string",
+  "name": "string",
+  "phone": "string",
+  "referer": "string",
+  "subject": "string",
+  "customFields": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "createdAt": "number",
+  "updatedAt": "number"
+}
+
+ + +
+
+
+
+
+

+ CreateLookbookInput: object + +

+
+
+
+
+
+ imageURL: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "imageURL": "string",
+  "name": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ CreateNewsletterSpec: object + +

+
+
+
+
+
+ email: +
+
+ String +
+
+ + +
+
+

The email that will receive newsletter.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "string"
+}
+
+ + +
+
+
+
+
+

+ CreateNewslettersInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID to put the newsletter in.

+
+
+ specs: +
+
+ CreateNewsletterSpec +
+
+ +
+
+

Specifications for creating newsletter input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "specs": [
+    {
+      "email": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateOrderInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

Brand ID to put this order in.

+
+
+ specs: +
+
+ OrderSpecs +
+
+ +
+
+

Specifications for creating order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "specs": [
+    {
+      "memberID": "string",
+      "invoiceID": "string",
+      "channelID": "string",
+      "discount": {
+        "code": "string",
+        "value": "number"
+      },
+      "totalCost": {
+        "code": "string",
+        "value": "number"
+      },
+      "buyerNote": "string",
+      "billingAddress": {
+        "name": "string",
+        "email": "string",
+        "phone": "string",
+        "country": "string",
+        "province": "string",
+        "city": "string",
+        "subDistrict": "string",
+        "street": "string",
+        "districtCode": "string",
+        "postalCode": "string"
+      },
+      "deliveryAddress": {
+        "name": "string",
+        "email": "string",
+        "phone": "string",
+        "country": "string",
+        "province": "string",
+        "city": "string",
+        "subDistrict": "string",
+        "street": "string",
+        "districtCode": "string",
+        "postalCode": "string"
+      },
+      "lineItems": [
+        {
+          "title": "string",
+          "SKU": "string",
+          "quantity": "number",
+          "price": {
+            "code": "string",
+            "value": "number"
+          },
+          "imageURL": "string"
+        }
+      ],
+      "shipping": {
+        "provider": "string",
+        "service": "string",
+        "cost": {
+          "code": "string",
+          "value": "number"
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateOrderParam: object + +

+
+
+
+
+
+ billingInfo: +
+ +
+ +
+
+ shippingInfo: +
+ +
+ +
+
+ sameWithBillingInfo: +
+
+ Boolean +
+
+ +
+
+ items: +
+
+ OrderItem +
+
+ +
+
+ payments: +
+ +
+ +
+
+ buyersMessage: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "billingInfo": {
+    "salutation": "string",
+    "fullName": "string",
+    "addressLine": "string",
+    "district": "string",
+    "city": "string",
+    "province": "string",
+    "country": "string",
+    "phoneNumber": "string",
+    "email": "string",
+    "postalCode": "string"
+  },
+  "shippingInfo": {
+    "method": "string",
+    "cost": "number"
+  },
+  "sameWithBillingInfo": "boolean",
+  "items": [
+    {
+      "productCode": "string",
+      "quantity": "number"
+    }
+  ],
+  "payments": {
+    "coupon": "string",
+    "method": "string"
+  },
+  "buyersMessage": "string"
+}
+
+ + +
+
+
+
+
+

+ CreateOrderRes: object + +

+
+
+
+
+
+ status: +
+
+ Int +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "status": "number",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ CreateProductInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put the product in.

+
+
+ specs: +
+
+ CreateProductSpecInput +
+
+ +
+
+

Specifications for creating product.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "details": [
+        {
+          "name": "string",
+          "description": "string",
+          "language": "string"
+        }
+      ],
+      "volume": {
+        "length": "number",
+        "height": "number",
+        "width": "number",
+        "unit": "string"
+      },
+      "weight": {
+        "value": "number",
+        "unit": "string"
+      },
+      "imageURLs": [
+        "string"
+      ],
+      "published": "boolean",
+      "variants": [
+        {
+          "SKU": "object",
+          "options": [
+            {
+              "key": "object",
+              "value": "string"
+            }
+          ],
+          "basePrices": [
+            {
+              "code": "string",
+              "value": "number"
+            }
+          ],
+          "channelIDs": [
+            "string"
+          ],
+          "attributes": [
+            {
+              "sortIndex": "number",
+              "translations": [
+                {
+                  "key": "string",
+                  "value": "string",
+                  "language": "string"
+                }
+              ]
+            }
+          ],
+          "channelAttributes": [
+            {
+              "channelID": "string",
+              "key": "object",
+              "value": "string"
+            }
+          ],
+          "imageURLs": [
+            "string"
+          ],
+          "stock": "number",
+          "ignoreStock": "boolean"
+        }
+      ],
+      "slug": "string",
+      "SEOs": [
+        {
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ]
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateProductSpecInput: object + +

+
+
+
+
+
+ details: +
+
+ TranslatableDetailInput +
+
+ +
+
+

Details for the created product.

+
+
+ volume: +
+ +
+ + +
+
+

Volume of the product.

+
+
+ weight: +
+ +
+ + +
+
+

Weight of the product.

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+

URL of the product's image.

+
+
+ published: +
+
+ Boolean +
+
+ + +
+
+

A flag di indicate whether this product is published or not.

+
+
+ variants: +
+
+ VariantUpsertInput +
+
+ +
+
+

Variants for create product specifications.

+
+
+ slug: +
+
+ String +
+
+ + +
+
+

Ths slug of the product. Must be unique.

+
+
+ SEOs: +
+
+ TranslatableSEOInput +
+
+ +
+
+

Search engine optimations for create product specifications

+
+
+ condition: +
+
+ String +
+
+ +
+
+

Condition of the product.

+
+
+ attributes: +
+
+ TranslatableAttributeInput +
+
+ +
+
+

Attributes for create product specifications.

+
+
+ channelAttributes: +
+
+ ProductChannelAttributeInput +
+
+ +
+
+

Channel attributes for create product specifications.

+
+
+ relatedProductIds: +
+
+ ID +
+
+ +
+
+

Other products that are related to this product.

+
+
+ tagKeys: +
+
+ String +
+
+ +
+
+

Tags for this product.

+
+
+ collectionIds: +
+
+ ID +
+
+ +
+
+

List of collection IDs that have this product in them.

+
+
+ schedulePublishAt: +
+
+ Int +
+
+ +
+
+

Time when the product can be viewed.

+
+
+ scheduleOpenOrderAt: +
+
+ Int +
+
+ +
+
+

Time when the product can be ordered.

+
+
+ scheduleCloseOrderAt: +
+
+ Int +
+
+ +
+
+

Time when the product can't be ordered anymore.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "details": [
+    {
+      "name": "string",
+      "description": "string",
+      "language": "string"
+    }
+  ],
+  "volume": {
+    "length": "number",
+    "height": "number",
+    "width": "number",
+    "unit": "string"
+  },
+  "weight": {
+    "value": "number",
+    "unit": "string"
+  },
+  "imageURLs": [
+    "string"
+  ],
+  "published": "boolean",
+  "variants": [
+    {
+      "SKU": "object",
+      "options": [
+        {
+          "key": "object",
+          "value": "string"
+        }
+      ],
+      "basePrices": [
+        {
+          "code": "string",
+          "value": "number"
+        }
+      ],
+      "channelIDs": [
+        "string"
+      ],
+      "attributes": [
+        {
+          "sortIndex": "number",
+          "translations": [
+            {
+              "key": "string",
+              "value": "string",
+              "language": "string"
+            }
+          ]
+        }
+      ],
+      "channelAttributes": [
+        {
+          "channelID": "string",
+          "key": "object",
+          "value": "string"
+        }
+      ],
+      "imageURLs": [
+        "string"
+      ],
+      "stock": "number",
+      "ignoreStock": "boolean"
+    }
+  ],
+  "slug": "string",
+  "SEOs": [
+    {
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ],
+      "language": "string"
+    }
+  ],
+  "condition": "string",
+  "attributes": [
+    null
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateTemplateInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ specs: +
+
+ CreateTemplateSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "emailTemplate": {
+        "buyer": {
+          "bccs": [
+            "string"
+          ],
+          "ccs": [
+            "string"
+          ],
+          "tos": [
+            "string"
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "bccs": [
+            "string"
+          ],
+          "ccs": [
+            "string"
+          ],
+          "tos": [
+            "string"
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        }
+      },
+      "event": {
+        "type": "string",
+        "version": "number"
+      },
+      "smsTemplate": {
+        "buyer": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        }
+      },
+      "whatsAppTemplate": {
+        "buyer": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        },
+        "isActive": "boolean"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateTemplateSpec: object + +

+
+
+
+
+
+ emailTemplate: +
+ +
+ +
+
+ event: +
+ +
+ + +
+
+ smsTemplate: +
+ +
+ +
+
+ whatsAppTemplate: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "emailTemplate": {
+    "buyer": {
+      "bccs": [
+        "string"
+      ],
+      "ccs": [
+        "string"
+      ],
+      "tos": [
+        "string"
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "bccs": [
+        "string"
+      ],
+      "ccs": [
+        "string"
+      ],
+      "tos": [
+        "string"
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    }
+  },
+  "event": {
+    "type": "string",
+    "version": "number"
+  },
+  "smsTemplate": {
+    "buyer": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    }
+  },
+  "whatsAppTemplate": {
+    "buyer": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "targetPhoneNumbers": [
+        "string"
+      ]
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ CreateTestimonialSpec: object + +

+
+
+
+
+
+ email: +
+
+ String +
+
+ + +
+
+ author: +
+
+ String +
+
+ +
+
+ company: +
+
+ String +
+
+ +
+
+ website: +
+
+ String +
+
+ +
+
+ memberID: +
+
+ String +
+
+ +
+
+ productID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ + +
+
+ content: +
+
+ String +
+
+ + +
+
+

Minimum 20 characters needed

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ rating: +
+
+ Int +
+
+ + +
+
+

Between 1-5

+
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ + +
+
+ isFeatured: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "string",
+  "author": "string",
+  "company": "string",
+  "website": "string",
+  "memberID": "string",
+  "productID": "string",
+  "title": "string",
+  "content": "string",
+  "imageURLs": [
+    "string"
+  ],
+  "rating": "number",
+  "createdAt": "number",
+  "updatedAt": "number",
+  "published": "boolean",
+  "isFeatured": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CreateTestimonialsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ specs: +
+
+ CreateTestimonialSpec +
+
+ +
+
+

Specifications for create testimonials input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "specs": [
+    {
+      "email": "string",
+      "author": "string",
+      "company": "string",
+      "website": "string",
+      "memberID": "string",
+      "productID": "string",
+      "title": "string",
+      "content": "string",
+      "imageURLs": [
+        "string"
+      ],
+      "rating": "number",
+      "createdAt": "number",
+      "updatedAt": "number",
+      "published": "boolean",
+      "isFeatured": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateWarehouseInput: object + +

+
+
+
+
+
+ tenantID: +
+
+ ID +
+
+ + +
+
+

Tenant ID to put this warehouse in.

+
+
+ address: +
+ +
+ + +
+
+

The warehouse address.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "tenantID": "object",
+  "address": {
+    "phones": [
+      "string"
+    ],
+    "emails": [
+      "string"
+    ],
+    "street": "string",
+    "districtCode": "string",
+    "postalCode": "string",
+    "latitude": "number",
+    "longitude": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ CreateWidgetInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this widget in.

+
+
+ specs: +
+
+ CreateWidgetSpec +
+
+ +
+
+

Specifications for creating widget.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "region": "string",
+      "order": "number",
+      "name": "string",
+      "content": "string",
+      "published": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ CreateWidgetSpec: object + +

+
+
+
+
+
+ region: +
+
+ String +
+
+ + +
+
+

Region of the widget.

+
+
+ order: +
+
+ Int +
+
+ + +
+
+

Order of the widget.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the widget.

+
+
+ content: +
+
+ String +
+
+ + +
+
+

Content of the widget.

+
+
+ published: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the widget is published or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "region": "string",
+  "order": "number",
+  "name": "string",
+  "content": "string",
+  "published": "boolean"
+}
+
+ + +
+
+
+
+
+

+ CurrencyValue: object + +

+
+
+
+
+
+ currencyCode: +
+
+ String +
+
+ + +
+
+ amount: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "currencyCode": "string",
+  "amount": "number"
+}
+
+ + +
+
+
+
+
+

+ CustomFieldInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ DeactivateBrandInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of brand IDs to be deactivated.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeactivateTemplateInput: object + +

+
+
+
+
+
+ email: +
+
+ Boolean +
+
+ +
+
+ sms: +
+
+ Boolean +
+
+ +
+
+ whatsApp: +
+
+ Boolean +
+
+ +
+
+ IDs: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "boolean",
+  "sms": "boolean",
+  "whatsApp": "boolean",
+  "IDs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DecisionMenu: object + +

+
+
+
+
+
+ id: +
+
+ ID +
+
+ +
+
+ parentsId: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ sequence: +
+
+ Int +
+
+ +
+
+ root: +
+
+ Boolean +
+
+ +
+
+ textResponse: +
+
+ String +
+
+ +
+
+ fileUrl: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "object",
+  "parentsId": [
+    "string"
+  ],
+  "title": "string",
+  "sequence": "number",
+  "root": "boolean",
+  "textResponse": "string",
+  "fileUrl": "string",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ DecisionMenuInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ brandId: +
+
+ String +
+
+ + +
+
+ menus: +
+
+ DecisionMenuSpecInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "brandId": "string",
+  "menus": [
+    {
+      "id": "object",
+      "parentsId": [
+        "string"
+      ],
+      "title": "string",
+      "sequence": "number",
+      "root": "boolean",
+      "textResponse": "string",
+      "fileUrl": "string",
+      "type": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ DecisionMenuSpecInput: object + +

+
+
+
+
+
+ id: +
+
+ ID +
+
+ +
+
+ parentsId: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ sequence: +
+
+ Int +
+
+ +
+
+ root: +
+
+ Boolean +
+
+ +
+
+ textResponse: +
+
+ String +
+
+ +
+
+ fileUrl: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "object",
+  "parentsId": [
+    "string"
+  ],
+  "title": "string",
+  "sequence": "number",
+  "root": "boolean",
+  "textResponse": "string",
+  "fileUrl": "string",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ DeleteArticleCategoriesInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID of this article category.

+
+
+ categoryIDs: +
+
+ ID +
+
+ +
+
+

List of category IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "categoryIDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteArticlesInput: object + +

+
+
+
+
+
+ articleIDs: +
+
+ ID +
+
+ +
+
+

List of article IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "articleIDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteBundlesInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of bundle IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteCouponsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of coupon IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteDiscountsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of discount IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteMessageTemplateInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ ids: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "ids": [
+    "number"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteNewslettersInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of newsletter IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteNotificationTemplatesInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of notification template IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteProductsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of product IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteShippingInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of shipping IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeleteTestimonialsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of testimonial IDs to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ DeliveryAddress: object + +

+
+
+
+
+
+ locationName: +
+
+ String +
+
+ + +
+
+ receiverName: +
+
+ String +
+
+ + +
+
+ address: +
+
+ String +
+
+ + +
+
+ country: +
+
+ String +
+
+ + +
+
+ state: +
+
+ String +
+
+ + +
+
+ city: +
+
+ String +
+
+ + +
+
+ zipCode: +
+
+ String +
+
+ + +
+
+ receiverPhone: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "locationName": "string",
+  "receiverName": "string",
+  "address": "string",
+  "country": "string",
+  "state": "string",
+  "city": "string",
+  "zipCode": "string",
+  "receiverPhone": "string"
+}
+
+ + +
+
+
+
+ +
+

+ DetailLinksInput: object + +

+
+
+
+
+
+ hexBorderColor: +
+
+ String +
+
+ +
+
+ hexLabelColor: +
+
+ String +
+
+ + +
+
+ iconImage: +
+
+ String +
+
+ + +
+
+ id: +
+
+ String +
+
+ + +
+
+ label: +
+
+ String +
+
+ + +
+
+ ordering: +
+
+ Int +
+
+ +
+
+ url: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "hexBorderColor": "string",
+  "hexLabelColor": "string",
+  "iconImage": "string",
+  "id": "string",
+  "label": "string",
+  "ordering": "number",
+  "url": "string"
+}
+
+ + +
+
+
+
+
+

+ DisconnectMarketplaceInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected brand.

+
+
+ code: +
+
+ ID +
+
+ + +
+
+

The code of the marketplace.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "code": "object"
+}
+
+ + +
+
+
+
+
+

+ Discount: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+ discountID: +
+
+ ID +
+
+ +
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ discountSpec: +
+ +
+ +
+
+ title: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "discountID": "object",
+  "channelIDs": [
+    "string"
+  ],
+  "discountSpec": {
+    "startDate": "number",
+    "endDate": "number",
+    "isActive": "boolean",
+    "referenceType": "string",
+    "maxItem": "number",
+    "rows": [
+      {
+        "referenceID": "object",
+        "discountType": "string",
+        "moneyValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "scalarValue": "number"
+      }
+    ]
+  },
+  "title": "string"
+}
+
+ + +
+
+
+
+
+

+ DiscountField: string + +

+
+
+
+
+
+
object
+ + SHIPPING + + +
+
+
+
object
+ + PRODUCT + + +
+
+
+
object
+ + TOTALCOST + + +
+
+
+
+
+
+
+
+

+ DiscountFilterInput: object + +

+
+
+
+
+
+ salesChannels: +
+
+ String +
+
+ +
+
+ discountType: +
+ +
+ +
+
+ referenceIDs: +
+
+ ID +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "salesChannels": [
+    "string"
+  ],
+  "discountType": "string",
+  "referenceIDs": [
+    "object"
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ DiscountRow: object + +

+
+
+
+
+
+ referenceID: +
+
+ ID +
+
+ + +
+
+ discountType: +
+ +
+ + +
+
+ moneyValue: +
+
+ Money +
+
+ + +
+
+ scalarValue: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "referenceID": "object",
+  "discountType": "string",
+  "moneyValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "scalarValue": "number"
+}
+
+ + +
+
+
+
+
+

+ DiscountSortInput: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ DiscountSpec: object + +

+
+
+
+
+
+ startDate: +
+
+ Int +
+
+ + +
+
+ endDate: +
+
+ Int +
+
+ + +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ referenceType: +
+
+ String +
+
+ + +
+
+ maxItem: +
+
+ Int +
+
+ + +
+
+ rows: +
+
+ DiscountRow +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "startDate": "number",
+  "endDate": "number",
+  "isActive": "boolean",
+  "referenceType": "string",
+  "maxItem": "number",
+  "rows": [
+    {
+      "referenceID": "object",
+      "discountType": "string",
+      "moneyValue": {
+        "code": "string",
+        "value": "number"
+      },
+      "scalarValue": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ DiscountType: string + +

+
+
+
+
+
+
object
+ + ABSOLUTE + + +
+
+
+
object
+ + FIXED + + +
+
+
+
object
+ + PERCENTAGE + + +
+
+
+
+
+
+
+
+

+ DiscountValue: object + +

+
+
+
+
+
+ moneyValue: +
+
+ Money +
+
+ +
+
+ scalarValue: +
+
+ Int +
+
+ +
+
+ maximumDiscountValue: +
+
+ Money +
+
+ +
+
+ discountType: +
+ +
+ +
+
+ discountField: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "moneyValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "scalarValue": "number",
+  "maximumDiscountValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "discountType": "string",
+  "discountField": "string"
+}
+
+ + +
+
+
+
+
+

+ DiscountValueSpec: object + +

+
+
+
+
+
+ moneyValue: +
+ +
+ +
+
+

Use this without scalar value and discount type is FIXED / ABSOLUTE

+
+
+ scalarValue: +
+
+ Int +
+
+ +
+
+

Use this without money value and discount type is PERCENTAGE

+
+
+ maximumDiscountValue: +
+ +
+ +
+
+

Maximum discount value when used.

+
+
+ discountType: +
+ +
+ + +
+
+

The type of discount.

+
+
+ discountField: +
+ +
+ + +
+
+

The field of discount.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "moneyValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "scalarValue": "number",
+  "maximumDiscountValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "discountType": "string",
+  "discountField": "string"
+}
+
+ + +
+
+
+
+
+

+ DiscountValueType: string + +

+
+
+
+
+
+
object
+ + ABSOLUTE + + +
+
+
+
object
+ + FIXED + + +
+
+
+
object
+ + PERCENTAGE + + +
+
+
+
+
+
+
+
+

+ DisplayType: string + +

+
+
+
+
+
+
object
+ + LOOKBOOK + + +
+
+
+
object
+ + STATIC_PAGE + + +
+
+
+
+
+
+
+
+

+ DisplayableError: object + +

+
+
+
+
+
+ field: +
+
+ String +
+
+ + +
+
+ message: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "field": "string",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ District: object + +

+
+
+
+
+
+ locationCode: +
+
+ String +
+
+ +
+
+ providerData: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "locationCode": "string",
+  "providerData": "string"
+}
+
+ + +
+
+
+
+
+

+ Document: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ signerID: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+ token: +
+
+ String +
+
+ +
+
+ URL: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "name": "string",
+  "signerID": "string",
+  "status": "string",
+  "token": "string",
+  "URL": "string"
+}
+
+ + +
+
+
+
+
+

+ DocumentFilterInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+ token: +
+
+ String +
+
+ +
+
+ signerID: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "status": "string",
+  "token": "string",
+  "signerID": "string"
+}
+
+ + +
+
+
+
+
+

+ DocumentsInput: object + +

+
+
+
+
+
+ brandIDs: +
+
+ ID +
+
+ +
+
+ filter: +
+ +
+ +
+
+ sort: +
+
+ SortInput +
+
+ +
+
+ page: +
+
+ PageInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandIDs": [
+    "object"
+  ],
+  "filter": {
+    "name": "string",
+    "status": "string",
+    "token": "string",
+    "signerID": "string"
+  },
+  "sort": [
+    {
+      "fieldName": "string",
+      "isAscending": "boolean"
+    }
+  ],
+  "page": {
+    "pageNumber": "number",
+    "itemPerPage": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ DryRunImport: object + +

+
+
+
+
+
+ dryRunStatus: +
+
+ String +
+
+ +
+
+

Dry run status of the imported file

+
+
+ failedRows: +
+
+ FailedRow +
+
+ +
+
+

Failed rows if any

+
+
+ previewData: +
+
+ JSON +
+
+ +
+
+

Preview of Imported data

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "dryRunStatus": "string",
+  "failedRows": [
+    {
+      "column": "number",
+      "row": "number",
+      "errorCause": "string"
+    }
+  ],
+  "previewData": "object"
+}
+
+ + +
+
+
+
+
+

+ EmailDestinationInput: object + +

+
+
+
+
+
+ type: +
+ +
+ + +
+
+

Type for email destination input

+
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "type": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ EmailTemplateInputV2: object + +

+
+
+
+
+
+ buyer: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+ seller: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyer": {
+    "bccs": [
+      "string"
+    ],
+    "ccs": [
+      "string"
+    ],
+    "tos": [
+      "string"
+    ],
+    "translations": [
+      {
+        "body": "string",
+        "language": "string",
+        "subject": "string"
+      }
+    ]
+  },
+  "isActive": "boolean",
+  "seller": {
+    "bccs": [
+      "string"
+    ],
+    "ccs": [
+      "string"
+    ],
+    "tos": [
+      "string"
+    ],
+    "translations": [
+      {
+        "body": "string",
+        "language": "string",
+        "subject": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ EmailTemplateSpecV2: object + +

+
+
+
+
+
+ bccs: +
+
+ String +
+
+ +
+
+ ccs: +
+
+ String +
+
+ +
+
+ tos: +
+
+ String +
+
+ +
+
+ translations: +
+
+ EmailTranslationInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "bccs": [
+    "string"
+  ],
+  "ccs": [
+    "string"
+  ],
+  "tos": [
+    "string"
+  ],
+  "translations": [
+    {
+      "body": "string",
+      "language": "string",
+      "subject": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ EmailTranslationInput: object + +

+
+
+
+
+
+ body: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+ subject: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "body": "string",
+  "language": "string",
+  "subject": "string"
+}
+
+ + +
+
+
+
+
+

+ Enquiry: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ customFields: +
+
+ EnquiryCustomField +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ referer: +
+
+ String +
+
+ +
+
+ subject: +
+
+ String +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "brandID": "string",
+  "customFields": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "email": "string",
+  "message": "string",
+  "name": "string",
+  "phone": "string",
+  "referer": "string",
+  "subject": "string",
+  "createdAt": "number",
+  "updatedAt": "number"
+}
+
+ + +
+
+
+
+
+

+ EnquiryCustomField: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ErrorMessage: object + +

+
+
+
+
+
+ settingKey: +
+
+ String +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "settingKey": "string",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ ExcelFile: object + +

+
+
+
+
+
+ url: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "url": "string"
+}
+
+ + +
+
+
+
+
+

+ ExchangeAuthorizationCodeInput: object + +

+
+
+
+
+
+ authorizationCode: +
+
+ String +
+
+ + +
+
+

Received authorization code from OAuth.

+
+
+ redirectURI: +
+
+ String +
+
+ + +
+
+

URI to redirect user after authorization is successful.

+
+
+ isAdmin: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the user is an admin or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "authorizationCode": "string",
+  "redirectURI": "string",
+  "isAdmin": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ExchangePointFilter: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ +
+
+ membershipLevel: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "membershipLevel": "string"
+}
+
+ + +
+
+
+
+
+

+ ExchangePointSetting: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ pointProvider: +
+
+ String +
+
+ + +
+
+ membershipLevel: +
+
+ String +
+
+ + +
+
+ moneyPerPoint: +
+
+ Int +
+
+ +
+
+ pointPerMoney: +
+
+ Int +
+
+ +
+
+ maximumPointsToExchangePerTransaction: +
+
+ Int +
+
+ +
+
+ minimumPointsToExchangePerTransaction: +
+
+ Int +
+
+ +
+
+ minimumMoneyToSpendPerTransaction: +
+
+ Int +
+
+ +
+
+ maximumMoneyToConvertPerTransaction: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string",
+                                    "tenant": {}
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ EximHistory: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ String +
+
+ +
+
+ jobID: +
+
+ String +
+
+ +
+
+ fileName: +
+
+ String +
+
+ +
+
+ fileURL: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ +
+
+ percentProgress: +
+
+ Int +
+
+ +
+
+ recordCount: +
+
+ Int +
+
+ +
+
+ uploadedAt: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "string",
+  "jobID": "string",
+  "fileName": "string",
+  "fileURL": "string",
+  "email": "string",
+  "channel": "string",
+  "percentProgress": "number",
+  "recordCount": "number",
+  "uploadedAt": "number"
+}
+
+ + +
+
+
+
+
+

+ EximHistoryFilterInput: object + +

+
+
+
+
+
+ historyType: +
+ +
+ +
+
+ channel: +
+
+ String +
+
+ +
+
+ uploadStartDate: +
+
+ Int +
+
+ +
+
+ uploadEndDate: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "historyType": "string",
+  "channel": "string",
+  "uploadStartDate": "number",
+  "uploadEndDate": "number"
+}
+
+ + +
+
+
+
+
+

+ EximHistorySortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ExportNewslettersInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

The brand that will receive exported list of newsletters.

+
+
+ columnNames: +
+
+ String +
+
+ +
+
+

Newsletter field name, if empty then it will export all of the fields.

+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

Newsletter IDs that will be exported.

+
+
+ sendToEmail: +
+
+ String +
+
+ + +
+
+

The email that will receive exported list of newsletters.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "columnNames": [
+    "string"
+  ],
+  "IDs": [
+    "object"
+  ],
+  "sendToEmail": "string"
+}
+
+ + +
+
+
+
+
+

+ ExportProductsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+

Brand ID to put the product in.

+
+
+ spec: +
+ +
+ + +
+
+

Specifications for exporting product.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "spec": {
+    "columnNames": [
+      "string"
+    ],
+    "IDs": [
+      "object"
+    ],
+    "sendToEmail": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ ExportProductsSpecInput: object + +

+
+
+
+
+
+ columnNames: +
+
+ String +
+
+ +
+
+

Product field name, if empty then it will export all of the fields.

+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

Product IDs that will be exported.

+
+
+ sendToEmail: +
+
+ String +
+
+ + +
+
+

The email that will receive exported list of products.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "columnNames": [
+    "string"
+  ],
+  "IDs": [
+    "object"
+  ],
+  "sendToEmail": "string"
+}
+
+ + +
+
+
+
+
+

+ ExtraAttributes: object + +

+
+
+
+
+
+ customerSMCode: +
+
+ String +
+
+ +
+
+ isDropship: +
+
+ Boolean +
+
+ +
+
+ SMCode: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "customerSMCode": "string",
+  "isDropship": "boolean",
+  "SMCode": "string"
+}
+
+ + +
+
+
+
+
+

+ FacebookAnalytics: object + +

+
+
+
+
+
+ pixelId: +
+
+ String +
+
+ +
+
+ catalogId: +
+
+ String +
+
+ +
+
+ accessToken: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "pixelId": "string",
+  "catalogId": "string",
+  "accessToken": "string"
+}
+
+ + +
+
+
+
+
+

+ FacebookAnalyticsInput: object + +

+
+
+
+
+
+ pixelId: +
+
+ String +
+
+ +
+
+ catalogId: +
+
+ String +
+
+ +
+
+ accessToken: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "pixelId": "string",
+  "catalogId": "string",
+  "accessToken": "string"
+}
+
+ + +
+
+
+
+
+

+ FacebookSetting: object + +

+
+
+
+
+
+ accessToken: +
+
+ String +
+
+ + +
+
+ catalogId: +
+
+ String +
+
+ + +
+
+ pixelId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "accessToken": "string",
+  "catalogId": "string",
+  "pixelId": "string"
+}
+
+ + +
+
+
+
+
+

+ FacebookSettingInput: object + +

+
+
+
+
+
+ pixelId: +
+
+ String +
+
+ + +
+
+ catalogId: +
+
+ String +
+
+ + +
+
+ accessToken: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "pixelId": "string",
+  "catalogId": "string",
+  "accessToken": "string"
+}
+
+ + +
+
+
+
+
+

+ FailedRow: object + +

+
+
+
+
+
+ column: +
+
+ Int +
+
+ +
+
+

Column position of the error record

+
+
+ row: +
+
+ Int +
+
+ +
+
+

Row position of the error record

+
+
+ errorCause: +
+
+ String +
+
+ +
+
+

Cause of error

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "column": "number",
+  "row": "number",
+  "errorCause": "string"
+}
+
+ + +
+
+
+
+
+

+ Feature: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ isEnabled: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "isEnabled": "boolean"
+}
+
+ + +
+
+
+
+
+

+ File: object + +

+
+
+
+
+
+ url: +
+
+ String +
+
+ +
+
+ filename: +
+
+ String +
+
+ +
+
+ mimetype: +
+
+ String +
+
+ +
+
+ encoding: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "url": "string",
+  "filename": "string",
+  "mimetype": "string",
+  "encoding": "string"
+}
+
+ + +
+
+
+
+
+

+ Float: number + +

+
+
+
+

The Float scalar type represents signed double-precision fractional values as specified by + IEEE 754.

+
+
+
+
+
Example
+ + + + 
number
+
+ + +
+
+
+
+
+

+ ForgotPasswordInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID for this account.

+
+
+ email: +
+
+ String +
+
+ +
+
+

Account's email for password recovery.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "email": "string"
+}
+
+ + +
+
+
+
+
+

+ GcsAction: string + +

+
+
+
+
+
+
object
+ + read + + +
+
+
+
object
+ + write + + +
+
+
+
object
+ + delete + + +
+
+
+
+
+
+
+
+

+ GenerateAPIKeyInput: object + +

+
+
+
+
+
+ accountId: +
+
+ String +
+
+ + +
+
+

account that will be generated an API Key

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountId": "string"
+}
+
+ + +
+
+
+
+
+

+ GeneratePaymentLinkInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID for the payment link.

+
+
+ info: +
+
+ String +
+
+ +
+
+

Information about the payment.

+
+
+ method: +
+
+ String +
+
+ + +
+
+

Payment method of this payment.

+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

Order ID for the payment link.

+
+
+ providerID: +
+
+ String +
+
+ + +
+
+

Provider ID of the payment.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "info": "string",
+  "method": "string",
+  "orderID": "string",
+  "providerID": "string"
+}
+
+ + +
+
+
+
+
+

+ GetBusinessHoursInput: object + +

+
+
+
+
+
+ sellerID: +
+
+ ID +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerID": "object"
+}
+
+ + +
+
+
+
+
+

+ GetSignedUrlInput: object + +

+
+
+
+
+
+ uploadType: +
+ +
+ + +
+
+ pathName: +
+
+ String +
+
+ + +
+
+ fileName: +
+
+ String +
+
+ + +
+
+ contentType: +
+
+ String +
+
+ + +
+
+ method: +
+
+ GcsAction +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "uploadType": "string",
+  "pathName": "string",
+  "fileName": "string",
+  "contentType": "string",
+  "method": "string"
+}
+
+ + +
+
+
+
+
+

+ GetSignedlUrl: object + +

+
+
+
+
+
+ uploadType: +
+ +
+ + +
+
+ pathName: +
+
+ String +
+
+ + +
+
+ fileName: +
+
+ String +
+
+ + +
+
+ contentType: +
+
+ String +
+
+ + +
+
+ method: +
+
+ GcsAction +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "uploadType": "string",
+  "pathName": "string",
+  "fileName": "string",
+  "contentType": "string",
+  "method": "string"
+}
+
+ + +
+
+
+
+
+

+ GoogleAdsCampaign: object + +

+
+
+
+
+
+ budget: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "budget": "number"
+}
+
+ + +
+
+
+
+
+

+ GoogleAdsRelatedAccounts: object + +

+
+
+
+
+
+ googleAccount: +
+
+ String +
+
+ +
+
+ merchantId: +
+
+ Int +
+
+ +
+
+ googleAdsId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "googleAccount": "string",
+  "merchantId": "number",
+  "googleAdsId": "string"
+}
+
+ + +
+
+
+
+
+

+ GoogleAdsReport: object + +

+
+
+
+
+
+ impressions: +
+
+ Int +
+
+ +
+
+ clicks: +
+
+ Int +
+
+ +
+
+ conversionRate: +
+
+ Float +
+
+ +
+
+ purchaseSales: +
+
+ Float +
+
+ +
+
+ cost: +
+
+ Int +
+
+ +
+
+ budget: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "impressions": "number",
+  "clicks": "number",
+  "conversionRate": "number",
+  "purchaseSales": "number",
+  "cost": "number",
+  "budget": "number"
+}
+
+ + +
+
+
+
+
+

+ GoogleAnalytics: object + +

+
+
+
+
+
+ universalAnalytics: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "universalAnalytics": {
+    "trackingId": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ GoogleAnalyticsInput: object + +

+
+
+
+
+
+ universalAnalytics: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "universalAnalytics": {
+    "trackingId": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ GoogleAuth: object + +

+
+
+
+
+
+ clientId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "clientId": "string"
+}
+
+ + +
+
+
+
+
+

+ GoogleAuthInput: object + +

+
+
+
+
+
+ clientId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "clientId": "string"
+}
+
+ + +
+
+
+
+
+

+ GoogleSetting: object + +

+
+
+
+
+
+ universalAnalytics: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "universalAnalytics": {
+    "trackingId": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ GoogleSettingInput: object + +

+
+
+
+
+
+ universalAnalytics: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "universalAnalytics": {
+    "trackingId": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ GranularStatusInput: object + +

+
+
+
+
+
+ specs: +
+
+ GranularStatusInputSpec +
+
+ +
+
+

Specifications for granular status input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "notes": "string",
+      "orderID": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ GranularStatusInputSpec: object + +

+
+
+
+
+
+ notes: +
+
+ String +
+
+ +
+
+

Notes for that order.

+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "notes": "string",
+  "orderID": "string"
+}
+
+ + +
+
+
+
+
+

+ HistoryTypeEximHistory: string + +

+
+
+
+
+
+
object
+ + import + + +
+
+
+
object
+ + export + + +
+
+
+
+
+
+
+
+

+ ID: object + +

+
+
+
+

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

+
+
+
+
+
Example
+ + + + 
object
+
+ + +
+
+
+
+
+

+ IdTokenLogin: object + +

+
+
+
+
+
+ accessToken: +
+
+ String +
+
+ + +
+
+ email: +
+
+ String +
+
+ + +
+
+ firstName: +
+
+ String +
+
+ + +
+
+ lastName: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "accessToken": "string",
+  "email": "string",
+  "firstName": "string",
+  "lastName": "string"
+}
+
+ + +
+
+
+
+
+

+ Identity: object + +

+
+
+
+
+
+ signerID: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "signerID": "string",
+  "email": "string",
+  "phone": "string",
+  "status": "string",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ IdentityInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ accessToken: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "accessToken": "string"
+}
+
+ + +
+
+
+
+
+

+ ImportExcelInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ fileName: +
+
+ String +
+
+ + +
+
+

Name of excel file

+
+
+ ignoreErrorRecord: +
+
+ Boolean +
+
+ +
+
+

Flag to ignore error record

+
+
+ moduleName: +
+
+ String +
+
+ + +
+
+

The module name

+
+
+ sendToEmail: +
+
+ String +
+
+ + +
+
+

The email used to receive information about imported excel

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "fileName": "string",
+  "ignoreErrorRecord": "boolean",
+  "moduleName": "string",
+  "sendToEmail": "string"
+}
+
+ + +
+
+
+
+
+

+ ImportStatus: object + +

+
+
+
+
+
+ importStatus: +
+
+ String +
+
+ +
+
+

Import status of a file

+
+
+ failedRows: +
+
+ FailedRow +
+
+ +
+
+

Failed rows if any

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "importStatus": "string",
+  "failedRows": [
+    {
+      "column": "number",
+      "row": "number",
+      "errorCause": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ InputNavigationTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ text: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ InstagramFeed: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ caption: +
+
+ String +
+
+ + +
+
+ images: +
+
+ String +
+
+ +
+
+ thumbnail: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "caption": "string",
+  "images": [
+    "string"
+  ],
+  "thumbnail": "string"
+}
+
+ + +
+
+
+
+
+

+ InstagramFeeds: object + +

+
+
+
+
+
+ items: +
+
+ InstagramFeed +
+
+ +
+
+ pageInfo: +
+ +
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "caption": "string",
+      "images": [
+        "string"
+      ],
+      "thumbnail": "string"
+    }
+  ],
+  "pageInfo": {
+    "hasNextPage": "boolean",
+    "endCursor": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ InstagramFeedsInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

User's Instagram ID.

+
+
+ first: +
+
+ Int +
+
+ + +
+
+

Total row per page, max: 50 row per page.

+
+
+ after: +
+
+ String +
+
+ +
+
+

Query hash for next page.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "first": "number",
+  "after": "string"
+}
+
+ + +
+
+
+
+
+

+ InstagramPageInfo: object + +

+
+
+
+
+
+ hasNextPage: +
+
+ Boolean +
+
+ + +
+
+ endCursor: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "hasNextPage": "boolean",
+  "endCursor": "string"
+}
+
+ + +
+
+
+
+
+

+ Int: number + +

+
+
+
+

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

+
+
+
+
+
Example
+ + + + 
number
+
+ + +
+
+
+
+
+

+ IntValueParameter: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "number"
+}
+
+ + +
+
+
+
+
+

+ IntegrateMarketplaceInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected brand.

+
+
+ code: +
+
+ ID +
+
+ + +
+
+

The code of the marketplace.

+
+
+ payload: +
+
+ String +
+
+ + +
+
+

Payload that contains credentials for the marketplace.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "code": "object",
+  "payload": "string"
+}
+
+ + +
+
+
+
+
+

+ Item: object + +

+
+
+
+
+
+ sku: +
+
+ String +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+ basePrice: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sku": "string",
+  "quantity": "number",
+  "basePrice": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ JSON: object + +

+
+
+
+
+
Example
+ + + + 
object
+
+ + +
+
+
+
+
+

+ Job: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string"
+}
+
+ + +
+
+
+
+
+

+ LegacyPaymentMethod: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ LengthUnitEnum: string + +

+
+
+
+
+
+
object
+ + CM + + +
+
+
+
object
+ + M + + +
+
+
+
object
+ + INCH + + +
+
+
+
+
+
+
+
+

+ LineItem: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ +
+
+ SKU: +
+
+ String +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+ price: +
+
+ Money +
+
+ +
+
+ imageURL: +
+
+ String +
+
+ +
+
+ availableStock: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "SKU": "string",
+  "quantity": "number",
+  "price": {
+    "code": "string",
+    "value": "number"
+  },
+  "imageURL": "string",
+  "availableStock": "number"
+}
+
+ + +
+
+
+
+
+

+ LineItemInput: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ + +
+
+ SKU: +
+
+ String +
+
+ + +
+
+ quantity: +
+
+ Int +
+
+ + +
+
+ price: +
+ +
+ + +
+
+ imageURL: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "SKU": "string",
+  "quantity": "number",
+  "price": {
+    "code": "string",
+    "value": "number"
+  },
+  "imageURL": "string"
+}
+
+ + +
+
+
+
+
+

+ LinkGoogleAdsAccountInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ LinkGoogleMerchantAccountInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+ websiteURL: +
+
+ String +
+
+ +
+
+

The website url for the merchant account.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "websiteURL": "string"
+}
+
+ + +
+
+
+
+
+

+ Linkspage: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ + +
+
+ backgroundColor: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ hexTextColor: +
+
+ String +
+
+ + +
+
+ logoImage: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ +
+
+ detailLinks: +
+
+ DetailLinks +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string",
+  "backgroundColor": "string",
+  "description": "string",
+  "hexTextColor": "string",
+  "logoImage": "string",
+  "name": "string",
+  "detailLinks": [
+    {
+      "hexBorderColor": "string",
+      "hexLabelColor": "string",
+      "iconImage": "string",
+      "id": "string",
+      "label": "string",
+      "ordering": "number",
+      "url": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ LinkspageInput: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string"
+}
+
+ + +
+
+
+
+
+

+ ListDecisionMenu: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ +
+
+ brandId: +
+
+ String +
+
+ +
+
+ menus: +
+
+ DecisionMenu +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "brandId": "string",
+  "menus": [
+    {
+      "id": "object",
+      "parentsId": [
+        "string"
+      ],
+      "title": "string",
+      "sequence": "number",
+      "root": "boolean",
+      "textResponse": "string",
+      "fileUrl": "string",
+      "type": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ Lookbook: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ String +
+
+ + +
+
+ imageURL: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ images: +
+
+ LookbookImage +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ slug: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "string",
+  "imageURL": "string",
+  "name": "string",
+  "images": [
+    {
+      "title": "string",
+      "language": "string",
+      "imageURL": "string"
+    }
+  ],
+  "isActive": "boolean",
+  "slug": "string"
+}
+
+ + +
+
+
+
+
+

+ LookbookImage: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+ imageURL: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "language": "string",
+  "imageURL": "string"
+}
+
+ + +
+
+
+
+
+

+ LookbookImageInput: object + +

+
+
+
+
+
+ URL: +
+
+ String +
+
+ + +
+
+ title: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "URL": "string",
+  "title": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ LookbookList: object + +

+
+
+
+
+
+ items: +
+
+ Lookbook +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "brandID": "string",
+      "imageURL": "string",
+      "name": "string",
+      "images": [
+        {
+          "title": "string",
+          "language": "string",
+          "imageURL": "string"
+        }
+      ],
+      "isActive": "boolean",
+      "slug": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ LoyaltyPoint: object + +

+
+
+
+
+
+ amount: +
+
+ Int +
+
+ + +
+
+ history: +
+
+ LoyaltyPointHistory +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "amount": "number",
+  "history": [
+    {
+      "delta": "number",
+      "happenedAt": "number",
+      "info": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ LoyaltyPointHistory: object + +

+
+
+
+
+
+ delta: +
+
+ Int +
+
+ + +
+
+ happenedAt: +
+
+ Int +
+
+ + +
+
+ info: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "delta": "number",
+  "happenedAt": "number",
+  "info": "string"
+}
+
+ + +
+
+
+
+
+

+ MarketingTenant: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ dateCreated: +
+
+ String +
+
+ +
+
+ salutation: +
+
+ String +
+
+ +
+
+ firstName: +
+
+ String +
+
+ +
+
+ dateOfBirth: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ alternatifEmail: +
+
+ String +
+
+ +
+
+ phoneNumber: +
+
+ String +
+
+ +
+
+ alternatifPhoneNumber: +
+
+ String +
+
+ +
+
+ addressLine: +
+
+ String +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+ state: +
+
+ String +
+
+ +
+
+ country: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "dateCreated": "string",
+  "salutation": "string",
+  "firstName": "string",
+  "dateOfBirth": "string",
+  "email": "string",
+  "alternatifEmail": "string",
+  "phoneNumber": "string",
+  "alternatifPhoneNumber": "string",
+  "addressLine": "string",
+  "postalCode": "string",
+  "state": "string",
+  "country": "string"
+}
+
+ + +
+
+
+
+
+

+ MarketplaceConnection: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ + +
+
+ fullName: +
+
+ String +
+
+ + +
+
+ info: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string",
+  "fullName": "string",
+  "info": "string"
+}
+
+ + +
+
+
+
+
+

+ MarketplaceConnectionForm: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ + +
+
+ fullName: +
+
+ String +
+
+ + +
+
+ type: +
+
+ String +
+
+ + +
+
+ fields: +
+
+ MarketplaceConnectionFormField +
+
+ +
+
+ url: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string",
+  "fullName": "string",
+  "type": "string",
+  "fields": [
+    {
+      "name": "string",
+      "label": "string",
+      "type": "string"
+    }
+  ],
+  "url": "string"
+}
+
+ + +
+
+
+
+
+

+ MarketplaceConnectionFormField: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+ label: +
+
+ String +
+
+ + +
+
+ type: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "label": "string",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ Member: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+ ID: +
+
+ String +
+
+ + +
+
+ addresses: +
+
+ MemberAddress +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ firstName: +
+
+ String +
+
+ +
+
+ lastName: +
+
+ String +
+
+ +
+
+ gender: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ dateOfBirth: +
+
+ Int +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+ level: +
+
+ String +
+
+ +
+
+ loyaltyPoint: +
+ +
+ +
+
+ membership: +
+ +
+ +
+
+ haveAccessTo: +
+
+ Boolean +
+
+ + +
+
+ haveAccessToWithReason: +
+ +
+ + +
+
+ orders: +
+ +
+ +
+
+

Query order within brand.

+

'query' is prioritized, 'filter' is only used if 'query' is not specfied

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "ID": "string",
+  "addresses": [
+    {
+      "addressLabel": "string",
+      "contactName": "string",
+      "districtCode": "string",
+      "location": "string",
+      "street": "string",
+      "latitude": "string",
+      "longitude": "string",
+      "postalCode": "string",
+      "isPrimary": "boolean",
+      "salesChannel": "string"
+    }
+  ],
+  "email": "string",
+  "firstName": "string",
+  "lastName": "string",
+  "gender": "string",
+  "phone": "string",
+  "dateOfBirth": "number",
+  "createdAt": "number",
+  "updatedAt": "number",
+  "level": "string",
+  "loyaltyPoint": {
+    "amount": "number",
+    "history": [
+      {
+        "delta": "number",
+        "happenedAt": "number",
+        "info": "string"
+      }
+    ]
+  },
+  "membership": {
+    "point": "number",
+    "history": [
+      {
+        "delta": "number",
+        "happenedAt": "number",
+        "info": "string"
+      }
+    ]
+  },
+  "haveAccessTo": "boolean",
+  "haveAccessToWithReason": {
+    "allowed": "boolean",
+    "reason": "string"
+  },
+  "orders": {
+    "items": [
+      {
+        "ID": "string",
+        "brandID": "object",
+        "channelID": "string",
+        "brand": {
+          "ID": "string",
+          "name": "string",
+          "tenantID": "string"
+        }
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ MemberAccount: object + +

+
+
+
+
+
+ firstName: +
+
+ String +
+
+ + +
+
+ lastName: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ + +
+
+ phone: +
+
+ String +
+
+ + +
+
+ dateOfBirth: +
+
+ Timestamp +
+
+ +
+
+ deliveryAddress: +
+
+ DeliveryAddress +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "firstName": "string",
+  "lastName": "string",
+  "email": "string",
+  "phone": "string",
+  "dateOfBirth": "object",
+  "deliveryAddress": [
+    {
+      "locationName": "string",
+      "receiverName": "string",
+      "address": "string",
+      "country": "string",
+      "state": "string",
+      "city": "string",
+      "zipCode": "string",
+      "receiverPhone": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ MemberAccountUpsertInput: object + +

+
+
+
+
+
+ firstName: +
+
+ String +
+
+ + +
+
+ lastName: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ + +
+
+ password: +
+
+ String +
+
+ + +
+
+ address: +
+
+ String +
+
+ + +
+
+ country: +
+
+ String +
+
+ + +
+
+ state: +
+
+ String +
+
+ + +
+
+ city: +
+
+ String +
+
+ + +
+
+ zipCode: +
+
+ String +
+
+ + +
+
+ phone: +
+
+ String +
+
+ +
+
+ dateOfBirth: +
+
+ Timestamp +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "firstName": "string",
+  "lastName": "string",
+  "email": "string",
+  "password": "string",
+  "address": "string",
+  "country": "string",
+  "state": "string",
+  "city": "string",
+  "zipCode": "string",
+  "phone": "string",
+  "dateOfBirth": "object"
+}
+
+ + +
+
+
+
+
+

+ MemberAccountUpsertResponse: object + +

+
+
+
+
+
+ memberAccount: +
+ +
+ +
+
+ errors: +
+
+ DisplayableError +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "memberAccount": {
+    "firstName": "string",
+    "lastName": "string",
+    "email": "string",
+    "phone": "string",
+    "dateOfBirth": "object",
+    "deliveryAddress": [
+      {
+        "locationName": "string",
+        "receiverName": "string",
+        "address": "string",
+        "country": "string",
+        "state": "string",
+        "city": "string",
+        "zipCode": "string",
+        "receiverPhone": "string"
+      }
+    ]
+  },
+  "errors": [
+    {
+      "field": "string",
+      "message": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ MemberAddress: object + +

+
+
+
+
+
+ addressLabel: +
+
+ String +
+
+ +
+
+ contactName: +
+
+ String +
+
+ +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ location: +
+
+ String +
+
+ +
+
+ street: +
+
+ String +
+
+ +
+
+ latitude: +
+
+ String +
+
+ +
+
+ longitude: +
+
+ String +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+ isPrimary: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "addressLabel": "string",
+  "contactName": "string",
+  "districtCode": "string",
+  "location": "string",
+  "street": "string",
+  "latitude": "string",
+  "longitude": "string",
+  "postalCode": "string",
+  "isPrimary": "boolean",
+  "salesChannel": "string"
+}
+
+ + +
+
+
+
+
+

+ MemberAddressInput: object + +

+
+
+
+
+
+ addressLabel: +
+
+ String +
+
+ +
+
+

Label for this address.

+
+
+ contactName: +
+
+ String +
+
+ +
+
+

Contact name for this address.

+
+
+ districtCode: +
+
+ String +
+
+ + +
+
+

District code for this address.

+
+
+ street: +
+
+ String +
+
+ +
+
+

This address' street name.

+
+
+ latitude: +
+
+ String +
+
+ +
+
+

Address' latitude.

+
+
+ longitude: +
+
+ String +
+
+ +
+
+

Address' longitude.

+
+
+ postalCode: +
+
+ String +
+
+ +
+
+

Postal code for this address.

+
+
+ isPrimary: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this is the primary address or not.

+
+
+ salesChannel: +
+
+ String +
+
+ +
+
+

Sales channel for this address

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "addressLabel": "string",
+  "contactName": "string",
+  "districtCode": "string",
+  "street": "string",
+  "latitude": "string",
+  "longitude": "string",
+  "postalCode": "string",
+  "isPrimary": "boolean",
+  "salesChannel": "string"
+}
+
+ + +
+
+
+
+
+

+ MemberFilterInput: object + +

+
+
+
+
+
+ startCreationDate: +
+
+ Int +
+
+ + +
+
+ endCreationDate: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "startCreationDate": "number",
+  "endCreationDate": "number"
+}
+
+ + +
+
+
+
+
+

+ MemberLoginByIdTokenInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+

Brand ID to log into.

+
+
+ idToken: +
+
+ String +
+
+ + +
+
+

idToken from the login provider response

+
+
+ provider: +
+
+ String +
+
+ + +
+
+

provider that gives the id token

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "idToken": "string",
+  "provider": "string"
+}
+
+ + +
+
+
+
+
+

+ MemberSortFields: string + +

+
+
+
+
+
+
object
+ + ID + + +
+
+
+
object
+ + CREATED_AT + + +
+
+
+
+
+
+
+
+

+ MemberSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+

Field name to be sorted in member sort input.

+
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ Membership: object + +

+
+
+
+
+
+ point: +
+
+ Int +
+
+ + +
+
+ history: +
+
+ MembershipPointHistory +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "point": "number",
+  "history": [
+    {
+      "delta": "number",
+      "happenedAt": "number",
+      "info": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ MembershipPointHistory: object + +

+
+
+
+
+
+ delta: +
+
+ Int +
+
+ + +
+
+ happenedAt: +
+
+ Int +
+
+ + +
+
+ info: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "delta": "number",
+  "happenedAt": "number",
+  "info": "string"
+}
+
+ + +
+
+
+
+
+

+ MessageTemplate: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ id: +
+
+ Int +
+
+ + +
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+ type: +
+
+ String +
+
+ + +
+
+ status: +
+
+ Boolean +
+
+ + +
+
+ category: +
+
+ String +
+
+ + +
+
+ attachment: +
+
+ String +
+
+ +
+
+ attachmentType: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "id": "number",
+  "key": "string",
+  "value": "string",
+  "type": "string",
+  "status": "boolean",
+  "category": "string",
+  "attachment": "string",
+  "attachmentType": "string"
+}
+
+ + +
+
+
+
+
+

+ ModuleAction: object + +

+
+
+
+
+
+ label: +
+
+ String +
+
+ +
+
+ key: +
+
+ String +
+
+ +
+
+ child: +
+
+ ModuleAction +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "label": "string",
+  "key": "string",
+  "child": [
+    {
+      "label": "string",
+      "key": "string",
+      "child": [
+        {
+          "label": "string",
+          "key": "string",
+          "child": [
+            {
+              "label": "string",
+              "key": "string",
+              "child": [
+                {
+                  "label": "string",
+                  "key": "string",
+                  "child": [
+                    {
+                      "label": "string",
+                      "key": "string",
+                      "child": [
+                        {
+                          "label": "string",
+                          "key": "string",
+                          "child": [
+                            {
+                              "label": "string",
+                              "key": "string",
+                              "child": [
+                                {
+                                  "label": "string",
+                                  "key": "string",
+                                  "child": [
+                                    {
+                                      "label": "string",
+                                      "key": "string",
+                                      "child": [
+                                        {
+                                          "label": "string",
+                                          "key": "string",
+                                          "child": [
+                                            {
+                                              "label": "string",
+                                              "key": "string",
+                                              "child": [
+                                                {
+                                                  "label": "string",
+                                                  "key": "string",
+                                                  "child": [
+                                                    {
+                                                      "label": "string",
+                                                      "key": "string",
+                                                      "child": [
+                                                        {}
+                                                      ]
+                                                    }
+                                                  ]
+                                                }
+                                              ]
+                                            }
+                                          ]
+                                        }
+                                      ]
+                                    }
+                                  ]
+                                }
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ Money: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ + +
+
+ value: +
+
+ Float +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string",
+  "value": "number"
+}
+
+ + +
+
+
+
+
+

+ MoneyInput: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ + +
+
+ value: +
+
+ Float +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string",
+  "value": "number"
+}
+
+ + +
+
+
+
+
+

+ MonthlySales: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ orderCount: +
+
+ Int +
+
+ +
+
+ productSales: +
+
+ ProductSales +
+
+ +
+
+ soldQuantity: +
+
+ Int +
+
+ +
+
+ totalDiscount: +
+
+ Money +
+
+ +
+
+ totalNetRevenue: +
+
+ Money +
+
+ +
+
+ totalOrderAmount: +
+
+ Money +
+
+ +
+
+ totalShippingFee: +
+
+ Money +
+
+ +
+
+ yearMonth: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "orderCount": "number",
+  "productSales": [
+    {
+      "orderCount": "number",
+      "productName": "string",
+      "productSKU": "string",
+      "soldQuantity": "number",
+      "totalNetRevenue": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ],
+  "soldQuantity": "number",
+  "totalDiscount": {
+    "code": "string",
+    "value": "number"
+  },
+  "totalNetRevenue": {
+    "code": "string",
+    "value": "number"
+  },
+  "totalOrderAmount": {
+    "code": "string",
+    "value": "number"
+  },
+  "totalShippingFee": {
+    "code": "string",
+    "value": "number"
+  },
+  "yearMonth": "number"
+}
+
+ + +
+
+
+
+
+

+ MonthlySalesFilterInput: object + +

+
+
+
+
+
+ endYearMonth: +
+
+ Int +
+
+ +
+
+ productSKUs: +
+
+ String +
+
+ +
+
+ startYearMonth: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "endYearMonth": "number",
+  "productSKUs": [
+    "string"
+  ],
+  "startYearMonth": "number"
+}
+
+ + +
+
+
+
+
+

+ Navigation: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+ ID: +
+
+ ID +
+
+ +
+
+ parentIDs: +
+
+ String +
+
+ +
+
+ URL: +
+
+ String +
+
+ +
+
+ translations: +
+
+ NavigationTranslation +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ ordering: +
+
+ Int +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "ID": "object",
+  "parentIDs": [
+    "string"
+  ],
+  "URL": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "published": "boolean",
+  "ordering": "number",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ NavigationFilterInput: object + +

+
+
+
+
+
+ published: +
+
+ Boolean +
+
+ +
+
+ translation: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "published": "boolean",
+  "translation": {
+    "language": "string",
+    "text": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ NavigationSortInput: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ NavigationTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ text: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ NewMemberCoupon: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ couponID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ code: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ isValid: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ couponType: +
+ +
+ + +
+
+ maximumUsageCount: +
+
+ Int +
+
+ +
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ +
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ +
+
+ discountValue: +
+ +
+ +
+
+ usages: +
+
+ Usage +
+
+ +
+
+ validityPeriod: +
+
+ Int +
+
+ +
+
+ minimumPurchase: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "couponID": "string",
+  "brandID": "string",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ Newsletter: object + +

+
+
+
+
+
+ popupOnFirstVisit: +
+
+ Boolean +
+
+ +
+
+ content: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "popupOnFirstVisit": "boolean",
+  "content": "string"
+}
+
+ + +
+
+
+
+
+

+ NewsletterCredential: object + +

+
+
+
+
+
+ apiKey: +
+
+ String +
+
+ +
+
+

Apikey for credential newsletter.

+
+
+ listId: +
+
+ String +
+
+ +
+
+

Id for credential newsletter.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "apiKey": "string",
+  "listId": "string"
+}
+
+ + +
+
+
+
+
+

+ NewsletterCredentialInput: object + +

+
+
+
+
+
+ apiKey: +
+
+ String +
+
+ +
+
+

Apikey for credential newsletter.

+
+
+ listId: +
+
+ String +
+
+ +
+
+

Id for credential newsletter.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "apiKey": "string",
+  "listId": "string"
+}
+
+ + +
+
+
+
+
+

+ NewsletterInput: object + +

+
+
+
+
+
+ popupOnFirstVisit: +
+
+ Boolean +
+
+ + +
+
+

A flag to show popup on first visit or not.

+
+
+ content: +
+
+ String +
+
+ + +
+
+

Content of the newsletter.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "popupOnFirstVisit": "boolean",
+  "content": "string"
+}
+
+ + +
+
+
+
+
+

+ NewsletterPopup: object + +

+
+
+
+
+
+ content: +
+
+ String +
+
+ +
+
+

Content of popup newsletter.

+
+
+ popupOnFirstVisit: +
+
+ Boolean +
+
+ +
+
+

A Flag to indicate popup will show when on first visit.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "content": "string",
+  "popupOnFirstVisit": "boolean"
+}
+
+ + +
+
+
+
+
+

+ NewsletterPopupInput: object + +

+
+
+
+
+
+ content: +
+
+ String +
+
+ +
+
+

Content of popup newsletter.

+
+
+ popupOnFirstVisit: +
+
+ Boolean +
+
+ + +
+
+

A Flag to indicate popup will show when on first visit.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "content": "string",
+  "popupOnFirstVisit": "boolean"
+}
+
+ + +
+
+
+
+
+

+ NewsletterSetting: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ credential: +
+ +
+ + +
+
+

Credential detail for newsletter.

+
+
+ popup: +
+ +
+ + +
+
+

Popup detail for newsletter.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "credential": {
+    "apiKey": "string",
+    "listId": "string"
+  },
+  "popup": {
+    "content": "string",
+    "popupOnFirstVisit": "boolean"
+  }
+}
+
+ + +
+
+
+
+
+

+ NewsletterSubscriber: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "brandID": "string",
+  "email": "string",
+  "createdAt": "number"
+}
+
+ + +
+
+
+
+
+

+ Notification: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+ ID: +
+
+ String +
+
+ +
+
+ buyer: +
+
+ String +
+
+ +
+
+ seller: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string",
+  "ID": "string",
+  "buyer": "string",
+  "seller": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationEmailDestination: object + +

+
+
+
+
+
+ type: +
+ +
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "type": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationEmailDestinationType: string + +

+
+
+
+
+
+
object
+ + TO + + +
+
+
+
object
+ + CC + + +
+
+
+
object
+ + BCC + + +
+
+
+
+
+
+
+
+

+ NotificationEmailTemplate: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ destinations: +
+
+ NotificationEmailDestination +
+
+ +
+
+ sendOrder: +
+
+ Int +
+
+ +
+
+ translations: +
+
+ NotificationEmailTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "isActive": "boolean",
+  "destinations": [
+    {
+      "type": "string",
+      "value": "string"
+    }
+  ],
+  "sendOrder": "number",
+  "translations": [
+    {
+      "body": "string",
+      "language": "string",
+      "subject": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ NotificationEmailTemplateSpec: object + +

+
+
+
+
+
+ bccs: +
+
+ String +
+
+ +
+
+ ccs: +
+
+ String +
+
+ +
+
+ tos: +
+
+ String +
+
+ +
+
+ translations: +
+
+ NotificationEmailTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "bccs": [
+    "string"
+  ],
+  "ccs": [
+    "string"
+  ],
+  "tos": [
+    "string"
+  ],
+  "translations": [
+    {
+      "body": "string",
+      "language": "string",
+      "subject": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ NotificationEmailTemplateV2: object + +

+
+
+
+
+
+ buyer: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ seller: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyer": {
+    "bccs": [
+      "string"
+    ],
+    "ccs": [
+      "string"
+    ],
+    "tos": [
+      "string"
+    ],
+    "translations": [
+      {
+        "body": "string",
+        "language": "string",
+        "subject": "string"
+      }
+    ]
+  },
+  "isActive": "boolean",
+  "seller": {
+    "bccs": [
+      "string"
+    ],
+    "ccs": [
+      "string"
+    ],
+    "tos": [
+      "string"
+    ],
+    "translations": [
+      {
+        "body": "string",
+        "language": "string",
+        "subject": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ NotificationEmailTranslation: object + +

+
+
+
+
+
+ body: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+ subject: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "body": "string",
+  "language": "string",
+  "subject": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationEvent: object + +

+
+
+
+
+
+ type: +
+ +
+ +
+
+ version: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "type": "string",
+  "version": "number"
+}
+
+ + +
+
+
+
+
+

+ NotificationEventInput: object + +

+
+
+
+
+
+ type: +
+ +
+ +
+
+ version: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "type": "string",
+  "version": "number"
+}
+
+ + +
+
+
+
+
+

+ NotificationEventSpecs: object + +

+
+
+
+
+
+ specs: +
+
+ NotificationEventTemplateSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "displayName": "string",
+      "event": {
+        "type": "string",
+        "version": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ NotificationEventTemplateSpec: object + +

+
+
+
+
+
+ displayName: +
+
+ String +
+
+ + +
+
+ event: +
+ +
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "displayName": "string",
+  "event": {
+    "type": "string",
+    "version": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ NotificationEventType: string + +

+
+
+
+
+
+
object
+ + MEMBER_REGISTERED + + +
+
+
+
object
+ + ORDER_CREATED + + +
+
+
+
object
+ + ORDER_PAYMENT_REMINDER + + +
+
+
+
+
+
+
+
+

+ NotificationEventTypeV2: string + +

+
+
+
+
+
+
object
+ + NEW_MEMBER_REGISTERED + + +
+
+
+
object
+ + ORDER_CREATED + + +
+
+
+
object
+ + ORDER_PAYMENT_REMINDER + + +
+
+
+
object
+ + MEMBER_BIRTHDAY + + +
+
+
+
object
+ + ORDER_STATUS_CHANGED + + +
+
+
+
object
+ + PAYMENT_CONFIRMED + + +
+
+
+
object
+ + ORDER_SHIPPED + + +
+
+
+
object
+ + ORDER_EXPIRED + + +
+
+
+
object
+ + ORDER_COMPLETED + + +
+
+
+
+
+
+
+
+

+ NotificationFieldName: string + +

+
+
+
+
+
+
object
+ + eventType + + +
+
+
+
object
+ + eventVersion + + +
+
+
+
+
+
+
+
+

+ NotificationFilterInput: object + +

+
+
+
+
+
+ endCreationTimestamp: +
+
+ Int +
+
+ +
+
+ eventDisplayName: +
+
+ String +
+
+ +
+
+ sentVia: +
+
+ String +
+
+ +
+
+ startCreationTimestamp: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "endCreationTimestamp": "number",
+  "eventDisplayName": "string",
+  "sentVia": "string",
+  "startCreationTimestamp": "number"
+}
+
+ + +
+
+
+
+
+

+ NotificationHistory: object + +

+
+
+
+
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ eventDisplayName: +
+
+ String +
+
+ +
+
+ recipient: +
+
+ String +
+
+ +
+
+ toCustomer: +
+
+ Boolean +
+
+ +
+
+ sender: +
+
+ String +
+
+ +
+
+ sentVia: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "createdAt": "number",
+  "eventDisplayName": "string",
+  "recipient": "string",
+  "toCustomer": "boolean",
+  "sender": "string",
+  "sentVia": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationSMSTemplate: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ destinations: +
+
+ NotificationSmsDestination +
+
+ +
+
+ sendOrder: +
+
+ Int +
+
+ +
+
+ translations: +
+
+ NotificationSmsTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "isActive": "boolean",
+  "destinations": [
+    {
+      "phoneNumber": "string"
+    }
+  ],
+  "sendOrder": "number",
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ NotificationSMSTemplateV2: object + +

+
+
+
+
+
+ buyer: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ seller: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyer": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  },
+  "isActive": "boolean",
+  "seller": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ NotificationSmsDestination: object + +

+
+
+
+
+
+ phoneNumber: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phoneNumber": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationSmsTemplateSpec: object + +

+
+
+
+
+
+ targetPhoneNumbers: +
+
+ String +
+
+ +
+
+ translations: +
+
+ NotificationSmsTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "targetPhoneNumbers": [
+    "string"
+  ],
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ NotificationSmsTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ body: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "body": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationTemplate: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ emailTemplates: +
+
+ NotificationEmailTemplate +
+
+ +
+
+ whatsAppTemplates: +
+
+ NotificationWhatsAppTemplate +
+
+ +
+
+ SMSTemplates: +
+
+ NotificationSMSTemplate +
+
+ +
+
+ type: +
+ +
+ +
+
+ version: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "emailTemplates": [
+    {
+      "ID": "string",
+      "isActive": "boolean",
+      "destinations": [
+        {
+          "type": "string",
+          "value": "string"
+        }
+      ],
+      "sendOrder": "number",
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    }
+  ],
+  "whatsAppTemplates": [
+    {
+      "ID": "string",
+      "isActive": "boolean",
+      "destinations": [
+        {
+          "phoneNumber": "string"
+        }
+      ],
+      "sendOrder": "number",
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    }
+  ],
+  "SMSTemplates": [
+    {
+      "ID": "string",
+      "isActive": "boolean",
+      "destinations": [
+        {
+          "phoneNumber": "string"
+        }
+      ],
+      "sendOrder": "number",
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    }
+  ],
+  "type": "string",
+  "version": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ NotificationTemplateFilterInput: object + +

+
+
+
+
+
+ eventType: +
+ +
+ +
+
+ eventVersion: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "eventType": "string",
+  "eventVersion": "number"
+}
+
+ + +
+
+
+
+
+

+ NotificationTemplateSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ NotificationTemplateV2: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ emailTemplate: +
+ +
+ +
+
+ whatsAppTemplate: +
+ +
+ +
+
+ SMSTemplate: +
+ +
+ +
+
+ event: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "emailTemplate": {
+    "buyer": {
+      "bccs": [
+        "string"
+      ],
+      "ccs": [
+        "string"
+      ],
+      "tos": [
+        "string"
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "bccs": [
+        "string"
+      ],
+      "ccs": [
+        "string"
+      ],
+      "tos": [
+        "string"
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    }
+  },
+  "whatsAppTemplate": {
+    "buyer": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    }
+  },
+  "SMSTemplate": {
+    "buyer": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {}
+      ]
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ NotificationWhatsAppDestination: object + +

+
+
+
+
+
+ phoneNumber: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phoneNumber": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationWhatsAppTemplate: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ destinations: +
+
+ NotificationWhatsAppDestination +
+
+ +
+
+ sendOrder: +
+
+ Int +
+
+ +
+
+ translations: +
+
+ NotificationWhatsAppTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "isActive": "boolean",
+  "destinations": [
+    {
+      "phoneNumber": "string"
+    }
+  ],
+  "sendOrder": "number",
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ NotificationWhatsAppTemplateV2: object + +

+
+
+
+
+
+ buyer: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ seller: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyer": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  },
+  "isActive": "boolean",
+  "seller": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ NotificationWhatsAppTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ body: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "body": "string"
+}
+
+ + +
+
+
+
+
+

+ NotificationWhatsappTemplateSpec: object + +

+
+
+
+
+
+ targetPhoneNumbers: +
+
+ String +
+
+ +
+
+ translations: +
+
+ NotificationWhatsAppTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "targetPhoneNumbers": [
+    "string"
+  ],
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ OneSignal: object + +

+
+
+
+
+
+ appID: +
+
+ String +
+
+ +
+
+ appKey: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "appID": "string",
+  "appKey": "string"
+}
+
+ + +
+
+
+
+
+

+ OneSignalInput: object + +

+
+
+
+
+
+ appID: +
+
+ String +
+
+ +
+
+ appKey: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "appID": "string",
+  "appKey": "string"
+}
+
+ + +
+
+
+
+
+

+ Option: object + +

+
+
+
+
+
+ id: +
+
+ String +
+
+ + +
+
+ translations: +
+
+ TranslatableText +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ OptionInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

ID of the option.

+
+
+ translations: +
+
+ TranslatableTextInput +
+
+ +
+
+

Translations for option input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ Order: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ channelID: +
+
+ String +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ invoiceID: +
+
+ String +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+ status: +
+ +
+ +
+
+ paymentStatus: +
+
+ String +
+
+ +
+
+ memberID: +
+
+ String +
+
+ +
+
+ buyerNote: +
+
+ String +
+
+ +
+
+ billingAddress: +
+ +
+ +
+
+ deliveryAddress: +
+ +
+ +
+
+ lineItems: +
+
+ LineItem +
+
+ +
+
+ shipping: +
+ +
+ +
+
+ payment: +
+
+ Payment +
+
+ +
+
+ discount: +
+
+ Money +
+
+ +
+
+ totalCost: +
+
+ Money +
+
+ +
+
+ attributes: +
+
+ OrderAttribute +
+
+ +
+
+ logs: +
+
+ OrderLog +
+
+ +
+
+ paymentRecords: +
+
+ PaymentRecord +
+
+ +
+
+ paymentLinks: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "brandID": "object",
+  "channelID": "string",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ OrderAddress: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ phone: +
+
+ String +
+
+ +
+
+ districtCode: +
+
+ String +
+
+ +
+
+ country: +
+
+ String +
+
+ +
+
+ province: +
+
+ String +
+
+ +
+
+ city: +
+
+ String +
+
+ +
+
+ subDistrict: +
+
+ String +
+
+ +
+
+ street: +
+
+ String +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+ formattedLocation: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "email": "string",
+  "phone": "string",
+  "districtCode": "string",
+  "country": "string",
+  "province": "string",
+  "city": "string",
+  "subDistrict": "string",
+  "street": "string",
+  "postalCode": "string",
+  "formattedLocation": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderAttribute: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderAttributeInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderFilterInput: object + +

+
+
+
+
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ memberID: +
+
+ String +
+
+ +
+
+ startCreationDate: +
+
+ Int +
+
+ +
+
+ endCreationDate: +
+
+ Int +
+
+ +
+
+ shippingProviders: +
+
+ String +
+
+ +
+
+ statuses: +
+
+ String +
+
+ +
+
+ paymentStatus: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelIDs": [
+    "string"
+  ],
+  "memberID": "string",
+  "startCreationDate": "number",
+  "endCreationDate": "number",
+  "shippingProviders": [
+    "string"
+  ],
+  "statuses": [
+    "string"
+  ],
+  "paymentStatus": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ OrderIds: object + +

+
+
+
+
+
+ OrderIds: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "OrderIds": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ OrderItem: object + +

+
+
+
+
+
+ productCode: +
+
+ String +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "productCode": "string",
+  "quantity": "number"
+}
+
+ + +
+
+
+
+
+

+ OrderLineItemSpec: object + +

+
+
+
+
+
+ SKU: +
+
+ String +
+
+ + +
+
+

The line item's SKU.

+
+
+ quantity: +
+
+ Int +
+
+ + +
+
+

The quantity of the line item.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "string",
+  "quantity": "number"
+}
+
+ + +
+
+
+
+
+

+ OrderLog: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+ order: +
+
+ Order +
+
+ +
+
+ createdDate: +
+
+ Int +
+
+ +
+
+ actor: +
+
+ String +
+
+ +
+
+ action: +
+ +
+ +
+
+ newValue: +
+
+ String +
+
+ +
+
+ notes: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "order": {
+    "ID": "string",
+    "brandID": "object",
+    "channelID": "string",
+    "brand": {
+      "ID": "string",
+      "name": "string",
+      "tenantID": "string",
+      "tenant": {
+        "ID": "object",
+        "name": "string",
+        "language": "string",
+        "currencyCode": "string",
+        "brands": {
+          "items": [
+            {
+              "ID": "string",
+              "name": "string",
+              "tenantID": "string",
+              "tenant": {
+                "ID": "object",
+                "name": "string",
+                "language": "string",
+                "currencyCode": "string",
+                "brands": {
+                  "items": [
+                    {
+                      "ID": "string",
+                      "name": "string",
+                      "tenantID": "string",
+                      "tenant": {
+                        "ID": "object",
+                        "name": "string",
+                        "language": "string",
+                        "currencyCode": "string",
+                        "brands": {
+                          "items": [
+                            {
+                              "ID": "string",
+                              "name": "string",
+                              "tenantID": "string",
+                              "tenant": {
+                                "ID": "object",
+                                "name": "string",
+                                "language": "string",
+                                "currencyCode": "string",
+                                "brands": {
+                                  "items": [
+                                    {
+                                      "ID": "string"
+                                    }
+                                  ]
+                                }
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ OrderLogAction: string + +

+
+
+
+
+
+
object
+ + ACCEPTED + + +
+
+
+
object
+ + CANCELLED + + +
+
+
+
object
+ + COMPLETED + + +
+
+
+
object
+ + CREATED + + +
+
+
+
object
+ + DELETED + + +
+
+
+
object
+ + UPDATED + + +
+
+
+
object
+ + READY_TO_SHIP + + +
+
+
+
object
+ + RETURNED + + +
+
+
+
object
+ + SHIPPED + + +
+
+
+
object
+ + STATUS_UPDATED + + +
+
+
+
object
+ + SET_ATTRIBUTE + + +
+
+
+
object
+ + SET_BILLING + + +
+
+
+
object
+ + SET_DELIVERY + + +
+
+
+
object
+ + SET_LINE_ITEM + + +
+
+
+
object
+ + SET_PAYMENT + + +
+
+
+
object
+ + SET_SHIPPING + + +
+
+
+
+
+
+
+
+

+ OrderPaymentMethod: object + +

+
+
+
+
+
+ coupon: +
+
+ String +
+
+ +
+
+ method: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "coupon": "string",
+  "method": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderPaymentSpec: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+

Provider of the Payment.

+
+
+ service: +
+
+ String +
+
+ + +
+
+

Service of the Payment.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderShipping: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ +
+
+ service: +
+
+ String +
+
+ +
+
+ cost: +
+
+ Money +
+
+ +
+
+ AWBNumber: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string",
+  "cost": {
+    "code": "string",
+    "value": "number"
+  },
+  "AWBNumber": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderShippingSpec: object + +

+
+
+
+
+
+ AWBNumber: +
+
+ String +
+
+ +
+
+

Airway bill number for the shipping.

+
+
+ provider: +
+
+ String +
+
+ + +
+
+

Provider of the shipping.

+
+
+ service: +
+
+ String +
+
+ + +
+
+

Service of the shipping.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "AWBNumber": "string",
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ OrderSortFields: string + +

+
+
+
+
+
+
object
+ + ID + + +
+
+
+
object
+ + CREATED + + +
+
+
+
+
+
+
+
+

+ OrderSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ OrderSpecs: object + +

+
+
+
+
+
+ memberID: +
+
+ String +
+
+ +
+
+ invoiceID: +
+
+ String +
+
+ + +
+
+ channelID: +
+
+ String +
+
+ + +
+
+ discount: +
+ +
+ + +
+
+ totalCost: +
+ +
+ + +
+
+ buyerNote: +
+
+ String +
+
+ + +
+
+ billingAddress: +
+ +
+ +
+
+ deliveryAddress: +
+ +
+ +
+
+ lineItems: +
+
+ LineItemInput +
+
+ +
+
+ shipping: +
+ +
+ +
+
+ payment: +
+ +
+ +
+
+ attributes: +
+
+ OrderAttributeInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "memberID": "string",
+  "invoiceID": "string",
+  "channelID": "string",
+  "discount": {
+    "code": "string",
+    "value": "number"
+  },
+  "totalCost": {
+    "code": "string",
+    "value": "number"
+  },
+  "buyerNote": "string",
+  "billingAddress": {
+    "name": "string",
+    "email": "string",
+    "phone": "string",
+    "country": "string",
+    "province": "string",
+    "city": "string",
+    "subDistrict": "string",
+    "street": "string",
+    "districtCode": "string",
+    "postalCode": "string"
+  },
+  "deliveryAddress": {
+    "name": "string",
+    "email": "string",
+    "phone": "string",
+    "country": "string",
+    "province": "string",
+    "city": "string",
+    "subDistrict": "string",
+    "street": "string",
+    "districtCode": "string",
+    "postalCode": "string"
+  },
+  "lineItems": [
+    {
+      "title": "string",
+      "SKU": "string",
+      "quantity": "number",
+      "price": {
+        "code": "string",
+        "value": "number"
+      },
+      "imageURL": "string"
+    }
+  ],
+  "shipping": {
+    "provider": "string",
+    "service": "string",
+    "cost": {
+      "code": "string",
+      "value": "number"
+    },
+    "AWBNumber": "string"
+  },
+  "payment": {
+    "provider": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ OrderStatus: string + +

+
+
+
+
+
+
object
+ + CREATED + + +
+
+
+
object
+ + ACCEPTED + + +
+
+
+
object
+ + CANCELLED + + +
+
+
+
object
+ + COMPLETED + + +
+
+
+
object
+ + READY_TO_SHIP + + +
+
+
+
object
+ + RETURNED + + +
+
+
+
object
+ + SHIPPED + + +
+
+
+
+
+
+
+
+

+ Page: object + +

+
+
+
+
+
+ pageNumber: +
+
+ Int +
+
+ + +
+
+ itemPerPage: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "pageNumber": "number",
+  "itemPerPage": "number"
+}
+
+ + +
+
+
+
+
+

+ PageInfo: object + +

+
+
+
+
+
+ totalItems: +
+
+ Int +
+
+ +
+
+ itemPerPage: +
+
+ Int +
+
+ +
+
+ pageNumber: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "totalItems": "number",
+  "itemPerPage": "number",
+  "pageNumber": "number"
+}
+
+ + +
+
+
+
+
+

+ PageInput: object + +

+
+
+
+
+
+ pageNumber: +
+
+ Int +
+
+ + +
+
+ itemPerPage: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "pageNumber": "number",
+  "itemPerPage": "number"
+}
+
+ + +
+
+
+
+
+

+ PagedAdminProfile: object + +

+
+
+
+
+
+ items: +
+
+ AdminProfile +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "firstName": "string",
+      "lastName": "string",
+      "email": "string",
+      "phone": "string",
+      "passwordIsSet": "boolean",
+      "permission": {
+        "actions": [
+          "string"
+        ],
+        "administeredBrandIDs": [
+          "string"
+        ],
+        "allAction": "boolean"
+      },
+      "apiKey": {
+        "clientId": "string",
+        "clientSecret": "string"
+      },
+      "lastLogin": "number",
+      "role": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedArticle: object + +

+
+
+
+
+
+ items: +
+
+ Article +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "articleID": "string",
+      "categoryID": "string",
+      "category": {
+        "categoryID": "string",
+        "imageURL": "string",
+        "translations": [
+          {
+            "language": "string",
+            "name": "string"
+          }
+        ],
+        "SEOs": [
+          {
+            "language": "string",
+            "title": "string",
+            "description": "string",
+            "keywords": [
+              "string"
+            ]
+          }
+        ],
+        "isActive": "boolean",
+        "displayType": "string",
+        "slug": "string"
+      },
+      "slug": "string",
+      "descriptions": [
+        {
+          "language": "string",
+          "title": "string",
+          "content": "string"
+        }
+      ],
+      "SEOs": [
+        {
+          "language": "string",
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ]
+        }
+      ],
+      "isActive": "boolean"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedArticleCategory: object + +

+
+
+
+
+
+ items: +
+
+ ArticleCategory +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "categoryID": "string",
+      "imageURL": "string",
+      "translations": [
+        {
+          "language": "string",
+          "name": "string"
+        }
+      ],
+      "SEOs": [
+        {
+          "language": "string",
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ]
+        }
+      ],
+      "isActive": "boolean",
+      "displayType": "string",
+      "slug": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedBanner: object + +

+
+
+
+
+
+ items: +
+
+ Banner +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "imageURL": "string",
+      "targetURL": "string",
+      "translations": [
+        {
+          "language": "string",
+          "title": "string",
+          "description": "string"
+        }
+      ],
+      "activeStartTime": "number",
+      "activeEndTime": "number",
+      "published": "boolean",
+      "ordering": "number"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedBestSellingProduct: object + +

+
+
+
+
+
+ items: +
+
+ BestSellingProduct +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "brandID": "string",
+      "orderCount": "number",
+      "productName": "string",
+      "productSKU": "string",
+      "revenue": {
+        "code": "string",
+        "value": "number"
+      },
+      "soldQuantity": "number"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedBillingTenant: object + +

+
+
+
+
+
+ items: +
+
+ BillingTenant +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "name": "string",
+      "email": "string",
+      "phone": "string",
+      "balance": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedBrand: object + +

+
+
+
+
+
+ items: +
+
+ Brand +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "name": "string",
+      "tenantID": "string",
+      "tenant": {
+        "ID": "object",
+        "name": "string",
+        "language": "string",
+        "currencyCode": "string",
+        "brands": {
+          "items": [
+            {
+              "ID": "string",
+              "name": "string",
+              "tenantID": "string",
+              "tenant": {
+                "ID": "object",
+                "name": "string",
+                "language": "string",
+                "currencyCode": "string",
+                "brands": {
+                  "items": [
+                    {
+                      "ID": "string",
+                      "name": "string",
+                      "tenantID": "string",
+                      "tenant": {
+                        "ID": "object",
+                        "name": "string",
+                        "language": "string",
+                        "currencyCode": "string",
+                        "brands": {
+                          "items": [
+                            {
+                              "ID": "string",
+                              "name": "string",
+                              "tenantID": "string",
+                              "tenant": {
+                                "ID": "object",
+                                "name": "string",
+                                "language": "string",
+                                "currencyCode": "string",
+                                "brands": {
+                                  "items": [
+                                    {
+                                      "ID": "string",
+                                      "name": "string",
+                                      "tenantID": "string",
+                                      "tenant": {
+                                        "ID": "object",
+                                        "name": "string"
+                                      }
+                                    }
+                                  ]
+                                }
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedBundle: object + +

+
+
+
+
+
+ items: +
object[]
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    null
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedCollection: object + +

+
+
+
+
+
+ items: +
+
+ Collection +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "slug": "string",
+      "details": [
+        {
+          "name": "string",
+          "description": "string",
+          "language": "string"
+        }
+      ],
+      "imageURLs": [
+        "string"
+      ],
+      "published": "boolean",
+      "channelIDs": [
+        "object"
+      ],
+      "SEOs": [
+        {
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ],
+          "language": "string"
+        }
+      ],
+      "attributes": [
+        {
+          "key": "string",
+          "value": "string"
+        }
+      ],
+      "parentIDs": [
+        "object"
+      ],
+      "aggregate": {
+        "totalPublishedProduct": "number"
+      }
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedCoupon: object + +

+
+
+
+
+
+ items: +
object[]
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    null
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedDiscount: object + +

+
+
+
+
+
+ items: +
+
+ Discount +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "brandID": "string",
+      "discountID": "object",
+      "channelIDs": [
+        "string"
+      ],
+      "discountSpec": {
+        "startDate": "number",
+        "endDate": "number",
+        "isActive": "boolean",
+        "referenceType": "string",
+        "maxItem": "number",
+        "rows": [
+          {
+            "referenceID": "object",
+            "discountType": "string",
+            "moneyValue": {
+              "code": "string",
+              "value": "number"
+            },
+            "scalarValue": "number"
+          }
+        ]
+      },
+      "title": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedDocument: object + +

+
+
+
+
+
+ items: +
+
+ Document +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "name": "string",
+      "signerID": "string",
+      "status": "string",
+      "token": "string",
+      "URL": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedExchangePointSetting: object + +

+
+
+
+
+
+ items: +
+
+ ExchangePointSetting +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {
+                                  "ID": "object",
+                                  "name": "string",
+                                  "language": "string",
+                                  "currencyCode": "string",
+                                  "brands": {
+                                    "items": [
+                                      {
+                                        "ID": "string",
+                                        "name": "string",
+                                        "tenantID": "string"
+                                      }
+                                    ]
+                                  }
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedEximHistory: object + +

+
+
+
+
+
+ items: +
+
+ EximHistory +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "brandID": "string",
+      "jobID": "string",
+      "fileName": "string",
+      "fileURL": "string",
+      "email": "string",
+      "channel": "string",
+      "percentProgress": "number",
+      "recordCount": "number",
+      "uploadedAt": "number"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedLookbook: object + +

+
+
+
+
+
+ items: +
+
+ Lookbook +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "brandID": "string",
+      "imageURL": "string",
+      "name": "string",
+      "images": [
+        {
+          "title": "string",
+          "language": "string",
+          "imageURL": "string"
+        }
+      ],
+      "isActive": "boolean",
+      "slug": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedMarketingTenant: object + +

+
+
+
+
+
+ items: +
+
+ MarketingTenant +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "dateCreated": "string",
+      "salutation": "string",
+      "firstName": "string",
+      "dateOfBirth": "string",
+      "email": "string",
+      "alternatifEmail": "string",
+      "phoneNumber": "string",
+      "alternatifPhoneNumber": "string",
+      "addressLine": "string",
+      "postalCode": "string",
+      "state": "string",
+      "country": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedMember: object + +

+
+
+
+
+
+ items: +
+
+ Member +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "accountID": "string",
+      "ID": "string",
+      "addresses": [
+        {
+          "addressLabel": "string",
+          "contactName": "string",
+          "districtCode": "string",
+          "location": "string",
+          "street": "string",
+          "latitude": "string",
+          "longitude": "string",
+          "postalCode": "string",
+          "isPrimary": "boolean",
+          "salesChannel": "string"
+        }
+      ],
+      "email": "string",
+      "firstName": "string",
+      "lastName": "string",
+      "gender": "string",
+      "phone": "string",
+      "dateOfBirth": "number",
+      "createdAt": "number",
+      "updatedAt": "number",
+      "level": "string",
+      "loyaltyPoint": {
+        "amount": "number",
+        "history": [
+          {
+            "delta": "number",
+            "happenedAt": "number",
+            "info": "string"
+          }
+        ]
+      },
+      "membership": {
+        "point": "number",
+        "history": [
+          {
+            "delta": "number",
+            "happenedAt": "number",
+            "info": "string"
+          }
+        ]
+      },
+      "haveAccessTo": "boolean",
+      "haveAccessToWithReason": {
+        "allowed": "boolean",
+        "reason": "string"
+      },
+      "orders": {
+        "items": [
+          {
+            "ID": "string",
+            "brandID": "object",
+            "channelID": "string",
+            "brand": {
+              "ID": "string",
+              "name": "string"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedMonthlySales: object + +

+
+
+
+
+
+ items: +
+
+ MonthlySales +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "brandID": "string",
+      "orderCount": "number",
+      "productSales": [
+        {
+          "orderCount": "number",
+          "productName": "string",
+          "productSKU": "string",
+          "soldQuantity": "number",
+          "totalNetRevenue": {
+            "code": "string",
+            "value": "number"
+          }
+        }
+      ],
+      "soldQuantity": "number",
+      "totalDiscount": {
+        "code": "string",
+        "value": "number"
+      },
+      "totalNetRevenue": {
+        "code": "string",
+        "value": "number"
+      },
+      "totalOrderAmount": {
+        "code": "string",
+        "value": "number"
+      },
+      "totalShippingFee": {
+        "code": "string",
+        "value": "number"
+      },
+      "yearMonth": "number"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedNavigation: object + +

+
+
+
+
+
+ items: +
+
+ Navigation +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "brandID": "object",
+      "ID": "object",
+      "parentIDs": [
+        "string"
+      ],
+      "URL": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ],
+      "published": "boolean",
+      "ordering": "number",
+      "type": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedNewsletter: object + +

+
+
+
+
+
+ items: +
+
+ NewsletterSubscriber +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "brandID": "string",
+      "email": "string",
+      "createdAt": "number"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedNotificationHistory: object + +

+
+
+
+
+
+ items: +
+
+ NotificationHistory +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "createdAt": "number",
+      "eventDisplayName": "string",
+      "recipient": "string",
+      "toCustomer": "boolean",
+      "sender": "string",
+      "sentVia": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedNotificationTemplate: object + +

+
+
+
+
+
+ items: +
+
+ NotificationTemplate +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "emailTemplates": [
+        {
+          "ID": "string",
+          "isActive": "boolean",
+          "destinations": [
+            {
+              "type": "string",
+              "value": "string"
+            }
+          ],
+          "sendOrder": "number",
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        }
+      ],
+      "whatsAppTemplates": [
+        {
+          "ID": "string",
+          "isActive": "boolean",
+          "destinations": [
+            {
+              "phoneNumber": "string"
+            }
+          ],
+          "sendOrder": "number",
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        }
+      ],
+      "SMSTemplates": [
+        {
+          "ID": "string",
+          "isActive": "boolean",
+          "destinations": [
+            {
+              "phoneNumber": "string"
+            }
+          ],
+          "sendOrder": "number",
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        }
+      ],
+      "type": "string",
+      "version": "string",
+      "isActive": "boolean"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedNotificationTemplateV2: object + +

+
+
+
+
+
+ items: +
+
+ NotificationTemplateV2 +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "emailTemplate": {
+        "buyer": {
+          "bccs": [
+            "string"
+          ],
+          "ccs": [
+            "string"
+          ],
+          "tos": [
+            "string"
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "bccs": [
+            "string"
+          ],
+          "ccs": [
+            "string"
+          ],
+          "tos": [
+            "string"
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        }
+      },
+      "whatsAppTemplate": {
+        "buyer": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        }
+      },
+      "SMSTemplate": {
+        "buyer": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            null
+          ]
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedOrder: object + +

+
+
+
+
+
+ items: +
+
+ Order +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "brandID": "object",
+      "channelID": "string",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {
+                                  "ID": "object",
+                                  "name": "string",
+                                  "language": "string",
+                                  "currencyCode": "string",
+                                  "brands": {
+                                    "items": [
+                                      {
+                                        "ID": "string",
+                                        "name": "string"
+                                      }
+                                    ]
+                                  }
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedProduct: object + +

+
+
+
+
+
+ items: +
+
+ Product +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+ appliedInput: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {
+                                  "ID": "object",
+                                  "name": "string",
+                                  "language": "string",
+                                  "currencyCode": "string",
+                                  "brands": {
+                                    "items": [
+                                      {
+                                        "ID": "string",
+                                        "name": "string",
+                                        "tenantID": "string"
+                                      }
+                                    ]
+                                  }
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedProductReview: object + +

+
+
+
+
+
+ items: +
+
+ ProductReview +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+ appliedFilter: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "orderID": "object",
+      "orderCompletedAt": "number",
+      "productID": "object",
+      "product": {
+        "ID": "object",
+        "brandID": "object",
+        "brand": {
+          "ID": "string",
+          "name": "string",
+          "tenantID": "string",
+          "tenant": {
+            "ID": "object",
+            "name": "string",
+            "language": "string",
+            "currencyCode": "string",
+            "brands": {
+              "items": [
+                {
+                  "ID": "string",
+                  "name": "string",
+                  "tenantID": "string",
+                  "tenant": {
+                    "ID": "object",
+                    "name": "string",
+                    "language": "string",
+                    "currencyCode": "string",
+                    "brands": {
+                      "items": [
+                        {
+                          "ID": "string",
+                          "name": "string",
+                          "tenantID": "string",
+                          "tenant": {
+                            "ID": "object",
+                            "name": "string",
+                            "language": "string",
+                            "currencyCode": "string",
+                            "brands": {
+                              "items": [
+                                {
+                                  "ID": "string",
+                                  "name": "string",
+                                  "tenantID": "string",
+                                  "tenant": {
+                                    "ID": "object",
+                                    "name": "string",
+                                    "language": "string"
+                                  }
+                                }
+                              ]
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedPromotion: object + +

+
+
+
+
+
+ items: +
+
+ Promotion +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "channelIDs": [
+        "string"
+      ],
+      "startDate": "number",
+      "endDate": "number",
+      "name": "string",
+      "type": "string"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedSalesByMember: object + +

+
+
+
+
+
+ items: +
+
+ SalesByMember +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "brandID": "string",
+      "email": "string",
+      "memberID": "string",
+      "orderCount": "number",
+      "orderDate": "number",
+      "totalDiscount": {
+        "code": "string",
+        "value": "number"
+      },
+      "totalOrderAmount": {
+        "code": "string",
+        "value": "number"
+      },
+      "totalShippingFee": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedSalesChannel: object + +

+
+
+
+
+
+ items: +
+
+ SalesChannel +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "code": "string",
+      "channelAttributes": [
+        {
+          "key": "string",
+          "value": "string"
+        }
+      ]
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedShipping: object + +

+
+
+
+
+
+ items: +
+
+ Shipping +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "brandID": "object",
+      "ID": "object",
+      "provider": "string",
+      "services": [
+        {
+          "name": "string",
+          "isActive": "boolean",
+          "isAutoAWB": "boolean",
+          "useInsurance": "boolean"
+        }
+      ],
+      "isActive": "boolean",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {
+                                  "ID": "object",
+                                  "name": "string"
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PagedTestimonial: object + +

+
+
+
+
+
+ items: +
+
+ Testimonial +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "string",
+      "brandID": "string",
+      "email": "string",
+      "author": "string",
+      "company": "string",
+      "website": "string",
+      "memberID": "string",
+      "productID": "string",
+      "title": "string",
+      "content": "string",
+      "imageURLs": [
+        "string"
+      ],
+      "rating": "number",
+      "createdAt": "number",
+      "updatedAt": "number",
+      "published": "boolean",
+      "isFeatured": "boolean"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedWarehouse: object + +

+
+
+
+
+
+ items: +
+
+ Warehouse +
+
+ +
+
+ page: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "warehouseID": "object",
+      "tenantID": "object",
+      "ID": "object",
+      "address": {
+        "phones": [
+          "string"
+        ],
+        "emails": [
+          "string"
+        ],
+        "districtCode": "string",
+        "street": "string",
+        "latitude": "number",
+        "longitude": "number",
+        "postalCode": "string",
+        "formattedAddress": "string"
+      },
+      "isDefault": "boolean"
+    }
+  ],
+  "page": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PagedWidget: object + +

+
+
+
+
+
+ items: +
+
+ Widget +
+
+ +
+
+ pageInfo: +
+
+ PageInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "items": [
+    {
+      "ID": "object",
+      "name": "string",
+      "region": "string",
+      "order": "number",
+      "content": "string",
+      "published": "boolean"
+    }
+  ],
+  "pageInfo": {
+    "totalItems": "number",
+    "itemPerPage": "number",
+    "pageNumber": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ Payment: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ +
+
+ service: +
+
+ String +
+
+ +
+
+ fee: +
+
+ Money +
+
+ +
+
+ uniqueCode: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string",
+  "fee": {
+    "code": "string",
+    "value": "number"
+  },
+  "uniqueCode": "number"
+}
+
+ + +
+
+
+
+
+

+ PaymentAdminConfig: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ providerID: +
+
+ String +
+
+ + +
+
+ method: +
+
+ String +
+
+ + +
+
+ configs: +
+
+ PaymentConfig +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "providerID": "string",
+  "method": "string",
+  "configs": [
+    {
+      "name": "string",
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentAdminConfigInput: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+

The ID of an existing admin configuration to be updated/inserted.

+
+
+ providerID: +
+
+ String +
+
+ + +
+
+

The payment provider ID.

+
+
+ method: +
+
+ String +
+
+ + +
+
+

The payment method.

+
+
+ configs: +
+
+ Configs +
+
+ +
+
+

Configurations for the admin.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "providerID": "string",
+  "method": "string",
+  "configs": [
+    {
+      "name": "string",
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentAvailabilitySpec: object + +

+
+
+
+
+
+ providerID: +
+
+ String +
+
+ + +
+
+

ID of the payment provider..

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "providerID": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ PaymentConditionalShowSpec: object + +

+
+
+
+
+
+ formFieldName: +
+
+ String +
+
+ + +
+
+ condition: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "formFieldName": "string",
+  "condition": "string"
+}
+
+ + +
+
+
+
+
+

+ PaymentConfig: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ PaymentConfirmationUpsertInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of an existing payment confirmation to be updated/inserted.

+
+
+ transactionDate: +
+
+ Int +
+
+ + +
+
+

The date of the transaction.

+
+
+ senderName: +
+
+ String +
+
+ + +
+
+

The name of the sender.

+
+
+ amount: +
+
+ String +
+
+ + +
+
+

Payment amount.

+
+
+ recipientBankName: +
+
+ String +
+
+ + +
+
+

The recipient's bank name.

+
+
+ senderEmail: +
+
+ String +
+
+ + +
+
+

Sender's email.

+
+
+ attachment: +
+
+ String +
+
+ + +
+
+

Payment confirmation attachment.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "transactionDate": "number",
+  "senderName": "string",
+  "amount": "string",
+  "recipientBankName": "string",
+  "senderEmail": "string",
+  "attachment": "string"
+}
+
+ + +
+
+
+
+
+

+ PaymentFee: object + +

+
+
+
+
+
+ percentage: +
+
+ Float +
+
+ +
+
+ scalar: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "percentage": "number",
+  "scalar": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ PaymentField: object + +

+
+
+
+
+
+ label: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ + +
+
+ type: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ isRequired: +
+
+ Boolean +
+
+ +
+
+ options: +
+
+ String +
+
+ +
+
+ conditionalShows: +
+
+ PaymentConditionalShowSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "label": "string",
+  "name": "string",
+  "type": "string",
+  "description": "string",
+  "isRequired": "boolean",
+  "options": [
+    "string"
+  ],
+  "conditionalShows": [
+    {
+      "formFieldName": "string",
+      "condition": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentGateway: object + +

+
+
+
+
+
+ paymentProvider: +
object
+ +
+
+ paymentAdminConfig: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "paymentAdminConfig": {
+    "ID": "string",
+    "providerID": "string",
+    "method": "string",
+    "configs": [
+      {
+        "name": "string",
+        "value": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ PaymentInput: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+ service: +
+
+ String +
+
+ + +
+
+ fee: +
+ +
+ + +
+
+ uniqueCode: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string",
+  "fee": {
+    "code": "string",
+    "value": "number"
+  },
+  "uniqueCode": "number"
+}
+
+ + +
+
+
+
+ +
+

+ PaymentMethod: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ merchantID: +
+
+ String +
+
+ +
+
+ clientKey: +
+
+ String +
+
+ +
+
+ serverKey: +
+
+ String +
+
+ +
+
+ acquiringBank: +
+
+ String +
+
+ +
+
+ payPalAccount: +
+
+ String +
+
+ +
+
+ specs: +
+
+ PaymentSpec +
+
+ +
+
+

Specifications for a payment method.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "merchantID": "string",
+  "clientKey": "string",
+  "serverKey": "string",
+  "acquiringBank": "string",
+  "payPalAccount": "string",
+  "specs": [
+    {
+      "method": "string",
+      "isActive": "boolean",
+      "chargeFeeToCustomer": "boolean",
+      "expiryHour": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentMethodInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the payment method.

+
+
+ merchantID: +
+
+ String +
+
+ +
+
+

Merchant ID of the payment method.

+
+
+ clientKey: +
+
+ String +
+
+ +
+
+

Client key of the payment method.

+
+
+ serverKey: +
+
+ String +
+
+ +
+
+

Server key of the payment method.

+
+
+ acquiringBank: +
+
+ String +
+
+ +
+
+

Acquiring bank of the payment method.

+
+
+ payPalAccount: +
+
+ String +
+
+ +
+
+

Paypal account of the payment method.

+
+
+ specs: +
+
+ PaymentSpecInput +
+
+ +
+
+

Specifications for payment method.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "merchantID": "string",
+  "clientKey": "string",
+  "serverKey": "string",
+  "acquiringBank": "string",
+  "payPalAccount": "string",
+  "specs": [
+    {
+      "method": "string",
+      "isActive": "boolean",
+      "chargeFeeToCustomer": "boolean",
+      "expiryHour": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentMethods: object + +

+
+
+
+
+
+ paymentMethods: +
+
+ PaymentMethod +
+
+ +
+
+

Collection of payment methods for payment methods.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "paymentMethods": [
+    {
+      "name": "string",
+      "merchantID": "string",
+      "clientKey": "string",
+      "serverKey": "string",
+      "acquiringBank": "string",
+      "payPalAccount": "string",
+      "specs": [
+        {
+          "method": "string",
+          "isActive": "boolean",
+          "chargeFeeToCustomer": "boolean",
+          "expiryHour": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentMethodsInput: object + +

+
+
+
+
+
+ paymentMethods: +
+
+ PaymentMethodInput +
+
+ +
+
+

A list of payment methods.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "paymentMethods": [
+    {
+      "name": "string",
+      "merchantID": "string",
+      "clientKey": "string",
+      "serverKey": "string",
+      "acquiringBank": "string",
+      "payPalAccount": "string",
+      "specs": [
+        {
+          "method": "string",
+          "isActive": "boolean",
+          "chargeFeeToCustomer": "boolean",
+          "expiryHour": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentProviderMethodSpec: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+

The ID of the payment provider method.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the payment provider method is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ PaymentRecord: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ orderID: +
+
+ String +
+
+ +
+
+ provider: +
+
+ String +
+
+ +
+
+ method: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+ info: +
+
+ PaymentRecordInfo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "orderID": "string",
+  "provider": "string",
+  "method": "string",
+  "status": "string",
+  "info": [
+    {
+      "amount": "string",
+      "attachment": "string",
+      "orderID": "string",
+      "recipientBankName": "string",
+      "senderEmail": "string",
+      "senderName": "string",
+      "transactionDate": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PaymentRecordInfo: object + +

+
+
+
+
+
+ amount: +
+
+ String +
+
+ +
+
+ attachment: +
+
+ String +
+
+ +
+
+ orderID: +
+
+ String +
+
+ +
+
+ recipientBankName: +
+
+ String +
+
+ +
+
+ senderEmail: +
+
+ String +
+
+ +
+
+ senderName: +
+
+ String +
+
+ +
+
+ transactionDate: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "amount": "string",
+  "attachment": "string",
+  "orderID": "string",
+  "recipientBankName": "string",
+  "senderEmail": "string",
+  "senderName": "string",
+  "transactionDate": "number"
+}
+
+ + +
+
+
+
+
+

+ PaymentSpec: object + +

+
+
+
+
+
+ method: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ chargeFeeToCustomer: +
+
+ Boolean +
+
+ +
+
+ expiryHour: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "method": "string",
+  "isActive": "boolean",
+  "chargeFeeToCustomer": "boolean",
+  "expiryHour": "number"
+}
+
+ + +
+
+
+
+
+

+ PaymentSpecInput: object + +

+
+
+
+
+
+ method: +
+
+ String +
+
+ + +
+
+

The payment's method.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this payment is active or not.

+
+
+ chargeFeeToCustomer: +
+
+ Boolean +
+
+ + +
+
+

A flag to charge fee to customer or not.

+
+
+ expiryHour: +
+
+ Int +
+
+ + +
+
+

A number representing when this payment is expired.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "method": "string",
+  "isActive": "boolean",
+  "chargeFeeToCustomer": "boolean",
+  "expiryHour": "number"
+}
+
+ + +
+
+
+
+
+

+ PlaceOrder: object + +

+
+
+
+
+
+ email: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ + +
+
+ mobilePhone: +
+
+ Int +
+
+ + +
+
+ address: +
+
+ String +
+
+ + +
+
+ city: +
+
+ String +
+
+ + +
+
+ postalCode: +
+
+ Int +
+
+ + +
+
+ selectedShippingMethod: +
+
+ String +
+
+ + +
+
+ selectedPaymentMethod: +
+
+ String +
+
+ + +
+
+ couponCode: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "email": "string",
+  "name": "string",
+  "mobilePhone": "number",
+  "address": "string",
+  "city": "string",
+  "postalCode": "number",
+  "selectedShippingMethod": "string",
+  "selectedPaymentMethod": "string",
+  "couponCode": "string"
+}
+
+ + +
+
+
+
+
+

+ PlaceOrderAddressInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+ email: +
+
+ String +
+
+ + +
+
+ phone: +
+
+ String +
+
+ + +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ street: +
+
+ String +
+
+ + +
+
+ postalCode: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "email": "string",
+  "phone": "string",
+  "districtCode": "string",
+  "street": "string",
+  "postalCode": "string"
+}
+
+ + +
+
+
+
+
+

+ PlaceOrderInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+ buyerNote: +
+
+ String +
+
+ +
+
+ cartID: +
+
+ ID +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "buyerNote": "string",
+  "cartID": "object"
+}
+
+ + +
+
+
+
+
+

+ PlaceOrderLineItemInput: object + +

+
+
+
+
+
+ SKU: +
+
+ String +
+
+ + +
+
+ quantity: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "string",
+  "quantity": "number"
+}
+
+ + +
+
+
+
+
+

+ PlaceOrderPaymentInput: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+ service: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ PlaceOrderShippingInput: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+ service: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ PlanAction: object + +

+
+
+
+
+
+ planID: +
+
+ String +
+
+ +
+
+ action: +
+
+ String +
+
+ +
+
+ parameters: +
object[]
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "planID": "string",
+  "action": "string",
+  "parameters": [
+    null
+  ]
+}
+
+ + +
+
+
+
+
+

+ Product: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ relatedProductIDs: +
+
+ ID +
+
+ +
+
+ slug: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ details: +
+
+ ProductDetail +
+
+ +
+
+ condition: +
+
+ String +
+
+ +
+
+ volume: +
+ +
+ +
+
+ weight: +
+ +
+ +
+
+ SEOs: +
+
+ ProductSEO +
+
+ +
+
+ attributes: +
+
+ ProductAttribute +
+
+ +
+
+ channelAttributes: +
+
+ ProductChannelAttribute +
+
+ +
+
+ relatedProducts: +
+
+ Product +
+
+ +
+
+ tagKeys: +
+
+ ID +
+
+ +
+
+ collectionIDs: +
+
+ ID +
+
+ +
+
+ stocks: +
+
+ ProductStock +
+
+ +
+
+ variants: +
+
+ ProductVariant +
+
+ +
+
+ legacyVariants: +
+
+ ProductVariant +
+
+ +
+
+ channels: +
+
+ Sales +
+
+ +
+
+ promotions: +
+
+ ProductPromotion +
+
+ +
+
+ collections: +
+
+ Collection +
+
+ +
+
+ schedulePublishAt: +
+
+ Int +
+
+ +
+
+ scheduleOpenOrderAt: +
+
+ Int +
+
+ +
+
+ scheduleCloseOrderAt: +
+
+ Int +
+
+ +
+
+ extension: +
+ +
+ +
+
+ site: +
+
+ Site +
+
+ +
+
+ syncStatus: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string",
+                                    "tenant": {}
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductAttribute: object + +

+
+
+
+
+
+ sortIndex: +
+
+ Int +
+
+ +
+
+ translations: +
+
+ ProductAttributeTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sortIndex": "number",
+  "translations": [
+    {
+      "key": "string",
+      "value": "string",
+      "language": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductAttributeTranslation: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductChannelAttribute: object + +

+
+
+
+
+
+ channelID: +
+
+ ID +
+
+ +
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "object",
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductChannelAttributeInput: object + +

+
+
+
+
+
+ channelID: +
+
+ String +
+
+ + +
+
+

ID of this product's channel.

+
+
+ key: +
+
+ String +
+
+ + +
+
+

Key of this product channel attribute.

+
+
+ value: +
+
+ String +
+
+ + +
+
+

Value of this product channel attribute.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "string",
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductConditionEnum: string + +

+
+
+
+
+
+
object
+ + NEW + + +
+
+
+
object
+ + USED + + +
+
+
+
+
+
+
+
+

+ ProductCoupon: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ couponID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ code: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ isValid: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ couponType: +
+ +
+ + +
+
+ maximumUsageCount: +
+
+ Int +
+
+ +
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ +
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ +
+
+ discountValue: +
+ +
+ +
+
+ usages: +
+
+ Usage +
+
+ +
+
+ applicableSKUs: +
+
+ String +
+
+ +
+
+ isMemberOnly: +
+
+ Boolean +
+
+ +
+
+ allowedMemberLevels: +
+
+ String +
+
+ +
+
+ minimumPurchase: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "couponID": "string",
+  "brandID": "string",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilter: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+

Filter name.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

Whether filter is currently active.

+
+
+ type: +
+ +
+ + +
+
+

Type of filter.

+
+
+ variantSpecs: +
+
+ ProductCustomFilterVariant +
+
+ +
+
+

Filter variant specs.

+
+
+ tagSpec: +
+ +
+ +
+
+

Filter tag spec.

+
+
+ priceSpec: +
+ +
+ +
+
+

Filter price spec.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "isActive": "boolean",
+  "type": "string",
+  "variantSpecs": [
+    {
+      "key": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ],
+      "options": [
+        {
+          "attributes": [
+            {
+              "key": "string",
+              "value": "string"
+            }
+          ],
+          "isActive": "boolean",
+          "translations": [
+            {
+              "language": "string",
+              "text": "string"
+            }
+          ],
+          "value": "string"
+        }
+      ]
+    }
+  ],
+  "tagSpec": {
+    "options": [
+      {
+        "key": "string",
+        "translations": [
+          {
+            "language": "string",
+            "text": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "priceSpec": {
+    "options": [
+      {
+        "min": "number",
+        "max": "number"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+

Filter name.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

Whether filter is currently active.

+
+
+ type: +
+ +
+ + +
+
+

Type of filter.

+
+
+ variantSpecs: +
+
+ ProductCustomFilterVariantInput +
+
+ +
+
+

Filter variant specs. Required if type is VARIANT.

+
+
+ tagSpec: +
+ +
+ +
+
+

Filter tag spec. Required if type is TAG.

+
+
+ priceSpec: +
+ +
+ +
+
+

Filter price spec. Required if type is PRICE.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "isActive": "boolean",
+  "type": "string",
+  "variantSpecs": [
+    {
+      "key": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ],
+      "options": [
+        {
+          "value": "string",
+          "translations": [
+            {
+              "language": "string",
+              "text": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "tagSpec": {
+    "options": [
+      {
+        "key": "string",
+        "translations": [
+          {
+            "language": "string",
+            "text": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "priceSpec": {
+    "options": [
+      {
+        "min": "number",
+        "max": "number"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterPrice: object + +

+
+
+
+
+
+ options: +
+
+ ProductCustomFilterPriceOption +
+
+ +
+
+

Price filter options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "options": [
+    {
+      "min": "number",
+      "max": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterPriceInput: object + +

+
+
+
+
+
+ options: +
+
+ ProductCustomFilterPriceOptionInput +
+
+ +
+
+

Price filter options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "options": [
+    {
+      "min": "number",
+      "max": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterPriceOption: object + +

+
+
+
+
+
+ min: +
+
+ Float +
+
+ + +
+
+

Lower bound.

+
+
+ max: +
+
+ Float +
+
+ + +
+
+

Upper bound.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "min": "number",
+  "max": "number"
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterPriceOptionInput: object + +

+
+
+
+
+
+ min: +
+
+ Float +
+
+ + +
+
+

Lower bound.

+
+
+ max: +
+
+ Float +
+
+ + +
+
+

Upper bound.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "min": "number",
+  "max": "number"
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterTag: object + +

+
+
+
+
+
+ options: +
+
+ ProductCustomFilterTagOption +
+
+ +
+
+

Tag filter options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "options": [
+    {
+      "key": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterTagInput: object + +

+
+
+
+
+
+ options: +
+
+ ProductCustomFilterTagOptionInput +
+
+ +
+
+

Tag filter options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "options": [
+    {
+      "key": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterTagOption: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+

Tag key.

+
+
+ translations: +
+
+ ProductOptionTranslation +
+
+ +
+
+

Tag filter option translations.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterTagOptionInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+

Tag key.

+
+
+ translations: +
+
+ ProductOptionTranslationInput +
+
+ +
+
+

Tag filter option translations.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterType: string + +

+
+
+
+
+
+
object
+ + PRICE + + +
+
+
+
object
+ + TAG + + +
+
+
+
object
+ + VARIANT + + +
+
+
+
+
+
+
+
+

+ ProductCustomFilterVariant: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+

Variant option key.

+
+
+ translations: +
+
+ ProductOptionTranslation +
+
+ +
+
+

Variant filter translations.

+
+
+ options: +
+
+ ProductCustomFilterVariantOption +
+
+ +
+
+

Variant filter options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "options": [
+    {
+      "attributes": [
+        {
+          "key": "string",
+          "value": "string"
+        }
+      ],
+      "isActive": "boolean",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ],
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterVariantInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+

Variant option key.

+
+
+ translations: +
+
+ ProductOptionTranslationInput +
+
+ +
+
+

Variant filter translations.

+
+
+ options: +
+
+ ProductCustomFilterVariantOptionInput +
+
+ +
+
+

Variant filter options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "options": [
+    {
+      "value": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterVariantOption: object + +

+
+
+
+
+
+ attributes: +
+
+ ProductOptionValueAttribute +
+
+ +
+
+

Variant option attributes.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

Whether option is active.

+
+
+ translations: +
+
+ ProductOptionTranslation +
+
+ +
+
+

Variant filter option translations.

+
+
+ value: +
+
+ String +
+
+ + +
+
+

Variant option value.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "isActive": "boolean",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductCustomFilterVariantOptionInput: object + +

+
+
+
+
+
+ value: +
+
+ String +
+
+ + +
+
+

Variant option value.

+
+
+ translations: +
+
+ ProductOptionTranslationInput +
+
+ +
+
+

Variant filter option translations.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "value": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductCustomSort: object + +

+
+
+
+
+
+ aToZAscending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product name ascending.

+
+
+ aToZDescending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product name descending.

+
+
+ priceAscending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product price ascending.

+
+
+ priceDescending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product price descending.

+
+
+ createdAtDescending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by newest product.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "aToZAscending": "boolean",
+  "aToZDescending": "boolean",
+  "priceAscending": "boolean",
+  "priceDescending": "boolean",
+  "createdAtDescending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductCustomSortInput: object + +

+
+
+
+
+
+ aToZAscending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product name ascending.

+
+
+ aToZDescending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product name descending.

+
+
+ priceAscending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product price ascending.

+
+
+ priceDescending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by product price descending.

+
+
+ createdAtDescending: +
+
+ Boolean +
+
+ + +
+
+

Whether to activate sort by newest product.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "aToZAscending": "boolean",
+  "aToZDescending": "boolean",
+  "priceAscending": "boolean",
+  "priceDescending": "boolean",
+  "createdAtDescending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductDeleteInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

ID of the product to be deleted.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object"
+}
+
+ + +
+
+
+
+
+

+ ProductDetail: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+ description: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "description": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductExtension: object + +

+
+
+
+
+
+ productID: +
+
+ ID +
+
+ +
+
+ crossSellProductIDs: +
+
+ String +
+
+ +
+
+ upsellProductIDs: +
+
+ String +
+
+ +
+
+ discountRecommendationEnabled: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "productID": "object",
+  "crossSellProductIDs": [
+    "string"
+  ],
+  "upsellProductIDs": [
+    "string"
+  ],
+  "discountRecommendationEnabled": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductExtensionInput: object + +

+
+
+
+
+
+ crossSellProductIDs: +
+
+ String +
+
+ +
+
+

cross sell product IDs for the product's extension.

+
+
+ upsellProductIDs: +
+
+ String +
+
+ +
+
+

upsell product IDs for the product's extension.

+
+
+ discountRecommendationEnabled: +
+
+ Boolean +
+
+ + +
+
+

discount recommendation enabled for the product's extension.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "crossSellProductIDs": [
+    "string"
+  ],
+  "upsellProductIDs": [
+    "string"
+  ],
+  "discountRecommendationEnabled": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductFilter: object + +

+
+
+
+
+
+ channelID: +
+
+ String +
+
+ +
+
+ minimumPrice: +
+
+ Int +
+
+ +
+
+ maximumPrice: +
+
+ Int +
+
+ +
+
+ maximumStock: +
+
+ Int +
+
+ +
+
+ minimumStock: +
+
+ Int +
+
+ +
+
+ currencyCode: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ tagName: +
+
+ String +
+
+ +
+
+

deprecated

+
+
+ tagNames: +
+
+ String +
+
+ +
+
+ collectionSlugs: +
+
+ String +
+
+ +
+
+

deprecated

+
+
+ openOrder: +
+
+ Boolean +
+
+ +
+
+ openOrderScheduled: +
+
+ Boolean +
+
+ +
+
+ variantOptionSpecs: +
+
+ VariantOptionType +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "string",
+  "minimumPrice": "number",
+  "maximumPrice": "number",
+  "maximumStock": "number",
+  "minimumStock": "number",
+  "currencyCode": "string",
+  "published": "boolean",
+  "tagName": "string",
+  "tagNames": [
+    "string"
+  ],
+  "collectionSlugs": [
+    "string"
+  ],
+  "openOrder": "boolean",
+  "openOrderScheduled": "boolean",
+  "variantOptionSpecs": [
+    {
+      "optionKey": "string",
+      "optionValue": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductFilterAndSort: object + +

+
+
+
+
+
+ filters: +
+
+ ProductCustomFilter +
+
+ +
+
+

Custom filters.

+
+
+ sorts: +
+ +
+ + +
+
+

Custom sorts.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "filters": [
+    {
+      "name": "string",
+      "isActive": "boolean",
+      "type": "string",
+      "variantSpecs": [
+        {
+          "key": "string",
+          "translations": [
+            {
+              "language": "string",
+              "text": "string"
+            }
+          ],
+          "options": [
+            {
+              "attributes": [
+                {
+                  "key": "string",
+                  "value": "string"
+                }
+              ],
+              "isActive": "boolean",
+              "translations": [
+                {
+                  "language": "string",
+                  "text": "string"
+                }
+              ],
+              "value": "string"
+            }
+          ]
+        }
+      ],
+      "tagSpec": {
+        "options": [
+          {
+            "key": "string",
+            "translations": [
+              {
+                "language": "string",
+                "text": "string"
+              }
+            ]
+          }
+        ]
+      },
+      "priceSpec": {
+        "options": [
+          {
+            "min": "number",
+            "max": "number"
+          }
+        ]
+      }
+    }
+  ],
+  "sorts": {
+    "aToZAscending": "boolean",
+    "aToZDescending": "boolean",
+    "priceAscending": "boolean",
+    "priceDescending": "boolean",
+    "createdAtDescending": "boolean"
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductFilterAndSortInput: object + +

+
+
+
+
+
+ filters: +
+
+ ProductCustomFilterInput +
+
+ +
+
+

Custom filters.

+
+
+ sorts: +
+ +
+ + +
+
+

Custom sorts.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "filters": [
+    {
+      "name": "string",
+      "isActive": "boolean",
+      "type": "string",
+      "variantSpecs": [
+        {
+          "key": "string",
+          "translations": [
+            {
+              "language": "string",
+              "text": "string"
+            }
+          ],
+          "options": [
+            {
+              "value": "string",
+              "translations": [
+                {
+                  "language": "string",
+                  "text": "string"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "tagSpec": {
+        "options": [
+          {
+            "key": "string",
+            "translations": [
+              {
+                "language": "string",
+                "text": "string"
+              }
+            ]
+          }
+        ]
+      },
+      "priceSpec": {
+        "options": [
+          {
+            "min": "number",
+            "max": "number"
+          }
+        ]
+      }
+    }
+  ],
+  "sorts": {
+    "aToZAscending": "boolean",
+    "aToZDescending": "boolean",
+    "priceAscending": "boolean",
+    "priceDescending": "boolean",
+    "createdAtDescending": "boolean"
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductFilterInput: object + +

+
+
+
+
+
+ channelID: +
+
+ String +
+
+ +
+
+ minimumPrice: +
+
+ Int +
+
+ +
+
+ maximumPrice: +
+
+ Int +
+
+ +
+
+ maximumStock: +
+
+ Int +
+
+ +
+
+ minimumStock: +
+
+ Int +
+
+ +
+
+ currencyCode: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ tagName: +
+
+ String +
+
+ +
+
+

deprecated

+
+
+ tagNames: +
+
+ String +
+
+ +
+
+ collectionSlugs: +
+
+ String +
+
+ +
+
+

deprecated

+
+
+ openOrder: +
+
+ Boolean +
+
+ +
+
+ openOrderScheduled: +
+
+ Boolean +
+
+ +
+
+ variantOptionSpecs: +
+
+ VariantOptionSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "string",
+  "minimumPrice": "number",
+  "maximumPrice": "number",
+  "maximumStock": "number",
+  "minimumStock": "number",
+  "currencyCode": "string",
+  "published": "boolean",
+  "tagName": "string",
+  "tagNames": [
+    "string"
+  ],
+  "collectionSlugs": [
+    "string"
+  ],
+  "openOrder": "boolean",
+  "openOrderScheduled": "boolean",
+  "variantOptionSpecs": [
+    {
+      "optionKey": "string",
+      "optionValue": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductInfo: object + +

+
+
+
+
+
+ product: +
+
+ Product +
+
+ +
+
+ price: +
+
+ Money +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "product": {
+    "ID": "object",
+    "brandID": "object",
+    "brand": {
+      "ID": "string",
+      "name": "string",
+      "tenantID": "string",
+      "tenant": {
+        "ID": "object",
+        "name": "string",
+        "language": "string",
+        "currencyCode": "string",
+        "brands": {
+          "items": [
+            {
+              "ID": "string",
+              "name": "string",
+              "tenantID": "string",
+              "tenant": {
+                "ID": "object",
+                "name": "string",
+                "language": "string",
+                "currencyCode": "string",
+                "brands": {
+                  "items": [
+                    {
+                      "ID": "string",
+                      "name": "string",
+                      "tenantID": "string",
+                      "tenant": {
+                        "ID": "object",
+                        "name": "string",
+                        "language": "string",
+                        "currencyCode": "string",
+                        "brands": {
+                          "items": [
+                            {
+                              "ID": "string",
+                              "name": "string",
+                              "tenantID": "string",
+                              "tenant": {
+                                "ID": "object",
+                                "name": "string",
+                                "language": "string",
+                                "currencyCode": "string",
+                                "brands": {
+                                  "items": [
+                                    {
+                                      "ID": "string",
+                                      "name": "string",
+                                      "tenantID": "string"
+                                    }
+                                  ]
+                                }
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductInfoInput: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ price: +
+ +
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "price": {
+    "code": "string",
+    "value": "number"
+  },
+  "quantity": "number"
+}
+
+ + +
+
+
+
+
+

+ ProductLineData: object + +

+
+
+
+
+
+ productCode: +
+
+ String +
+
+ +
+
+ productFid: +
+
+ String +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ price: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "productCode": "string",
+  "productFid": "string",
+  "quantity": "number",
+  "title": "string",
+  "price": "number"
+}
+
+ + +
+
+
+
+
+

+ ProductOption: object + +

+
+
+
+
+
+ options: +
+
+ ProductOptionSpec +
+
+ +
+
+

Options for a product.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "options": [
+    {
+      "key": {
+        "ID": "object",
+        "translations": [
+          {
+            "language": "string",
+            "text": "string"
+          }
+        ],
+        "isDefault": "boolean"
+      },
+      "values": [
+        {
+          "ID": "object",
+          "translations": [
+            {
+              "language": "string",
+              "text": "string"
+            }
+          ],
+          "attributes": [
+            {
+              "key": "string",
+              "value": "string"
+            }
+          ],
+          "isActive": "boolean"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductOptionInput: object + +

+
+
+
+
+
+ options: +
+
+ ProductOptionSpecInput +
+
+ +
+
+

The product's options.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "options": [
+    {
+      "key": {
+        "ID": "object",
+        "translations": [
+          {
+            "language": "string",
+            "text": "string"
+          }
+        ],
+        "isDefault": "boolean"
+      },
+      "values": [
+        {
+          "ID": "object",
+          "translations": [
+            {
+              "language": "string",
+              "text": "string"
+            }
+          ],
+          "attributes": [
+            {
+              "key": "string",
+              "value": "string"
+            }
+          ],
+          "isActive": "boolean"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductOptionKey: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ translations: +
+
+ ProductOptionTranslation +
+
+ +
+
+

Translations for a product option key.

+
+
+ isDefault: +
+
+ Boolean +
+
+ +
+
+

Whether this is default option.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "isDefault": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionKeyInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

The ID of product option key.

+
+
+ translations: +
+
+ ProductOptionTranslationInput +
+
+ +
+
+

Translations for product option key.

+
+
+ isDefault: +
+
+ Boolean +
+
+ +
+
+

Whether this is default option. This eventually will be marked as required, but for now marked as optional for compatibility.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "isDefault": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionSpec: object + +

+
+
+
+
+
+ key: +
+ +
+ +
+
+

Key for a product option specification.

+
+
+ values: +
+
+ ProductOptionValue +
+
+ +
+
+

Values for a product option specification.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": {
+    "ID": "object",
+    "translations": [
+      {
+        "language": "string",
+        "text": "string"
+      }
+    ],
+    "isDefault": "boolean"
+  },
+  "values": [
+    {
+      "ID": "object",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ],
+      "attributes": [
+        {
+          "key": "string",
+          "value": "string"
+        }
+      ],
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductOptionSpecInput: object + +

+
+
+
+
+
+ key: +
+ +
+ + +
+
+

Key for product option.

+
+
+ values: +
+
+ ProductOptionValueInput +
+
+ +
+
+

Values for product option.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": {
+    "ID": "object",
+    "translations": [
+      {
+        "language": "string",
+        "text": "string"
+      }
+    ],
+    "isDefault": "boolean"
+  },
+  "values": [
+    {
+      "ID": "object",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ],
+      "attributes": [
+        {
+          "key": "string",
+          "value": "string"
+        }
+      ],
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductOptionTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ text: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionTranslationInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+

Language for the translation.

+
+
+ text: +
+
+ String +
+
+ + +
+
+

Text for the translation.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionValue: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ translations: +
+
+ ProductOptionTranslation +
+
+ +
+
+

Translations for a product option value.

+
+
+ attributes: +
+
+ ProductOptionValueAttribute +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionValueAttribute: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionValueAttributeInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductOptionValueInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

The ID of product option value.

+
+
+ translations: +
+
+ ProductOptionTranslationInput +
+
+ +
+
+

Translations for product option value.

+
+
+ attributes: +
+
+ ProductOptionValueAttributeInput +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductPromotion: object + +

+
+
+
+
+
+ promotionID: +
+
+ ID +
+
+ +
+
+ promotionTitle: +
+
+ String +
+
+ +
+
+ promotionType: +
+ +
+ +
+
+ channelIDs: +
+
+ ID +
+
+ +
+
+ startDate: +
+
+ Int +
+
+ +
+
+ endDate: +
+
+ Int +
+
+ +
+
+ moneyValue: +
+
+ Money +
+
+ +
+
+ scalarValue: +
+
+ Int +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ discountType: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "promotionID": "object",
+  "promotionTitle": "string",
+  "promotionType": "string",
+  "channelIDs": [
+    "object"
+  ],
+  "startDate": "number",
+  "endDate": "number",
+  "moneyValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "scalarValue": "number",
+  "isActive": "boolean",
+  "discountType": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductReview: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

Review ID

+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID belongs to the review

+
+
+ orderID: +
+
+ ID +
+
+ +
+
+

Order ID belongs to the review

+
+
+ orderCompletedAt: +
+
+ Int +
+
+ +
+
+

Time when order completed

+
+
+ productID: +
+
+ ID +
+
+ + +
+
+

Reviewed product id

+
+
+ product: +
+
+ Product +
+
+ +
+
+

Reviewed Product

+
+
+ rating: +
+
+ Int +
+
+ + +
+
+

Rating in the review

+
+
+ review: +
+
+ String +
+
+ +
+
+

Review's content

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+

Review's image(s)

+
+
+ videoURLs: +
+
+ String +
+
+ +
+
+

Review's video(s)

+
+
+ reviewerName: +
+
+ String +
+
+ + +
+
+

Reviewer's name

+
+
+ reviewerEmail: +
+
+ String +
+
+ +
+
+

Reviewer's email

+
+
+ customerID: +
+
+ String +
+
+ +
+
+

Customer ID

+
+
+ createdByAdmin: +
+
+ Boolean +
+
+ + +
+
+

Flag that identidy whether the review created by admin or not

+
+
+ submittedAt: +
+
+ Int +
+
+ +
+
+

Time when the review submitted

+
+
+ status: +
+ +
+ + +
+
+

Review status

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "orderID": "object",
+  "orderCompletedAt": "number",
+  "productID": "object",
+  "product": {
+    "ID": "object",
+    "brandID": "object",
+    "brand": {
+      "ID": "string",
+      "name": "string",
+      "tenantID": "string",
+      "tenant": {
+        "ID": "object",
+        "name": "string",
+        "language": "string",
+        "currencyCode": "string",
+        "brands": {
+          "items": [
+            {
+              "ID": "string",
+              "name": "string",
+              "tenantID": "string",
+              "tenant": {
+                "ID": "object",
+                "name": "string",
+                "language": "string",
+                "currencyCode": "string",
+                "brands": {
+                  "items": [
+                    {
+                      "ID": "string",
+                      "name": "string",
+                      "tenantID": "string",
+                      "tenant": {
+                        "ID": "object",
+                        "name": "string",
+                        "language": "string",
+                        "currencyCode": "string",
+                        "brands": {
+                          "items": [
+                            {
+                              "ID": "string",
+                              "name": "string",
+                              "tenantID": "string",
+                              "tenant": {
+                                "ID": "object",
+                                "name": "string",
+                                "language": "string",
+                                "currencyCode": "string",
+                                "brands": {}
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductReviewFilter: object + +

+
+
+
+
+
+ brandIDs: +
+
+ String +
+
+ +
+
+ customerIDs: +
+
+ String +
+
+ +
+
+ status: +
+
+ ProductReviewStatusEnum +
+
+ +
+
+ productIDs: +
+
+ String +
+
+ +
+
+ orderIDs: +
+
+ String +
+
+ +
+
+ createdByAdmin: +
+
+ Boolean +
+
+ +
+
+ rating: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandIDs": [
+    "string"
+  ],
+  "customerIDs": [
+    "string"
+  ],
+  "status": [
+    "string"
+  ],
+  "productIDs": [
+    "string"
+  ],
+  "orderIDs": [
+    "string"
+  ],
+  "createdByAdmin": "boolean",
+  "rating": "number"
+}
+
+ + +
+
+
+
+
+

+ ProductReviewFilterInput: object + +

+
+
+
+
+
+ brandIDs: +
+
+ String +
+
+ +
+
+ customerIDs: +
+
+ String +
+
+ +
+
+ status: +
+
+ ProductReviewStatusEnum +
+
+ +
+
+ productIDs: +
+
+ String +
+
+ +
+
+ orderIDs: +
+
+ String +
+
+ +
+
+ createdByAdmin: +
+
+ Boolean +
+
+ +
+
+ rating: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandIDs": [
+    "string"
+  ],
+  "customerIDs": [
+    "string"
+  ],
+  "status": [
+    "string"
+  ],
+  "productIDs": [
+    "string"
+  ],
+  "orderIDs": [
+    "string"
+  ],
+  "createdByAdmin": "boolean",
+  "rating": "number"
+}
+
+ + +
+
+
+
+
+

+ ProductReviewSortEnum: string + +

+
+
+
+
+
+
object
+ + SUBMITTED + + +
+
+
+
object
+ + RATING + + +
+
+
+
+
+
+
+
+

+ ProductReviewSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductReviewStatus: string + +

+
+
+
+
+
+
object
+ + APPROVED + + +
+
+
+
object
+ + REJECTED + + +
+
+
+
+
+
+
+
+

+ ProductReviewStatusEnum: string + +

+
+
+
+
+
+
object
+ + DRAFT + + +
+
+
+
object
+ + PENDING + + +
+
+
+
object
+ + APPROVED + + +
+
+
+
object
+ + REJECTED + + +
+
+
+
+
+
+
+
+

+ ProductSEO: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ keywords: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "description": "string",
+  "keywords": [
+    "string"
+  ],
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductSales: object + +

+
+
+
+
+
+ orderCount: +
+
+ Int +
+
+ +
+
+ productName: +
+
+ String +
+
+ +
+
+ productSKU: +
+
+ String +
+
+ +
+
+ soldQuantity: +
+
+ Int +
+
+ +
+
+ totalNetRevenue: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderCount": "number",
+  "productName": "string",
+  "productSKU": "string",
+  "soldQuantity": "number",
+  "totalNetRevenue": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductSort: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductSortFields: string + +

+
+
+
+
+
+
object
+ + ID + + +
+
+
+
object
+ + CREATED + + +
+
+
+
object
+ + NAME + + +
+
+
+
object
+ + PRICE + + +
+
+
+
+
+
+
+
+

+ ProductSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductStock: object + +

+
+
+
+
+
+ sku: +
+
+ String +
+
+ +
+
+ SKU: +
+
+ String +
+
+ +
+
+ channelId: +
+
+ String +
+
+ +
+
+ channelID: +
+
+ String +
+
+ +
+
+ stock: +
+
+ Int +
+
+ +
+
+ currency: +
+
+ String +
+
+ +
+
+ price: +
+
+ Int +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sku": "string",
+  "SKU": "string",
+  "channelId": "string",
+  "channelID": "string",
+  "stock": "number",
+  "currency": "string",
+  "price": "number",
+  "published": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ProductTag: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ translations: +
+
+ ProductTagTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductTagTranslation: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ text: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductTranslationAttributeInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+

Key for product's translation attribute.

+
+
+ value: +
+
+ String +
+
+ + +
+
+

Value for product's translation attribute.

+
+
+ language: +
+
+ String +
+
+ + +
+
+

Language for the translation. Should be a code and capitalized (e.g: 'ID' / 'EN').

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductVariant: object + +

+
+
+
+
+
+ product: +
+
+ Product +
+
+ + +
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ options: +
+
+ VariantOption +
+
+ +
+
+ basePrices: +
+
+ Money +
+
+ +
+
+ salePrices: +
+
+ Money +
+
+ +
+
+ attributes: +
+
+ VariantAttribute +
+
+ +
+
+ channelAttributes: +
+
+ VariantChannelAttribute +
+
+ +
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ SKU: +
+
+ ID +
+
+ + +
+
+ details: +
+
+ VariantDetail +
+
+ +
+
+ stock: +
+ +
+ +
+
+ stocks: +
+
+ Stocks +
+
+ +
+
+ discounts: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "product": {
+    "ID": "object",
+    "brandID": "object",
+    "brand": {
+      "ID": "string",
+      "name": "string",
+      "tenantID": "string",
+      "tenant": {
+        "ID": "object",
+        "name": "string",
+        "language": "string",
+        "currencyCode": "string",
+        "brands": {
+          "items": [
+            {
+              "ID": "string",
+              "name": "string",
+              "tenantID": "string",
+              "tenant": {
+                "ID": "object",
+                "name": "string",
+                "language": "string",
+                "currencyCode": "string",
+                "brands": {
+                  "items": [
+                    {
+                      "ID": "string",
+                      "name": "string",
+                      "tenantID": "string",
+                      "tenant": {
+                        "ID": "object",
+                        "name": "string",
+                        "language": "string",
+                        "currencyCode": "string",
+                        "brands": {
+                          "items": [
+                            {
+                              "ID": "string",
+                              "name": "string",
+                              "tenantID": "string",
+                              "tenant": {
+                                "ID": "object",
+                                "name": "string",
+                                "language": "string",
+                                "currencyCode": "string",
+                                "brands": {
+                                  "items": [
+                                    {
+                                      "ID": "string",
+                                      "name": "string",
+                                      "tenantID": "string"
+                                    }
+                                  ]
+                                }
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductVariantOption: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ name: +
+
+ TranslatableText +
+
+ +
+
+ options: +
+
+ Option +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "name": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "options": [
+    {
+      "id": "string",
+      "translations": [
+        {
+          "language": "string",
+          "text": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ProductVariantOptionInput: object + +

+
+
+
+
+
+ key: +
+ +
+ + +
+
+

Key for product's variant option.

+
+
+ values: +
+ +
+ + +
+
+

Values for product's variant option.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": {
+    "ID": "object",
+    "translations": [
+      {
+        "language": "string",
+        "text": "string"
+      }
+    ]
+  },
+  "values": {
+    "ID": "object",
+    "translations": [
+      {
+        "language": "string",
+        "text": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ ProductVolume: object + +

+
+
+
+
+
+ length: +
+
+ Float +
+
+ +
+
+ height: +
+
+ Float +
+
+ +
+
+ width: +
+
+ Float +
+
+ +
+
+ unit: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "length": "number",
+  "height": "number",
+  "width": "number",
+  "unit": "string"
+}
+
+ + +
+
+
+
+
+

+ ProductWeight: object + +

+
+
+
+
+
+ value: +
+
+ Float +
+
+ +
+
+ unit: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "value": "number",
+  "unit": "string"
+}
+
+ + +
+
+
+
+
+

+ ProfileAddress: object + +

+
+
+
+
+
+ addressLabel: +
+
+ String +
+
+ + +
+
+ contactName: +
+
+ String +
+
+ + +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ street: +
+
+ String +
+
+ + +
+
+ latitude: +
+
+ String +
+
+ + +
+
+ longitude: +
+
+ String +
+
+ + +
+
+ postalCode: +
+
+ String +
+
+ + +
+
+ isPrimary: +
+
+ Boolean +
+
+ + +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "addressLabel": "string",
+  "contactName": "string",
+  "districtCode": "string",
+  "street": "string",
+  "latitude": "string",
+  "longitude": "string",
+  "postalCode": "string",
+  "isPrimary": "boolean",
+  "salesChannel": "string"
+}
+
+ + +
+
+
+
+
+

+ ProfileUpdateStatus: object + +

+
+
+
+
+
+ errorMessage: +
+
+ String +
+
+ +
+
+ action: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "errorMessage": "string",
+  "action": "string"
+}
+
+ + +
+
+
+
+
+

+ Promotion: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ startDate: +
+
+ Int +
+
+ +
+
+ endDate: +
+
+ Int +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ type: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "channelIDs": [
+    "string"
+  ],
+  "startDate": "number",
+  "endDate": "number",
+  "name": "string",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ PromotionFilterInput: object + +

+
+
+
+
+
+ endDate: +
+
+ Timestamp +
+
+ +
+
+ startDate: +
+
+ Timestamp +
+
+ +
+
+ type: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "endDate": "object",
+  "startDate": "object",
+  "type": "string"
+}
+
+ + +
+
+
+
+
+

+ PromotionType: string + +

+
+
+
+
+
+
object
+ + BUNDLE + + +
+
+
+
object
+ + DISCOUNT + + +
+
+
+
object
+ + COUPON + + +
+
+
+
+
+
+
+
+

+ Province: object + +

+
+
+
+
+
+ locationCode: +
+
+ String +
+
+ +
+
+ providerData: +
+
+ String +
+
+ +
+
+ cities: +
+
+ City +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "locationCode": "string",
+  "providerData": "string",
+  "cities": [
+    {
+      "locationCode": "string",
+      "providerData": "string",
+      "districts": [
+        {
+          "locationCode": "string",
+          "providerData": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ PublishCartIDInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+ cartId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string",
+  "cartId": "string"
+}
+
+ + +
+
+
+
+
+

+ PublishTestimonialsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of testimonial IDs to be published

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ PushNotification: object + +

+
+
+
+
+
+ enabled: +
+
+ Boolean +
+
+ +
+
+ oneSignal: +
+
+ OneSignal +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "enabled": "boolean",
+  "oneSignal": {
+    "appID": "string",
+    "appKey": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ PushNotificationInput: object + +

+
+
+
+
+
+ enabled: +
+
+ Boolean +
+
+ +
+
+ oneSignal: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "enabled": "boolean",
+  "oneSignal": {
+    "appID": "string",
+    "appKey": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ QuickReply: object + +

+
+
+
+
+
+ id: +
+
+ Int +
+
+ + +
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+ status: +
+
+ Boolean +
+
+ + +
+
+ category: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "number",
+  "key": "string",
+  "value": "string",
+  "status": "boolean",
+  "category": "string"
+}
+
+ + +
+
+
+
+
+

+ RawProductVariant: object + +

+
+
+
+
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ options: +
+
+ VariantOption +
+
+ +
+
+ basePrices: +
+
+ Money +
+
+ +
+
+ salePrices: +
+
+ Money +
+
+ +
+
+ attributes: +
+
+ VariantAttribute +
+
+ +
+
+ channelAttributes: +
+
+ VariantChannelAttribute +
+
+ +
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ SKU: +
+
+ ID +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelIDs": [
+    "string"
+  ],
+  "options": [
+    {
+      "variant": {
+        "product": {
+          "ID": "object",
+          "brandID": "object",
+          "brand": {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string",
+                                    "tenant": {
+                                      "ID": "object",
+                                      "name": "string",
+                                      "language": "string",
+                                      "currencyCode": "string",
+                                      "brands": {
+                                        "items": [
+                                          null
+                                        ]
+                                      }
+                                    }
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ RecipientData: object + +

+
+
+
+
+
+ phoneNumber: +
+
+ String +
+
+ +
+
+ postCode: +
+
+ String +
+
+ +
+
+ district: +
+
+ String +
+
+ +
+
+ address: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phoneNumber": "string",
+  "postCode": "string",
+  "district": "string",
+  "address": "string",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ ReintegrateMarketplaceInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected brand.

+
+
+ code: +
+
+ ID +
+
+ + +
+
+

The code of the marketplace.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "code": "object"
+}
+
+ + +
+
+
+
+
+

+ RemoveGoogleAccountInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ ReorderTestimonialsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of testimonial IDs to be reordered.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ RequestGoogleAdsEligibilityInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ RequestMarketplaceIntegrationInput: object + +

+
+
+
+
+
+ tenantID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected tenant.

+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected brand.

+
+
+ channel: +
+
+ String +
+
+ + +
+
+

Marketplace Name

+
+
+ credentials: +
+
+ String +
+
+ + +
+
+

Attached credentials.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "tenantID": "object",
+  "brandID": "object",
+  "channel": "string",
+  "credentials": "string"
+}
+
+ + +
+
+
+
+
+

+ ResetPasswordInput: object + +

+
+
+
+
+
+ token: +
+
+ String +
+
+ + +
+
+

Unique token for resetting password.

+
+
+ newPassword: +
+
+ String +
+
+ + +
+
+

The new password.

+
+
+ isAdmin: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether the member is an admin or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "token": "string",
+  "newPassword": "string",
+  "isAdmin": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SEO: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ keywords: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "title": "string",
+  "description": "string",
+  "keywords": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ SEOInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ title: +
+
+ String +
+
+ + +
+
+ description: +
+
+ String +
+
+ + +
+
+ keywords: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "title": "string",
+  "description": "string",
+  "keywords": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ Sales: object + +

+
+
+
+
+
+ channelID: +
+
+ String +
+
+ +
+
+ variants: +
+
+ ProductVariant +
+
+ +
+
+ syncStatus: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "string",
+  "variants": [
+    {
+      "product": {
+        "ID": "object",
+        "brandID": "object",
+        "brand": {
+          "ID": "string",
+          "name": "string",
+          "tenantID": "string",
+          "tenant": {
+            "ID": "object",
+            "name": "string",
+            "language": "string",
+            "currencyCode": "string",
+            "brands": {
+              "items": [
+                {
+                  "ID": "string",
+                  "name": "string",
+                  "tenantID": "string",
+                  "tenant": {
+                    "ID": "object",
+                    "name": "string",
+                    "language": "string",
+                    "currencyCode": "string",
+                    "brands": {
+                      "items": [
+                        {
+                          "ID": "string",
+                          "name": "string",
+                          "tenantID": "string",
+                          "tenant": {
+                            "ID": "object",
+                            "name": "string",
+                            "language": "string",
+                            "currencyCode": "string",
+                            "brands": {
+                              "items": [
+                                {
+                                  "ID": "string",
+                                  "name": "string",
+                                  "tenantID": "string",
+                                  "tenant": {
+                                    "ID": "object",
+                                    "name": "string",
+                                    "language": "string",
+                                    "currencyCode": "string",
+                                    "brands": {
+                                      "items": [
+                                        {
+                                          "ID": "string"
+                                        }
+                                      ]
+                                    }
+                                  }
+                                }
+                              ]
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SalesByMember: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ memberID: +
+
+ String +
+
+ +
+
+ orderCount: +
+
+ Int +
+
+ +
+
+ orderDate: +
+
+ Int +
+
+ +
+
+ totalDiscount: +
+
+ Money +
+
+ +
+
+ totalOrderAmount: +
+
+ Money +
+
+ +
+
+ totalShippingFee: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "email": "string",
+  "memberID": "string",
+  "orderCount": "number",
+  "orderDate": "number",
+  "totalDiscount": {
+    "code": "string",
+    "value": "number"
+  },
+  "totalOrderAmount": {
+    "code": "string",
+    "value": "number"
+  },
+  "totalShippingFee": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ SalesByMemberFilterInput: object + +

+
+
+
+
+
+ endOrderDate: +
+
+ Int +
+
+ +
+
+ memberEmails: +
+
+ String +
+
+ +
+
+ memberIDs: +
+
+ String +
+
+ +
+
+ startOrderDate: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "endOrderDate": "number",
+  "memberEmails": [
+    "string"
+  ],
+  "memberIDs": [
+    "string"
+  ],
+  "startOrderDate": "number"
+}
+
+ + +
+
+
+
+
+

+ SalesChannel: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ + +
+
+ channelAttributes: +
+
+ ChannelAttribute +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string",
+  "channelAttributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SalesChannelFilterInput: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string"
+}
+
+ + +
+
+
+
+
+

+ SalesItemDetail: object + +

+
+
+
+
+
+ variant: +
+
+ Variant +
+
+ + +
+
+ stock: +
+
+ Int +
+
+ + +
+
+ buffer: +
+
+ Int +
+
+ + +
+
+ price: +
+ +
+ + +
+
+ salePrice: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "variant": {
+    "SKU": "object",
+    "optionValue": [
+      {
+        "key": "object",
+        "value": "string"
+      }
+    ],
+    "stock": "number",
+    "attributes": [
+      {
+        "sortIndex": "number",
+        "translations": [
+          {
+            "key": "object",
+            "value": "string",
+            "language": "string"
+          }
+        ]
+      }
+    ],
+    "channelAttributes": [
+      {
+        "channelID": "object",
+        "key": "object",
+        "value": "string"
+      }
+    ],
+    "images": [
+      "string"
+    ]
+  },
+  "stock": "number",
+  "buffer": "number",
+  "price": {
+    "currencyCode": "string",
+    "amount": "number"
+  },
+  "salePrice": {
+    "currencyCode": "string",
+    "amount": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ SaveCartByMemberIDReq: object + +

+
+
+
+
+
+ billingAddress: +
+ +
+ +
+
+

The billing address of this cart.

+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID of this cart.

+
+
+ memberLevel: +
+
+ String +
+
+ +
+
+

(Deprecated) The membership level of this member.

+
+
+ membershipId: +
+
+ String +
+
+ +
+
+

The membershipId of this member.

+
+
+ couponIDs: +
+
+ String +
+
+ +
+
+

Coupon IDs used in this cart.

+
+
+ deliveryAddress: +
+ +
+ +
+
+

The delivery address of this cart.

+
+
+ lineItems: +
+
+ CartLineItemInput +
+
+ +
+
+

The line items in this cart.

+
+
+ memberID: +
+
+ String +
+
+ + +
+
+

Member ID of this cart.

+
+
+ payment: +
+ +
+ +
+
+

Payment for this cart.

+
+
+ shipping: +
+ +
+ +
+
+

Shipping for this cart.

+
+
+ cartID: +
+
+ String +
+
+ +
+
+

Cart ID of old cart.

+
+
+ removeCoupons: +
+
+ Boolean +
+
+ +
+
+

deprecated flag

+
+
+ isCouponRemoved: +
+
+ Boolean +
+
+ +
+
+

flag for remove coupons.

+
+
+ isLineItemsRemoved: +
+
+ Boolean +
+
+ +
+
+

flag for delete lineItems.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "billingAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string"
+  },
+  "brandID": "string",
+  "memberLevel": "string",
+  "membershipId": "string",
+  "couponIDs": [
+    "string"
+  ],
+  "deliveryAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string"
+  },
+  "lineItems": [
+    {
+      "imageURL": "string",
+      "price": {
+        "code": "string",
+        "value": "number"
+      },
+      "quantity": "number",
+      "SKU": "string",
+      "title": "string"
+    }
+  ],
+  "memberID": "string",
+  "payment": {
+    "fee": {
+      "code": "string",
+      "value": "number"
+    },
+    "provider": "string",
+    "service": "string",
+    "uniqueCode": "number"
+  },
+  "shipping": {
+    "awbNumber": "string",
+    "cost": {
+      "code": "string",
+      "value": "number"
+    },
+    "provider": "string",
+    "service": "string"
+  },
+  "cartID": "string",
+  "removeCoupons": "boolean",
+  "isCouponRemoved": "boolean",
+  "isLineItemsRemoved": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SaveCartReq: object + +

+
+
+
+
+
+ billingAddress: +
+ +
+ +
+
+

The billing address of this cart.

+
+
+ brandID: +
+
+ String +
+
+ +
+
+

The brand ID of this cart.

+
+
+ cartID: +
+
+ String +
+
+ +
+
+

The ID of an existing cart to be updated/inserted. Omit this to generate a new cart

+
+
+ couponIDs: +
+
+ String +
+
+ +
+
+

Coupons IDs used in this cart.

+
+
+ deliveryAddress: +
+ +
+ +
+
+

Delivery address for this cart.

+
+
+ lineItems: +
+
+ CartLineItemInput +
+
+ +
+
+

This line items in this cart.

+
+
+ payment: +
+ +
+ +
+
+

Payment for this cart.

+
+
+ shipping: +
+ +
+ +
+
+

Shipping for this cart.

+
+
+ removeCoupons: +
+
+ Boolean +
+
+ +
+
+

deprecated flag

+
+
+ isCouponRemoved: +
+
+ Boolean +
+
+ +
+
+

flag for remove coupons.

+
+
+ isLineItemsRemoved: +
+
+ Boolean +
+
+ +
+
+

flag for delete lineItems.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "billingAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string"
+  },
+  "brandID": "string",
+  "cartID": "string",
+  "couponIDs": [
+    "string"
+  ],
+  "deliveryAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string"
+  },
+  "lineItems": [
+    {
+      "imageURL": "string",
+      "price": {
+        "code": "string",
+        "value": "number"
+      },
+      "quantity": "number",
+      "SKU": "string",
+      "title": "string"
+    }
+  ],
+  "payment": {
+    "fee": {
+      "code": "string",
+      "value": "number"
+    },
+    "provider": "string",
+    "service": "string",
+    "uniqueCode": "number"
+  },
+  "shipping": {
+    "awbNumber": "string",
+    "cost": {
+      "code": "string",
+      "value": "number"
+    },
+    "provider": "string",
+    "service": "string"
+  },
+  "removeCoupons": "boolean",
+  "isCouponRemoved": "boolean",
+  "isLineItemsRemoved": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SearchTranslation: object + +

+
+
+
+
+
+ text: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "text": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ SearchTranslationInput: object + +

+
+
+
+
+
+ text: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "text": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ SellerBuyerInput: object + +

+
+
+
+
+
+ id: +
+
+ ID +
+
+ + +
+
+ channel: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "object",
+  "channel": "string"
+}
+
+ + +
+
+
+
+
+

+ SetAdminActions: object + +

+
+
+
+
+
+ specs: +
+
+ SetAdminActionsSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "accountID": "string",
+      "actions": [
+        "string"
+      ],
+      "brandIDs": [
+        "string"
+      ],
+      "allAction": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetAdminActionsSpec: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+ actions: +
+
+ String +
+
+ +
+
+ brandIDs: +
+
+ String +
+
+ +
+
+ allAction: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "actions": [
+    "string"
+  ],
+  "brandIDs": [
+    "string"
+  ],
+  "allAction": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SetArticleDescriptionsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID of the afftected article.

+
+
+ articleID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected article.

+
+
+ descriptions: +
+
+ ArticleDescriptionInput +
+
+ +
+
+

Input for article description to be set.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "articleID": "object",
+  "descriptions": [
+    {
+      "language": "string",
+      "title": "string",
+      "content": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetArticleSEOsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID of the affected article.

+
+
+ articleID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected article.

+
+
+ SEOs: +
+
+ SEOInput +
+
+ +
+
+

The new search engine optimations input to be set.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "articleID": "object",
+  "SEOs": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetAsMaintenance: object + +

+
+
+
+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "isActive": "boolean",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ SetAsMaintenanceInput: object + +

+
+
+
+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the brand is on maintenance or not.

+
+
+ message: +
+
+ String +
+
+ + +
+
+

Set status message.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "isActive": "boolean",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ SetCouponsAsActiveInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of coupon IDs to be activated.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetCouponsAsInactiveInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of coupon IDs to be set as inactive.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetDeliveryAddressSpec: object + +

+
+
+
+
+
+ districtCode: +
+
+ String +
+
+ + +
+
+

District code for this delivery address.

+
+
+ email: +
+
+ String +
+
+ + +
+
+

Email for this delivery address.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name for this delivery address.

+
+
+ phone: +
+
+ String +
+
+ + +
+
+

Phone number for this delivery address.

+
+
+ postalCode: +
+
+ String +
+
+ + +
+
+

Postal code for this delivery address.

+
+
+ street: +
+
+ String +
+
+ + +
+
+

Street name for this delivery address.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "districtCode": "string",
+  "email": "string",
+  "name": "string",
+  "phone": "string",
+  "postalCode": "string",
+  "street": "string"
+}
+
+ + +
+
+
+
+
+

+ SetDeliveryShippingSpec: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+

The provider of the shipping.

+
+
+ service: +
+
+ String +
+
+ + +
+
+

The service of the shipping.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string"
+}
+
+ + +
+
+
+
+
+

+ SetDiscountsAsActiveInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of discount IDs to be set as active.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetDiscountsAsInactiveInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of discount IDs to be set as inactive.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetDiscountsRowsInput: object + +

+
+
+
+
+
+ discountID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected discount.

+
+
+ rows: +
+
+ UpsertDiscountsRowInput +
+
+ +
+
+

Input for setting discount rows.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "discountID": "object",
+  "rows": [
+    {
+      "referenceID": "object",
+      "discountType": "string",
+      "moneyValue": {
+        "code": "string",
+        "value": "number"
+      },
+      "scalarValue": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetExchangePointSettingInput: object + +

+
+
+
+
+
+ specs: +
+
+ SetExchangePointSettingSpecInput +
+
+ +
+
+

Specifications for setting exchange point setting.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "ID": "object",
+      "brandID": "string",
+      "pointProvider": "string",
+      "membershipLevel": "string",
+      "moneyPerPoint": "number",
+      "pointPerMoney": "number",
+      "maximumPointsToExchangePerTransaction": "number",
+      "minimumPointsToExchangePerTransaction": "number",
+      "minimumMoneyToSpendPerTransaction": "number",
+      "maximumMoneyToConvertPerTransaction": "number",
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetExchangePointSettingSpecInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of an exchange point setting to be updated/inserted. Omit this to create a new loyalty point setting.

+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

Brand ID to put this setting in.

+
+
+ pointProvider: +
+
+ String +
+
+ +
+
+

Provider of the loyalty point. e.g: 'SRCL' for 'sirclo'

+
+
+ membershipLevel: +
+
+ String +
+
+ +
+
+

Membership level for exchanging points.

+
+
+ moneyPerPoint: +
+
+ Int +
+
+ +
+
+

Money per point ratio.

+
+
+ pointPerMoney: +
+
+ Int +
+
+ +
+
+

Point per money ratio.

+
+
+ maximumPointsToExchangePerTransaction: +
+
+ Int +
+
+ +
+
+

Maximum points that can be used in one transaction.

+
+
+ minimumPointsToExchangePerTransaction: +
+
+ Int +
+
+ +
+
+

Minimum points that can be used in one transaction.

+
+
+ minimumMoneyToSpendPerTransaction: +
+
+ Int +
+
+ +
+
+

Minimum amount of money to spend to exchange points in one transaction.

+
+
+ maximumMoneyToConvertPerTransaction: +
+
+ Int +
+
+ +
+
+

Maximum amount of money to spend to exchange points in one transaction.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the setting is active of not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "string",
+  "pointProvider": "string",
+  "membershipLevel": "string",
+  "moneyPerPoint": "number",
+  "pointPerMoney": "number",
+  "maximumPointsToExchangePerTransaction": "number",
+  "minimumPointsToExchangePerTransaction": "number",
+  "minimumMoneyToSpendPerTransaction": "number",
+  "maximumMoneyToConvertPerTransaction": "number",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SetMemberLoyaltyPointInput: object + +

+
+
+
+
+
+ specs: +
+
+ SetMemberLoyaltyPointSpecInput +
+
+ +
+
+

Specifications for setting member loyalty point.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "brandID": "object",
+      "memberID": "object",
+      "value": "number",
+      "pointProvider": "string",
+      "info": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetMemberLoyaltyPointSpecInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID of the affected member

+
+
+ memberID: +
+
+ ID +
+
+ + +
+
+

The ID of the affected member.

+
+
+ value: +
+
+ Int +
+
+ + +
+
+

The value of loyalty point(s) to be set.

+
+
+ pointProvider: +
+
+ String +
+
+ +
+
+

The provider of the loyalty points.

+
+
+ info: +
+
+ String +
+
+ +
+
+

Information about the loyalty points.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "memberID": "object",
+  "value": "number",
+  "pointProvider": "string",
+  "info": "string"
+}
+
+ + +
+
+
+
+
+

+ SetMembershipModelInput: object + +

+
+
+
+
+
+ specs: +
+
+ SetMembershipModelSpecInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "ID": "string",
+      "brandID": "string",
+      "pointProvider": "string",
+      "membershipLevel": "string",
+      "isActive": "boolean",
+      "moneyPerPoint": "number",
+      "pointPerMoney": "number",
+      "maximumPointsToExchangePerTransaction": "number",
+      "minimumPointsToExchangePerTransaction": "number",
+      "minimumMoneyToSpendPerTransaction": "number",
+      "maximumMoneyToConvertPerTransaction": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetMembershipModelSpecInput: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ + +
+
+ pointProvider: +
+
+ String +
+
+ +
+
+ membershipLevel: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+ moneyPerPoint: +
+
+ Int +
+
+ +
+
+ pointPerMoney: +
+
+ Int +
+
+ +
+
+ maximumPointsToExchangePerTransaction: +
+
+ Int +
+
+ +
+
+ minimumPointsToExchangePerTransaction: +
+
+ Int +
+
+ +
+
+ minimumMoneyToSpendPerTransaction: +
+
+ Int +
+
+ +
+
+ maximumMoneyToConvertPerTransaction: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "brandID": "string",
+  "pointProvider": "string",
+  "membershipLevel": "string",
+  "isActive": "boolean",
+  "moneyPerPoint": "number",
+  "pointPerMoney": "number",
+  "maximumPointsToExchangePerTransaction": "number",
+  "minimumPointsToExchangePerTransaction": "number",
+  "minimumMoneyToSpendPerTransaction": "number",
+  "maximumMoneyToConvertPerTransaction": "number"
+}
+
+ + +
+
+
+
+
+

+ SetMembershipPointInput: object + +

+
+
+
+
+
+ specs: +
+
+ SetMembershipPointSpecInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "brandID": "object",
+      "memberID": "object",
+      "value": "number",
+      "pointProvider": "string",
+      "info": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetMembershipPointSpecInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ memberID: +
+
+ ID +
+
+ + +
+
+ value: +
+
+ Int +
+
+ + +
+
+ pointProvider: +
+
+ String +
+
+ +
+
+ info: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "memberID": "object",
+  "value": "number",
+  "pointProvider": "string",
+  "info": "string"
+}
+
+ + +
+
+
+
+
+

+ SetOrderAttributesInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ attributes: +
+
+ OrderAttributeInput +
+
+ +
+
+

Specifications for the order's attributes.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetOrderBillingInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ billingAddress: +
+ +
+ + +
+
+

Billing address for the order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "billingAddress": {
+    "name": "string",
+    "email": "string",
+    "phone": "string",
+    "country": "string",
+    "province": "string",
+    "city": "string",
+    "subDistrict": "string",
+    "street": "string",
+    "districtCode": "string",
+    "postalCode": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ SetOrderDeliveryInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ deliveryAddress: +
+ +
+ + +
+
+

Delivery address for the order.

+
+
+ shipping: +
+ +
+ + +
+
+

Shipping for the order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "deliveryAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string"
+  },
+  "shipping": {
+    "provider": "string",
+    "service": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ SetOrderLineItemsInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ lineItems: +
+
+ OrderLineItemSpec +
+
+ +
+
+

The line items for that order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "lineItems": [
+    {
+      "SKU": "string",
+      "quantity": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetOrderPaymentInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ payment: +
+ +
+ + +
+
+

Payment for the order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "payment": {
+    "provider": "string",
+    "service": "string",
+    "fee": {
+      "code": "string",
+      "value": "number"
+    },
+    "uniqueCode": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ SetOrderShippingInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ shipping: +
+ +
+ + +
+
+

Shipping for the order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "shipping": {
+    "AWBNumber": "string",
+    "provider": "string",
+    "service": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ SetPaymentAvailabilityInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID of the payment.

+
+
+ paymentAvailabilitySpecs: +
+
+ PaymentAvailabilitySpec +
+
+ +
+
+

Payment availability specifications for setting payment availability.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "paymentAvailabilitySpecs": [
+    {
+      "providerID": "string",
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetShippingsStatusInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of shipping IDs to be set.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the shipping is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SetStatusAsReadyToShipReq: object + +

+
+
+
+
+
+ specs: +
+
+ SetStatusAsReadyToShipSpec +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "orderId": "string",
+      "awbNumber": "string",
+      "isAutoAwb": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetStatusAsReadyToShipSpec: object + +

+
+
+
+
+
+ orderId: +
+
+ String +
+
+ + +
+
+ awbNumber: +
+
+ String +
+
+ +
+
+ isAutoAwb: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderId": "string",
+  "awbNumber": "string",
+  "isAutoAwb": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SetStatusProductsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of product IDs to be set.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetVariantBasePriceInput: object + +

+
+
+
+
+
+ productID: +
+
+ ID +
+
+ + +
+
+

the ID of the affected product.

+
+
+ specs: +
+
+ VariantBasePriceSpecInput +
+
+ +
+
+

Specifications for setting variant base price.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "productID": "object",
+  "specs": [
+    {
+      "SKU": "object",
+      "basePrices": [
+        {
+          "code": "string",
+          "value": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SetWarehouseAsDefaultInput: object + +

+
+
+
+
+
+ warehouseID: +
+
+ ID +
+
+ + +
+
+

The warehouse ID to be set as default.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "warehouseID": "object"
+}
+
+ + +
+
+
+
+
+

+ ShipOrderReq: object + +

+
+
+
+
+
+ orderIDs: +
+
+ String +
+
+ +
+
+ notes: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderIDs": [
+    "string"
+  ],
+  "notes": "string"
+}
+
+ + +
+
+
+
+
+

+ Shipping: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+ ID: +
+
+ ID +
+
+ +
+
+ provider: +
+
+ String +
+
+ +
+
+ services: +
+
+ ShippingService +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "ID": "object",
+  "provider": "string",
+  "services": [
+    {
+      "name": "string",
+      "isActive": "boolean",
+      "isAutoAWB": "boolean",
+      "useInsurance": "boolean"
+    }
+  ],
+  "isActive": "boolean",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string"
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ShippingCost: object + +

+
+
+
+
+
+ methods: +
+
+ ShippingCostMethod +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "methods": [
+    {
+      "provider": "string",
+      "service": "string",
+      "cost": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ShippingCostMethod: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ +
+
+ service: +
+
+ String +
+
+ +
+
+ cost: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string",
+  "cost": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ ShippingCoupon: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ couponID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ brand: +
+
+ Brand +
+
+ +
+
+ code: +
+
+ String +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ isValid: +
+
+ Boolean +
+
+ +
+
+ salesChannel: +
+
+ String +
+
+ +
+
+ couponType: +
+ +
+ + +
+
+ maximumUsageCount: +
+
+ Int +
+
+ +
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ +
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ +
+
+ discountValue: +
+ +
+ +
+
+ usages: +
+
+ Usage +
+
+ +
+
+ allowedShippingMethods: +
+
+ String +
+
+ +
+
+ isMemberOnly: +
+
+ Boolean +
+
+ +
+
+ allowedMemberLevels: +
+
+ String +
+
+ +
+
+ minimumPurchase: +
+
+ Money +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "couponID": "string",
+  "brandID": "string",
+  "brand": {
+    "ID": "string",
+    "name": "string",
+    "tenantID": "string",
+    "tenant": {
+      "ID": "object",
+      "name": "string",
+      "language": "string",
+      "currencyCode": "string",
+      "brands": {
+        "items": [
+          {
+            "ID": "string",
+            "name": "string",
+            "tenantID": "string",
+            "tenant": {
+              "ID": "object",
+              "name": "string",
+              "language": "string",
+              "currencyCode": "string",
+              "brands": {
+                "items": [
+                  {
+                    "ID": "string",
+                    "name": "string",
+                    "tenantID": "string",
+                    "tenant": {
+                      "ID": "object",
+                      "name": "string",
+                      "language": "string",
+                      "currencyCode": "string",
+                      "brands": {
+                        "items": [
+                          {
+                            "ID": "string",
+                            "name": "string",
+                            "tenantID": "string",
+                            "tenant": {
+                              "ID": "object",
+                              "name": "string",
+                              "language": "string",
+                              "currencyCode": "string",
+                              "brands": {
+                                "items": [
+                                  {
+                                    "ID": "string",
+                                    "name": "string",
+                                    "tenantID": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ ShippingFilterInput: object + +

+
+
+
+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ShippingInfo: object + +

+
+
+
+
+
+ method: +
+
+ String +
+
+ +
+
+ cost: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "method": "string",
+  "cost": "number"
+}
+
+ + +
+
+
+
+
+

+ ShippingInput: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ + +
+
+ service: +
+
+ String +
+
+ + +
+
+ cost: +
+ +
+ + +
+
+ AWBNumber: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string",
+  "cost": {
+    "code": "string",
+    "value": "number"
+  },
+  "AWBNumber": "string"
+}
+
+ + +
+
+
+
+
+

+ ShippingMethod: object + +

+
+
+
+
+
+ provider: +
+
+ String +
+
+ +
+
+ service: +
+
+ String +
+
+ +
+
+ cost: +
+
+ Int +
+
+ +
+
+ price: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "provider": "string",
+  "service": "string",
+  "cost": "number",
+  "price": {
+    "currencyCode": "string",
+    "amount": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ ShippingService: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+ isAutoAWB: +
+
+ Boolean +
+
+ +
+
+ useInsurance: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "isActive": "boolean",
+  "isAutoAWB": "boolean",
+  "useInsurance": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ShippingServiceInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of the shipping service.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

The name of the shipping service.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the shipping service is active or not.

+
+
+ isAutoAWB: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the airway bill is automatic or not.

+
+
+ useInsurance: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the shipping used insurance or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "name": "string",
+  "isActive": "boolean",
+  "isAutoAWB": "boolean",
+  "useInsurance": "boolean"
+}
+
+ + +
+
+
+
+
+

+ SignedUrl: object + +

+
+
+
+
+
+ url: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "url": "string"
+}
+
+ + +
+
+
+
+
+

+ SingleUploadFromURLInput: object + +

+
+
+
+
+
+ url: +
+
+ String +
+
+ + +
+
+ bucket: +
+ +
+ + +
+
+ uploadType: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "url": "string",
+  "bucket": "string",
+  "uploadType": "string"
+}
+
+ + +
+
+
+
+
+

+ SingleUploadInput: object + +

+
+
+
+
+
+ file: +
+
+ Upload +
+
+ + +
+
+ bucket: +
+ +
+ + +
+
+ contentType: +
+
+ String +
+
+ + +
+
+ uploadType: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "file": "object",
+  "bucket": "string",
+  "contentType": "string",
+  "uploadType": "string"
+}
+
+ + +
+
+
+
+
+

+ Site: object + +

+
+
+
+
+
+ id: +
+
+ ID +
+
+ + +
+
+ host: +
+
+ String +
+
+ + +
+
+ fqdn: +
+
+ String +
+
+ +
+
+ template: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+ currencyCode: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "id": "object",
+  "host": "string",
+  "fqdn": "string",
+  "template": "string",
+  "language": "string",
+  "currencyCode": "string",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ SiteConfig: object + +

+
+
+
+
+
+ siteId: +
+
+ ID +
+
+ +
+
+ host: +
+
+ String +
+
+ +
+
+ fqdn: +
+
+ String +
+
+ +
+
+ template: +
+
+ String +
+
+ +
+
+ themeSettings: +
+ +
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "siteId": "object",
+  "host": "string",
+  "fqdn": "string",
+  "template": "string",
+  "themeSettings": {
+    "faviconURL": "string",
+    "backgroundURL": "string",
+    "twitterURL": "string",
+    "youtubeURL": "string",
+    "facebookURL": "string",
+    "instagramURL": "string",
+    "storeName": "string",
+    "siteTitle": "string",
+    "siteDescription": "string",
+    "logoURL": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ SmsDestinationInput: object + +

+
+
+
+
+
+ phoneNumber: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phoneNumber": "string"
+}
+
+ + +
+
+
+
+
+

+ SmsTemplateInputV2: object + +

+
+
+
+
+
+ buyer: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+ seller: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyer": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  },
+  "isActive": "boolean",
+  "seller": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ SmsTemplateSpecV2: object + +

+
+
+
+
+
+ targetPhoneNumbers: +
+
+ String +
+
+ +
+
+ translations: +
+
+ SmsTranslationInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "targetPhoneNumbers": [
+    "string"
+  ],
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SmsTranslationInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ body: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "body": "string"
+}
+
+ + +
+
+
+
+ +
+

+ SocialMediaLinkInput: object + +

+
+
+
+
+
+ twitter: +
+
+ String +
+
+ +
+
+

Twitter social media link.

+
+
+ facebook: +
+
+ String +
+
+ +
+
+

Facebook social media link.

+
+
+ instagram: +
+
+ String +
+
+ +
+
+

Instagram social media link.

+
+
+ youtube: +
+
+ String +
+
+ +
+
+

Youtube social media link.

+
+
+ tiktok: +
+
+ String +
+
+ +
+
+

Tiktok social media link.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "twitter": "string",
+  "facebook": "string",
+  "instagram": "string",
+  "youtube": "string",
+  "tiktok": "string"
+}
+
+ + +
+
+
+
+ +
+

+ SocmedSetting: object + +

+
+
+
+
+
+ instagramToken: +
+
+ String +
+
+ +
+
+ socmedLink: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "instagramToken": "string",
+  "socmedLink": {
+    "twitter": "string",
+    "facebook": "string",
+    "instagram": "string",
+    "youtube": "string",
+    "tiktok": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ SocmedSettingInput: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string"
+}
+
+ + +
+
+
+
+
+

+ SortCoupon: string + +

+
+
+
+
+
+
object
+ + ID + + +
+
+
+
object
+ + TITLE + + +
+
+
+
object
+ + START_DATE + + +
+
+
+
+
+
+
+
+

+ SortEximHistory: string + +

+
+
+
+
+
+
object
+ + ID + + +
+
+
+
object
+ + EMAIL + + +
+
+
+
object
+ + CHANNEL + + +
+
+
+
object
+ + BRAND_ID + + +
+
+
+
object
+ + PERCENT_PROGRESS + + +
+
+
+
object
+ + RECORDS + + +
+
+
+
object
+ + UPLOAD_AT + + +
+
+
+
+
+
+
+
+

+ SortInput: object + +

+
+
+
+
+
+ fieldName: +
+
+ String +
+
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ StatusAnalytics: object + +

+
+
+
+
+
+ status: +
+
+ Boolean +
+
+ + +
+
+ message: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "status": "boolean",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ StatusInput: object + +

+
+
+
+
+
+ notes: +
+
+ String +
+
+ +
+
+

Notes for those order IDs.

+
+
+ orderIDs: +
+
+ String +
+
+ +
+
+

List of order IDs to be set.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "notes": "string",
+  "orderIDs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ StatusUpsert: object + +

+
+
+
+
+
+ status: +
+
+ Boolean +
+
+ + +
+
+ message: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "status": "boolean",
+  "message": "string"
+}
+
+ + +
+
+
+
+
+

+ Stock: object + +

+
+
+
+
+
+ SKU: +
+
+ ID +
+
+ + +
+
+ quantity: +
+
+ Int +
+
+ + +
+
+ ignoreStock: +
+
+ Boolean +
+
+ +
+
+ brandId: +
+
+ ID +
+
+ +
+
+ channelId: +
+
+ String +
+
+ +
+
+ warehouseId: +
+
+ String +
+
+ +
+
+ sku: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "object",
+  "quantity": "number",
+  "ignoreStock": "boolean",
+  "brandId": "object",
+  "channelId": "string",
+  "warehouseId": "string",
+  "sku": "string"
+}
+
+ + +
+
+
+
+
+

+ StockPerWarehouse: object + +

+
+
+
+
+
+ warehouseID: +
+
+ ID +
+
+ +
+
+ SKU: +
+
+ ID +
+
+ +
+
+ quantity: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "warehouseID": "object",
+  "SKU": "object",
+  "quantity": "number"
+}
+
+ + +
+
+
+
+
+

+ Stocks: object + +

+
+
+
+
+
+ stocks: +
+
+ Stock +
+
+ +
+
+ total: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "stocks": [
+    {
+      "SKU": "object",
+      "quantity": "number",
+      "ignoreStock": "boolean",
+      "brandId": "object",
+      "channelId": "string",
+      "warehouseId": "string",
+      "sku": "string"
+    }
+  ],
+  "total": "number"
+}
+
+ + +
+
+
+
+
+

+ StocksInfo: object + +

+
+
+
+
+
+ warehouses: +
+
+ StockPerWarehouse +
+
+ +
+
+ total: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "warehouses": [
+    {
+      "warehouseID": "object",
+      "SKU": "object",
+      "quantity": "number"
+    }
+  ],
+  "total": "number"
+}
+
+ + +
+
+
+
+
+

+ StoreCart: object + +

+
+
+
+
+
+ billingAddress: +
+ +
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ discount: +
+
+ Money +
+
+ +
+
+ ID: +
+
+ String +
+
+ +
+
+ deliveryAddress: +
+ +
+ +
+
+ lineItems: +
+
+ CartLineItem +
+
+ +
+
+ memberID: +
+
+ String +
+
+ +
+
+ memberLevel: +
+
+ String +
+
+ +
+
+ payment: +
+ +
+ +
+
+ shipping: +
+ +
+ +
+
+ totalCost: +
+
+ Money +
+
+ +
+
+ promo: +
+
+ CartPromo +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "billingAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string",
+    "location": {
+      "country": "string",
+      "province": "string",
+      "city": "string",
+      "district": "string"
+    }
+  },
+  "brandID": "string",
+  "discount": {
+    "code": "string",
+    "value": "number"
+  },
+  "ID": "string",
+  "deliveryAddress": {
+    "districtCode": "string",
+    "email": "string",
+    "name": "string",
+    "phone": "string",
+    "postalCode": "string",
+    "street": "string",
+    "location": {
+      "country": "string",
+      "province": "string",
+      "city": "string",
+      "district": "string"
+    }
+  },
+  "lineItems": [
+    {
+      "imageURL": "string",
+      "price": {
+        "code": "string",
+        "value": "number"
+      },
+      "quantity": "number",
+      "SKU": "string",
+      "title": "string",
+      "availableStock": "number",
+      "ignoreStock": "boolean",
+      "errorMessage": "string",
+      "discount": {
+        "code": "string",
+        "value": "number"
+      },
+      "slug": "string",
+      "salePrice": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ],
+  "memberID": "string",
+  "memberLevel": "string"
+}
+
+ + +
+
+
+
+
+

+ StoreSettings: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ StoreSettingsInput: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ String: string + +

+
+
+
+

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

+
+
+
+
+
+

+ StringValueParameter: object + +

+
+
+
+
+
+ key: +
+
+ String +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "string",
+  "name": "string"
+}
+
+ + +
+
+
+
+
+

+ SubCartIDInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string"
+}
+
+ + +
+
+
+
+
+

+ SubChatQueueInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string"
+}
+
+ + +
+
+
+
+
+

+ SubmitProductReviewByCustomerInput: object + +

+
+
+
+
+
+ specs: +
+
+ SubmitProductReviewByCustomerSpec +
+
+ +
+
+

Specifications for submitting product review.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "productID": "object",
+      "rating": "number",
+      "review": "string",
+      "imageURLs": [
+        "string"
+      ],
+      "videoURLs": [
+        "string"
+      ],
+      "reviewerName": "string",
+      "reviewerEmail": "string",
+      "orderID": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ SubmitProductReviewByCustomerSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+

Review ID

+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID for the product review

+
+
+ productID: +
+
+ ID +
+
+ + +
+
+

Product ID for the review

+
+
+ rating: +
+
+ Int +
+
+ + +
+
+

Rating in the review

+
+
+ review: +
+
+ String +
+
+ +
+
+

Review's content

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+

Review's image(s)

+
+
+ videoURLs: +
+
+ String +
+
+ +
+
+

Review's video(s)

+
+
+ reviewerName: +
+
+ String +
+
+ + +
+
+

Reviewer's name

+
+
+ reviewerEmail: +
+
+ String +
+
+ + +
+
+

Reviewer's email

+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

Order ID for the review

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "productID": "object",
+  "rating": "number",
+  "review": "string",
+  "imageURLs": [
+    "string"
+  ],
+  "videoURLs": [
+    "string"
+  ],
+  "reviewerName": "string",
+  "reviewerEmail": "string",
+  "orderID": "string"
+}
+
+ + +
+
+
+
+
+

+ Subscription: object + +

+
+
+
+
+
+ notification: +
+ +
+ +
+
+ message: +
+
+ message +
+
+ +
+
+ chatQueue: +
+
+ ChatQueue +
+
+ +
+
+ profileUpdateStatus: +
+ +
+ +
+
+ cartID: +
+
+ ChatCart +
+
+ +
+
+ buyer: +
+
+ Buyer +
+
+ +
+
+ adminNotification: +
+ +
+ +
+
+ cart: +
+
+ Cart +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "notification": {
+    "key": "string",
+    "value": "string",
+    "ID": "string",
+    "buyer": "string",
+    "seller": "string"
+  },
+  "message": {
+    "to": "string",
+    "from": "string",
+    "timestamp": "string",
+    "buyer_name": "string",
+    "message": "string",
+    "id": "object",
+    "message_id": "object",
+    "gql_id": "object",
+    "type": "string",
+    "status": "string",
+    "context_id": "string",
+    "caption": "string",
+    "meta": [
+      {
+        "gql_id": "string",
+        "key": "string",
+        "value": "string"
+      }
+    ],
+    "channel": "string"
+  },
+  "chatQueue": {
+    "action": "string",
+    "buyerId": "string",
+    "channel": "string",
+    "sellerId": "string",
+    "queueCount": "number"
+  },
+  "profileUpdateStatus": {
+    "errorMessage": "string",
+    "action": "string"
+  },
+  "cartID": {
+    "sellerId": "string",
+    "buyerId": "string",
+    "cartId": "string"
+  },
+  "buyer": {
+    "id": "object",
+    "name": "string",
+    "channel": "string",
+    "isRead": "boolean",
+    "lastMessage": "string",
+    "lastAlert": "string",
+    "timestamp": "number",
+    "type": "string",
+    "lastMessageId": "number",
+    "isArchived": "boolean",
+    "createdAt": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ Tenant: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ name: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ + +
+
+ currencyCode: +
+
+ String +
+
+ + +
+
+ brands: +
+ +
+ +
+
+

Query all brands within tenant

+
+
+ orders: +
+ +
+ +
+
+

Query order within tenant.

+

"'query' is prioritized, 'filter' is only used if 'query' is not specfied"

+
+
+ products: +
+ +
+ +
+
+

Query products within brands related to specified tenant.

+

'query' is prioritized, 'filter' is only used if 'query' is not specfied

+
+
+ warehouses: +
+ +
+ +
+
+

Query warehouses for tenant

+
+
+ productExcelResult: +
+
+ ExcelFile +
+
+ +
+
+

Field to fetch result file from exportProductExcel

+
+
+ orderExcelResult: +
+
+ ExcelFile +
+
+ +
+
+

Field to fetch result file from exportOrderExcel

+
+
+ exchangePointSetting: +
+ +
+ +
+
+

Query loyalty point settings.

+

'query' is prioritized, 'filter' is only used if 'query' is not specfied

+
+
+ admins: +
+ +
+ +
+
+

List of admins of the tenant

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "name": "string",
+  "language": "string",
+  "currencyCode": "string",
+  "brands": {
+    "items": [
+      {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {
+                                  "ID": "object",
+                                  "name": "string",
+                                  "language": "string",
+                                  "currencyCode": "string",
+                                  "brands": {
+                                    "items": [
+                                      {
+                                        "ID": "string"
+                                      }
+                                    ]
+                                  }
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ Testimonial: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ +
+
+ brandID: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ author: +
+
+ String +
+
+ +
+
+ company: +
+
+ String +
+
+ +
+
+ website: +
+
+ String +
+
+ +
+
+ memberID: +
+
+ String +
+
+ +
+
+ productID: +
+
+ String +
+
+ +
+
+ title: +
+
+ String +
+
+ +
+
+ content: +
+
+ String +
+
+ +
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ rating: +
+
+ Int +
+
+ +
+
+ createdAt: +
+
+ Int +
+
+ +
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ isFeatured: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "brandID": "string",
+  "email": "string",
+  "author": "string",
+  "company": "string",
+  "website": "string",
+  "memberID": "string",
+  "productID": "string",
+  "title": "string",
+  "content": "string",
+  "imageURLs": [
+    "string"
+  ],
+  "rating": "number",
+  "createdAt": "number",
+  "updatedAt": "number",
+  "published": "boolean",
+  "isFeatured": "boolean"
+}
+
+ + +
+
+
+
+
+

+ TestimonialFilterInput: object + +

+
+
+
+
+
+ published: +
+
+ Boolean +
+
+ +
+
+ isFeatured: +
+
+ Boolean +
+
+ +
+
+ productID: +
+
+ String +
+
+ +
+
+ rating: +
+
+ Int +
+
+ +
+
+ createdSince: +
+
+ Int +
+
+ +
+
+ createdUntil: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "published": "boolean",
+  "isFeatured": "boolean",
+  "productID": "string",
+  "rating": "number",
+  "createdSince": "number",
+  "createdUntil": "number"
+}
+
+ + +
+
+
+
+
+

+ TextIntent: object + +

+
+
+
+
+
+ intent: +
+
+ String +
+
+ +
+
+ textResponse: +
+
+ String +
+
+ +
+
+ isFinalState: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "intent": "string",
+  "textResponse": "string",
+  "isFinalState": "boolean"
+}
+
+ + +
+
+
+
+
+

+ ThemeSettings: object + +

+
+
+
+
+
+ faviconURL: +
+
+ String +
+
+ +
+
+ backgroundURL: +
+
+ String +
+
+ +
+
+ twitterURL: +
+
+ String +
+
+ +
+
+ youtubeURL: +
+
+ String +
+
+ +
+
+ facebookURL: +
+
+ String +
+
+ +
+
+ instagramURL: +
+
+ String +
+
+ +
+
+ storeName: +
+
+ String +
+
+ +
+
+ siteTitle: +
+
+ String +
+
+ +
+
+ siteDescription: +
+
+ String +
+
+ +
+
+ logoURL: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "faviconURL": "string",
+  "backgroundURL": "string",
+  "twitterURL": "string",
+  "youtubeURL": "string",
+  "facebookURL": "string",
+  "instagramURL": "string",
+  "storeName": "string",
+  "siteTitle": "string",
+  "siteDescription": "string",
+  "logoURL": "string"
+}
+
+ + +
+
+
+
+
+

+ Timestamp: object + +

+
+
+
+

The javascript Date as integer. Type represents date and time as number of milliseconds from start of UNIX epoch.

+
+
+
+
+
Example
+ + + + 
object
+
+ + +
+
+
+
+
+

+ Transaction: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ order: +
+
+ Order +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "order": {
+    "ID": "string",
+    "brandID": "object",
+    "channelID": "string",
+    "brand": {
+      "ID": "string",
+      "name": "string",
+      "tenantID": "string",
+      "tenant": {
+        "ID": "object",
+        "name": "string",
+        "language": "string",
+        "currencyCode": "string",
+        "brands": {
+          "items": [
+            {
+              "ID": "string",
+              "name": "string",
+              "tenantID": "string",
+              "tenant": {
+                "ID": "object",
+                "name": "string",
+                "language": "string",
+                "currencyCode": "string",
+                "brands": {
+                  "items": [
+                    {
+                      "ID": "string",
+                      "name": "string",
+                      "tenantID": "string",
+                      "tenant": {
+                        "ID": "object",
+                        "name": "string",
+                        "language": "string",
+                        "currencyCode": "string",
+                        "brands": {
+                          "items": [
+                            {
+                              "ID": "string",
+                              "name": "string",
+                              "tenantID": "string",
+                              "tenant": {
+                                "ID": "object",
+                                "name": "string",
+                                "language": "string",
+                                "currencyCode": "string",
+                                "brands": {
+                                  "items": [
+                                    {
+                                      "ID": "string"
+                                    }
+                                  ]
+                                }
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ TranslatableAttributeInput: object + +

+
+
+
+
+
+ sortIndex: +
+
+ Int +
+
+ + +
+
+

Sort index of product's translatable attribute.

+
+
+ translations: +
+
+ ProductTranslationAttributeInput +
+
+ +
+
+

Translations for translatable attribute.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "sortIndex": "number",
+  "translations": [
+    {
+      "key": "string",
+      "value": "string",
+      "language": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ TranslatableDetailInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the translatable product detail.

+
+
+ description: +
+
+ String +
+
+ + +
+
+

Description of the product's detail.

+
+
+ language: +
+
+ String +
+
+ + +
+
+

Language of the product's detail. Should be a code and capitalized (e.g: 'ID' / 'EN').

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "description": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ TranslatableSEOInput: object + +

+
+
+
+
+
+ title: +
+
+ String +
+
+ + +
+
+

Title for the translatable search engine optimation.

+
+
+ description: +
+
+ String +
+
+ + +
+
+

Description for the SEO.

+
+
+ keywords: +
+
+ String +
+
+ +
+
+

Keywords for the SEO.

+
+
+ language: +
+
+ String +
+
+ + +
+
+

Language of the SEO. Should be a code and capitalized (e.g: 'ID' / 'EN').

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "title": "string",
+  "description": "string",
+  "keywords": [
+    "string"
+  ],
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ TranslatableText: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ text: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ TranslatableTextInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+

Language of the translatable text. Should be a code and capitalized (e.g: 'ID' / 'EN').

+
+
+ text: +
+
+ String +
+
+ + +
+
+

The text for the translatable text.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ TranslationInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ +
+
+

Language code for the translation (e.g: 'ID' / 'EN').

+
+
+ text: +
+
+ String +
+
+ +
+
+

The text of the translation.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "text": "string"
+}
+
+ + +
+
+
+
+
+

+ UniversalAnalytics: object + +

+
+
+
+
+
+ trackingId: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "trackingId": "string"
+}
+
+ + +
+
+
+
+
+

+ UniversalAnalyticsInput: object + +

+
+
+
+
+
+ trackingId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "trackingId": "string"
+}
+
+ + +
+
+
+
+
+

+ UniversalAnalyticsSetting: object + +

+
+
+
+
+
+ trackingId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "trackingId": "string"
+}
+
+ + +
+
+
+
+
+

+ UniversalAnalyticsSettingInput: object + +

+
+
+
+
+
+ trackingId: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "trackingId": "string"
+}
+
+ + +
+
+
+
+
+

+ UnlinkGoogleAdsAccountInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ UnlinkGoogleMerchantAccountInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

The ID of the brand.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ UnpublishTestimonialsInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of testimonial IDs to be unpublished.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpdateAdminInput: object + +

+
+
+
+
+
+ spec: +
+
+ UpdateAdminSpec +
+
+ +
+
+

List of spec of admin to be updated

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "spec": [
+    {
+      "accountID": "string",
+      "adminSpec": {
+        "info": {
+          "email": "string",
+          "phone": "string",
+          "name": "string",
+          "tenantID": "string",
+          "brandIDs": [
+            "string"
+          ],
+          "allBrand": "boolean"
+        },
+        "permission": {
+          "actions": [
+            "string"
+          ],
+          "allAction": "boolean"
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpdateAdminSpec: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+ adminSpec: +
+
+ AdminSpec +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "adminSpec": {
+    "info": {
+      "email": "string",
+      "phone": "string",
+      "name": "string",
+      "tenantID": "string",
+      "brandIDs": [
+        "string"
+      ],
+      "allBrand": "boolean"
+    },
+    "permission": {
+      "actions": [
+        "string"
+      ],
+      "allAction": "boolean"
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ UpdateBusinessHoursInput: object + +

+
+
+
+
+
+ sellerID: +
+
+ ID +
+
+ + +
+
+ specs: +
+
+ UpdateBusinessHoursSpecInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerID": "object",
+  "specs": [
+    {
+      "day": "number",
+      "openAt": "string",
+      "closeAt": "string",
+      "isOpen": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpdateBusinessHoursSpecInput: object + +

+
+
+
+
+
+ day: +
+
+ Int +
+
+ + +
+
+ openAt: +
+
+ String +
+
+ + +
+
+ closeAt: +
+
+ String +
+
+ + +
+
+ isOpen: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "day": "number",
+  "openAt": "string",
+  "closeAt": "string",
+  "isOpen": "boolean"
+}
+
+ + +
+
+
+
+
+

+ UpdateOrderStatusParam: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+ status: +
+ +
+ + +
+
+ messages: +
+
+ String +
+
+ +
+
+ awb: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "status": "string",
+  "messages": "string",
+  "awb": "string"
+}
+
+ + +
+
+
+
+
+

+ UpdateProductReviewStatusInput: object + +

+
+
+
+
+
+ specs: +
+
+ UpdateProductReviewStatusSpec +
+
+ +
+
+

Specifications for updating product review status

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "status": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpdateProductReviewStatusRes: object + +

+
+
+
+
+
+ failedUpdateIDs: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "failedUpdateIDs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpdateProductReviewStatusSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID for the product review

+
+
+ status: +
+ +
+ + +
+
+

Product review's status

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "status": "string"
+}
+
+ + +
+
+
+
+
+

+ UpdateProductStockAndPriceInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this product in.

+
+
+ specs: +
+
+ UpdateProductStockAndPriceSpecInput +
+
+ +
+
+

Specifications for updating product stock and price.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "productID": "string",
+      "basePrices": [
+        {
+          "code": "string",
+          "value": "number"
+        }
+      ],
+      "currentStock": "number",
+      "stock": "number",
+      "ignoreCurrentStock": "boolean",
+      "ignoreStock": "boolean",
+      "warehouseID": "string",
+      "SKU": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpdateProductStockAndPriceResultSpec: object + +

+
+
+
+
+
+ productID: +
+
+ String +
+
+ +
+
+

Updated product ID information.

+
+
+ SKU: +
+
+ String +
+
+ +
+
+

Updated SKU information

+
+
+ updatePriceError: +
+
+ String +
+
+ +
+
+

Error in price that occured when executing the mutation.

+
+
+ updateStockError: +
+
+ String +
+
+ +
+
+

Error in stock that occured when executing the mutation.

+
+
+ warehouseID: +
+
+ String +
+
+ +
+
+

Updated warehouse ID information.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "productID": "string",
+  "SKU": "string",
+  "updatePriceError": "string",
+  "updateStockError": "string",
+  "warehouseID": "string"
+}
+
+ + +
+
+
+
+
+

+ UpdateProductStockAndPriceSpecInput: object + +

+
+
+
+
+
+ productID: +
+
+ String +
+
+ + +
+
+

product ID that will be updated,

+
+
+ basePrices: +
+
+ MoneyInput +
+
+ +
+
+

Base prices for updating product.

+
+
+ currentStock: +
+
+ Int +
+
+ +
+
+

current sku stock

+
+
+ stock: +
+
+ Int +
+
+ + +
+
+ ignoreCurrentStock: +
+
+ Boolean +
+
+ +
+
+

ignore current stock.

+

set to 'true' to check the current stock in inventory and add / subtract based on 'stock' field

+

set to 'false' to set current stock as defined in 'stock' field

+
+
+ ignoreStock: +
+
+ Boolean +
+
+ +
+
+

ignore stock

+

set to 'true' to make stock always available set to 'false' then the stock depend on the quantity of product

+
+
+ warehouseID: +
+
+ String +
+
+ +
+
+

specific warehouse for product to be upserted

+
+
+ SKU: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "productID": "string",
+  "basePrices": [
+    {
+      "code": "string",
+      "value": "number"
+    }
+  ],
+  "currentStock": "number",
+  "stock": "number",
+  "ignoreCurrentStock": "boolean",
+  "ignoreStock": "boolean",
+  "warehouseID": "string",
+  "SKU": "string"
+}
+
+ + +
+
+
+
+
+

+ Upload: object + +

+
+
+
+
+
Example
+ + + + 
object
+
+ + +
+
+
+
+
+

+ UploadDocumentInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+ signerID: +
+
+ String +
+
+ + +
+
+ documentName: +
+
+ String +
+
+ + +
+
+ documentUrl: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "signerID": "string",
+  "documentName": "string",
+  "documentUrl": "string"
+}
+
+ + +
+
+
+
+
+

+ UploadDocumentResponse: object + +

+
+
+
+
+
+ documentId: +
+
+ String +
+
+ +
+
+ documentUrl: +
+
+ String +
+
+ +
+
+ documentToken: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "documentId": "string",
+  "documentUrl": "string",
+  "documentToken": "string"
+}
+
+ + +
+
+
+
+
+

+ UploadType: string + +

+
+
+
+
+
+
object
+ + ACCOUNT + + +
+
+
+
object
+ + ARTICLE_CATEGORY + + +
+
+
+
object
+ + ARTICLE + + +
+
+
+
object
+ + BANNER + + +
+
+
+
object
+ + BRAND + + +
+
+
+
object
+ + COLLECTION + + +
+
+
+
object
+ + LINKSPAGE + + +
+
+
+
object
+ + LOOKBOOK + + +
+
+
+
object
+ + LOOKBOOK_IMAGE + + +
+
+
+
object
+ + ORDER + + +
+
+
+
object
+ + PAYMENT + + +
+
+
+
object
+ + PAYMENT_CONFIRMATION + + +
+
+
+
object
+ + PRODUCT + + +
+
+
+
object
+ + PRODUCT_VARIANT + + +
+
+
+
object
+ + PROMOTION + + +
+
+
+
object
+ + TENANT + + +
+
+
+
object
+ + TESTIMONIAL + + +
+
+
+
object
+ + TEXT_EDITOR_IMAGE + + +
+
+
+
object
+ + SETTING + + +
+
+
+
object
+ + REVIEW + + +
+
+
+
+
+
+
+
+

+ UpsertAdminInput: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+

Account ID of the admin to be upserted.

+
+
+ spec: +
+ +
+ + +
+
+

Specification for admin upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "spec": {
+    "tenantID": "string",
+    "basicInfo": {
+      "email": "string",
+      "firstName": "string",
+      "lastName": "string",
+      "gender": "string",
+      "phone": "string",
+      "dateOfBirth": "number"
+    },
+    "addresses": [
+      {
+        "addressLabel": "string",
+        "contactName": "string",
+        "districtCode": "string",
+        "street": "string",
+        "latitude": "string",
+        "longitude": "string",
+        "postalCode": "string",
+        "isPrimary": "boolean"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertAdminSpec: object + +

+
+
+
+
+
+ tenantID: +
+
+ String +
+
+ + +
+
+

Assigned tenant ID of this admin.

+
+
+ basicInfo: +
+
+ BasicInfo +
+
+ +
+
+

Basic Information about the admin.

+
+
+ addresses: +
+
+ AdminAddressInput +
+
+ +
+
+

Address of this admin.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "tenantID": "string",
+  "basicInfo": {
+    "email": "string",
+    "firstName": "string",
+    "lastName": "string",
+    "gender": "string",
+    "phone": "string",
+    "dateOfBirth": "number"
+  },
+  "addresses": [
+    {
+      "addressLabel": "string",
+      "contactName": "string",
+      "districtCode": "string",
+      "street": "string",
+      "latitude": "string",
+      "longitude": "string",
+      "postalCode": "string",
+      "isPrimary": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertAnalyticsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this Analytics in.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object"
+}
+
+ + +
+
+
+
+
+

+ UpsertAnalyticsSettingInput: object + +

+
+
+
+
+
+ brandId: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this Analytics in.

+
+
+ facebookSetting: +
+ +
+ +
+
+ googleSetting: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "object",
+  "facebookSetting": {
+    "pixelId": "string",
+    "catalogId": "string",
+    "accessToken": "string"
+  },
+  "googleSetting": {
+    "universalAnalytics": {
+      "trackingId": "string"
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertArticleCategoriesInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Upsert article categories in which brand ID?

+
+
+ specs: +
+
+ UpsertArticleCategoriesSpec +
+
+ +
+
+

Specifications for updating/inserting article categories.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "imageURL": "string",
+      "translations": [
+        {
+          "language": "string",
+          "name": "string"
+        }
+      ],
+      "isActive": "boolean",
+      "SEOs": [
+        {
+          "language": "string",
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ]
+        }
+      ],
+      "displayType": "string",
+      "slug": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertArticleCategoriesSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of an existing article category to be updated/inserted. Omit this to create new article category

+
+
+ imageURL: +
+
+ String +
+
+ + +
+
+

Image URL to be rendered in this article category.

+
+
+ translations: +
+
+ ArticleCategoryTranslationInput +
+
+ +
+
+

Article category's translations.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether the article category is active or not.

+
+
+ SEOs: +
+
+ SEOInput +
+
+ +
+
+

Article category's search engine optimations.

+
+
+ displayType: +
+ +
+ + +
+
+

Article category's display type.

+
+
+ slug: +
+
+ String +
+
+ + +
+
+

Article category's slug.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "imageURL": "string",
+  "translations": [
+    {
+      "language": "string",
+      "name": "string"
+    }
+  ],
+  "isActive": "boolean",
+  "SEOs": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ]
+    }
+  ],
+  "displayType": "string",
+  "slug": "string"
+}
+
+ + +
+
+
+
+
+

+ UpsertArticlesInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this article in.

+
+
+ specs: +
+
+ UpsertArticlesSpec +
+
+ +
+
+

Specifications for articles upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "categoryID": "object",
+      "slug": "string",
+      "descriptions": [
+        {
+          "language": "string",
+          "title": "string",
+          "content": "string"
+        }
+      ],
+      "SEOs": [
+        {
+          "language": "string",
+          "title": "string",
+          "description": "string",
+          "keywords": [
+            "string"
+          ]
+        }
+      ],
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertArticlesSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of an existing article to be updated/inserted. Omit this to create a new article

+
+
+ categoryID: +
+
+ ID +
+
+ + +
+
+

Category ID to put this article in.

+
+
+ slug: +
+
+ String +
+
+ + +
+
+

Slug for this article.

+
+
+ descriptions: +
+
+ ArticleDescriptionInput +
+
+ +
+
+

Descriptions for this article.

+
+
+ SEOs: +
+
+ SEOInput +
+
+ +
+
+

Article's search engine optimations.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether the article is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "categoryID": "object",
+  "slug": "string",
+  "descriptions": [
+    {
+      "language": "string",
+      "title": "string",
+      "content": "string"
+    }
+  ],
+  "SEOs": [
+    {
+      "language": "string",
+      "title": "string",
+      "description": "string",
+      "keywords": [
+        "string"
+      ]
+    }
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ UpsertBirthdayCouponsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this birthday coupon in.

+
+
+ specs: +
+
+ UpsertBirthdayCouponsSpec +
+
+ +
+
+

Specifications for birthday coupons upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "code": "string",
+      "title": "string",
+      "isActive": "boolean",
+      "salesChannel": "string",
+      "discountValue": {
+        "moneyValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "scalarValue": "number",
+        "maximumDiscountValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "discountType": "string",
+        "discountField": "string"
+      },
+      "validityPeriod": "number",
+      "minimumPurchase": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertBirthdayCouponsSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a birthday coupon to be updated/inserted. Omit this to create a new coupon.

+
+
+ code: +
+
+ String +
+
+ + +
+
+

The code of this birthday coupon.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of this birthday coupon.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the birthday coupon is active or not.

+
+
+ salesChannel: +
+
+ String +
+
+ + +
+
+

The marketplace to use this birthday coupon.

+
+
+ discountValue: +
+ +
+ + +
+
+

Specifications for discount value when upserting birthday coupons.

+
+
+ validityPeriod: +
+
+ Int +
+
+ +
+
+

A value to set the validity period of the birthday coupon.

+
+
+ minimumPurchase: +
+ +
+ + +
+
+

Minimum purchase when using birthday coupon.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "code": "string",
+  "title": "string",
+  "isActive": "boolean",
+  "salesChannel": "string",
+  "discountValue": {
+    "moneyValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "scalarValue": "number",
+    "maximumDiscountValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "discountType": "string",
+    "discountField": "string"
+  },
+  "validityPeriod": "number",
+  "minimumPurchase": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertBrandInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

Brand ID to be upserted.

+
+
+ tenantID: +
+
+ String +
+
+ + +
+
+

Tenant ID to put this brand in.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of this brand.

+
+
+ logoURL: +
+
+ String +
+
+ +
+
+

URL of this brand's logo.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this brand is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "tenantID": "string",
+  "name": "string",
+  "logoURL": "string",
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ UpsertBuyMinAmountGetFreeItemsBundleInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this bundle in.

+
+
+ bundles: +
+
+ BuyMinAmountGetFreeItemsBundleInput +
+
+ +
+
+

Specifications for bundle upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "bundles": [
+    {
+      "ID": "string",
+      "title": "string",
+      "startTime": "number",
+      "endTime": "number",
+      "isActive": "boolean",
+      "priority": "number",
+      "minAmountToBuy": {
+        "code": "string",
+        "value": "number"
+      },
+      "eligibleProductIDs": [
+        "string"
+      ],
+      "bundledProducts": [
+        {
+          "ID": "string",
+          "price": {
+            "code": "string",
+            "value": "number"
+          },
+          "quantity": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertBuyMinQuantityGetFreeItemsBundleInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this bundle in.

+
+
+ bundles: +
+
+ BuyMinQuantityGetFreeItemsBundleInput +
+
+ +
+
+

Specifications for bundle upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "bundles": [
+    {
+      "ID": "string",
+      "title": "string",
+      "startTime": "number",
+      "endTime": "number",
+      "isActive": "boolean",
+      "priority": "number",
+      "minQuantityToBuy": "number",
+      "eligibleProductIDs": [
+        "string"
+      ],
+      "bundledProducts": [
+        {
+          "ID": "string",
+          "price": {
+            "code": "string",
+            "value": "number"
+          },
+          "quantity": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertBuyNItemBundleInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this bundle in.

+
+
+ bundles: +
+
+ BuyNItemBundleInput +
+
+ +
+
+

Specifications for bundle upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "bundles": [
+    {
+      "ID": "string",
+      "title": "string",
+      "startTime": "number",
+      "endTime": "number",
+      "isActive": "boolean",
+      "priority": "number",
+      "numOfItemToBuy": "number",
+      "eligibleProductIDs": [
+        "string"
+      ],
+      "fixedPrice": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertCartCouponsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this cart coupon in.

+
+
+ specs: +
+
+ UpsertCartCouponsSpec +
+
+ +
+
+

Specifications for upserting cart coupons.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "code": "string",
+      "title": "string",
+      "isActive": "boolean",
+      "salesChannel": "string",
+      "discountValue": {
+        "moneyValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "scalarValue": "number",
+        "maximumDiscountValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "discountType": "string",
+        "discountField": "string"
+      },
+      "maximumUsageCount": "number",
+      "applicableStartTimestamp": "number",
+      "applicableEndTimestamp": "number",
+      "isMemberOnly": "boolean",
+      "allowedMemberLevels": [
+        "string"
+      ],
+      "minimumPurchase": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertCartCouponsSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a cart coupon to be updated/inserted. Omit this to create a new coupon.

+
+
+ code: +
+
+ String +
+
+ + +
+
+

The code of this cart coupon.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of this cart coupon.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this cart coupon is active or not.

+
+
+ salesChannel: +
+
+ String +
+
+ + +
+
+

The sales channel of the coupon.

+
+
+ discountValue: +
+ +
+ + +
+
+

Discount value for upserting cart coupons.

+
+
+ maximumUsageCount: +
+
+ Int +
+
+ + +
+
+

Maximum usage when using the cart coupon.

+
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ + +
+
+

A timestamp to indicate when this cart coupon is starts to be applicable.

+
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ + +
+
+

A timestamp to indicate when this cart coupon cannot be applied anymore.

+
+
+ isMemberOnly: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this coupon is limited to member only or not.

+
+
+ allowedMemberLevels: +
+
+ String +
+
+ +
+
+

Allowed member levels to use this cart coupon.

+
+
+ minimumPurchase: +
+ +
+ + +
+
+

Minimum purchase when using cart coupons.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "code": "string",
+  "title": "string",
+  "isActive": "boolean",
+  "salesChannel": "string",
+  "discountValue": {
+    "moneyValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "scalarValue": "number",
+    "maximumDiscountValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "discountType": "string",
+    "discountField": "string"
+  },
+  "maximumUsageCount": "number",
+  "applicableStartTimestamp": "number",
+  "applicableEndTimestamp": "number",
+  "isMemberOnly": "boolean",
+  "allowedMemberLevels": [
+    "string"
+  ],
+  "minimumPurchase": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertChatRoomAttributesInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ buyerId: +
+
+ String +
+
+ + +
+
+ attributes: +
+
+ ChatRoomAttributeInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "buyerId": "string",
+  "attributes": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertCouponSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a coupon to be updated/inserted. Omit this to create a new coupon.

+
+
+ code: +
+
+ String +
+
+ + +
+
+

The code of the coupon.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of the coupon.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the coupon is active or not.

+
+
+ salesChannel: +
+
+ String +
+
+ + +
+
+

The sales channel of the coupon.

+
+
+ discountValue: +
+ +
+ + +
+
+

Specifications for discount value when upserting coupons.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "code": "string",
+  "title": "string",
+  "isActive": "boolean",
+  "salesChannel": "string",
+  "discountValue": {
+    "moneyValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "scalarValue": "number",
+    "maximumDiscountValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "discountType": "string",
+    "discountField": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertDiscountsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this discount in.

+
+
+ specs: +
+
+ UpsertDiscountsSpec +
+
+ +
+
+

Specifications for upserting discounts.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "channelIDs": [
+        "object"
+      ],
+      "title": "string",
+      "startDate": "number",
+      "endDate": "number",
+      "isActive": "boolean",
+      "referenceType": "string",
+      "maxItem": "number",
+      "rows": [
+        {
+          "referenceID": "object",
+          "discountType": "string",
+          "moneyValue": {
+            "code": "string",
+            "value": "number"
+          },
+          "scalarValue": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertDiscountsRowInput: object + +

+
+
+
+
+
+ referenceID: +
+
+ ID +
+
+ + +
+
+

SKU of product

+
+
+ discountType: +
+
+ String +
+
+ + +
+
+

The type of discount. One of PERCENTAGE/FIXED/ABSOLUTE

+
+
+ moneyValue: +
+ +
+ + +
+
+

The amount of money that is granted by the discount.

+
+
+ scalarValue: +
+
+ Int +
+
+ + +
+
+

The scalar value of the discount.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "referenceID": "object",
+  "discountType": "string",
+  "moneyValue": {
+    "code": "string",
+    "value": "number"
+  },
+  "scalarValue": "number"
+}
+
+ + +
+
+
+
+
+

+ UpsertDiscountsSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a discount to be updated/inserted. Omit this to create a new discount.

+
+
+ channelIDs: +
+
+ ID +
+
+ +
+
+

ID of the discount channel.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

Title of the discount.

+
+
+ startDate: +
+
+ Int +
+
+ + +
+
+

A date to mark the start of this discount.

+
+
+ endDate: +
+
+ Int +
+
+ + +
+
+

A date to mark the end of this discount.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this discount is active or not.

+
+
+ referenceType: +
+
+ String +
+
+ + +
+
+

The type of goods that is applicable by this discount.

+
+
+ maxItem: +
+
+ Int +
+
+ + +
+
+

Maximum amount of items when using this discount.

+
+
+ rows: +
+
+ UpsertDiscountsRowInput +
+
+ +
+
+

Rows for upserting discounts.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "channelIDs": [
+    "object"
+  ],
+  "title": "string",
+  "startDate": "number",
+  "endDate": "number",
+  "isActive": "boolean",
+  "referenceType": "string",
+  "maxItem": "number",
+  "rows": [
+    {
+      "referenceID": "object",
+      "discountType": "string",
+      "moneyValue": {
+        "code": "string",
+        "value": "number"
+      },
+      "scalarValue": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertEmailTemplatesSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

Omit this to generate a new email template

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+ destinations: +
+
+ EmailDestinationInput +
+
+ +
+
+

Destinations for updating/inserting Email templates specifications.

+
+
+ translations: +
+
+ EmailTranslationInput +
+
+ +
+
+

Translations for updating/inserting Email templates specifications.

+
+
+ sendOrder: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "isActive": "boolean",
+  "destinations": [
+    {
+      "type": "string",
+      "value": "string"
+    }
+  ],
+  "translations": [
+    {
+      "body": "string",
+      "language": "string",
+      "subject": "string"
+    }
+  ],
+  "sendOrder": "number"
+}
+
+ + +
+
+
+
+
+

+ UpsertGoogleAdsCampaignInput: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ +
+
+ budget: +
+
+ Int +
+
+ +
+
+ campaignName: +
+
+ String +
+
+ +
+
+ targetRoas: +
+
+ Int +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string",
+  "budget": "number",
+  "campaignName": "string",
+  "targetRoas": "number"
+}
+
+ + +
+
+
+
+
+

+ UpsertLinkspageInput: object + +

+
+
+
+
+
+ brandId: +
+
+ String +
+
+ + +
+
+ backgroundColor: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ hexTextColor: +
+
+ String +
+
+ + +
+
+ logoImage: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ +
+
+ detailLinks: +
+
+ DetailLinksInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandId": "string",
+  "backgroundColor": "string",
+  "description": "string",
+  "hexTextColor": "string",
+  "logoImage": "string",
+  "name": "string",
+  "detailLinks": [
+    {
+      "hexBorderColor": "string",
+      "hexLabelColor": "string",
+      "iconImage": "string",
+      "id": "string",
+      "label": "string",
+      "ordering": "number",
+      "url": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertLookbookInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ + +
+
+ imageURL: +
+
+ String +
+
+ + +
+
+ name: +
+
+ String +
+
+ + +
+
+ language: +
+
+ String +
+
+ + +
+
+

Should be a code and capitalized (e.g: 'ID' / 'EN')

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "imageURL": "string",
+  "name": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ UpsertMemberAddressInput: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+

Account ID of the member to be upserted.

+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

Brand ID of this member.

+
+
+ address: +
+ +
+ + +
+
+

Address of this member.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "brandID": "string",
+  "address": {
+    "addressLabel": "string",
+    "contactName": "string",
+    "districtCode": "string",
+    "street": "string",
+    "latitude": "string",
+    "longitude": "string",
+    "postalCode": "string",
+    "isPrimary": "boolean",
+    "salesChannel": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertMemberInput: object + +

+
+
+
+
+
+ accountID: +
+
+ String +
+
+ + +
+
+

Account ID of the member to be upserted.

+
+
+ spec: +
+ +
+ + +
+
+

Specification for member upsert.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountID": "string",
+  "spec": {
+    "brandID": "string",
+    "basicInfo": {
+      "email": "string",
+      "firstName": "string",
+      "lastName": "string",
+      "gender": "string",
+      "phone": "string",
+      "dateOfBirth": "number"
+    },
+    "addresses": [
+      {
+        "addressLabel": "string",
+        "contactName": "string",
+        "districtCode": "string",
+        "street": "string",
+        "latitude": "string",
+        "longitude": "string",
+        "postalCode": "string",
+        "isPrimary": "boolean",
+        "salesChannel": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertMemberSpec: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

Member's brand ID.

+
+
+ basicInfo: +
+
+ BasicInfo +
+
+ + +
+
+

Basic information for member.

+
+
+ addresses: +
+
+ MemberAddressInput +
+
+ +
+
+

Address of this member.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "basicInfo": {
+    "email": "string",
+    "firstName": "string",
+    "lastName": "string",
+    "gender": "string",
+    "phone": "string",
+    "dateOfBirth": "number"
+  },
+  "addresses": [
+    {
+      "addressLabel": "string",
+      "contactName": "string",
+      "districtCode": "string",
+      "street": "string",
+      "latitude": "string",
+      "longitude": "string",
+      "postalCode": "string",
+      "isPrimary": "boolean",
+      "salesChannel": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertNavigationInput: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a navigation to be updated/inserted. Omit this to create a new navigation.

+
+
+ parentIDs: +
+
+ ID +
+
+ +
+
+

List IDs of this navigation parents.

+
+
+ published: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this navigation is published or not.

+
+
+ type: +
+
+ String +
+
+ +
+
+

The type of this navigation.

+
+
+ translations: +
+
+ TranslationInput +
+
+ +
+
+

Translations for upserting navigation.

+
+
+ URL: +
+
+ String +
+
+ +
+
+

The URK of this navigation.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "parentIDs": [
+    "object"
+  ],
+  "published": "boolean",
+  "type": "string",
+  "translations": [
+    {
+      "language": "string",
+      "text": "string"
+    }
+  ],
+  "URL": "string"
+}
+
+ + +
+
+
+
+
+

+ UpsertNewMemberCouponsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this new member coupon in.

+
+
+ specs: +
+
+ UpsertNewMemberCouponsSpec +
+
+ +
+
+

Specifications for upserting new member coupon.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "code": "string",
+      "title": "string",
+      "isActive": "boolean",
+      "salesChannel": "string",
+      "discountValue": {
+        "moneyValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "scalarValue": "number",
+        "maximumDiscountValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "discountType": "string",
+        "discountField": "string"
+      },
+      "validityPeriod": "number",
+      "minimumPurchase": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertNewMemberCouponsSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a new member coupon to be updated/inserted. Omit this to create a new coupon.

+
+
+ code: +
+
+ String +
+
+ + +
+
+

The code of the new member coupon.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of the new member coupon.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the new member coupon is active or not.

+
+
+ salesChannel: +
+
+ String +
+
+ + +
+
+

The sales channel of the coupon.

+
+
+ discountValue: +
+ +
+ + +
+
+

Discount value for upserting new member coupons.

+
+
+ validityPeriod: +
+
+ Int +
+
+ +
+
+

A number representing a period where this coupon is valid.

+
+
+ minimumPurchase: +
+ +
+ + +
+
+

Minimum purchase when using the coupon.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "code": "string",
+  "title": "string",
+  "isActive": "boolean",
+  "salesChannel": "string",
+  "discountValue": {
+    "moneyValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "scalarValue": "number",
+    "maximumDiscountValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "discountType": "string",
+    "discountField": "string"
+  },
+  "validityPeriod": "number",
+  "minimumPurchase": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertNewsletterSettingsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

The ID of an existing brand to be updated/inserted.

+
+
+ credential: +
+ +
+ + +
+
+

Credential detail for newsletter.

+
+
+ popup: +
+ +
+ + +
+
+

Popup detail for newsletter.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "credential": {
+    "apiKey": "string",
+    "listId": "string"
+  },
+  "popup": {
+    "content": "string",
+    "popupOnFirstVisit": "boolean"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertOrderInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

Brand ID to put this order in.

+
+
+ specs: +
+
+ UpsertSpec +
+
+ +
+
+

Specifications for upserting order input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "specs": [
+    {
+      "ID": "string",
+      "spec": {
+        "memberID": "string",
+        "invoiceID": "string",
+        "channelID": "string",
+        "discount": {
+          "code": "string",
+          "value": "number"
+        },
+        "totalCost": {
+          "code": "string",
+          "value": "number"
+        },
+        "buyerNote": "string",
+        "billingAddress": {
+          "name": "string",
+          "email": "string",
+          "phone": "string",
+          "country": "string",
+          "province": "string",
+          "city": "string",
+          "subDistrict": "string",
+          "street": "string",
+          "districtCode": "string",
+          "postalCode": "string"
+        },
+        "deliveryAddress": {
+          "name": "string",
+          "email": "string",
+          "phone": "string",
+          "country": "string",
+          "province": "string",
+          "city": "string",
+          "subDistrict": "string",
+          "street": "string",
+          "districtCode": "string",
+          "postalCode": "string"
+        },
+        "lineItems": [
+          {
+            "title": "string",
+            "SKU": "string",
+            "quantity": "number",
+            "price": {
+              "code": "string",
+              "value": "number"
+            },
+            "imageURL": "string"
+          }
+        ],
+        "shipping": {
+          "provider": "string",
+          "service": "string",
+          "cost": {}
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertPaymentAdminConfigsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID of payment admin configurations.

+
+
+ adminConfigs: +
+
+ PaymentAdminConfigInput +
+
+ +
+
+

Admin configurations for upserting payment admin configurations.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "adminConfigs": [
+    {
+      "ID": "string",
+      "providerID": "string",
+      "method": "string",
+      "configs": [
+        {
+          "name": "string",
+          "value": "string"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertPaymentEnumeratedAdminConfigsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID of payment admin configurations.

+
+
+ adminConfigs: +
+
+ PaymentAdminConfigInput +
+
+ +
+
+

Admin configurations for upserting payment admin configurations.

+
+
+ enableNegativeBankTransferUniqueCode: +
+
+ Boolean +
+
+ +
+
+

Enable negative unique code for bank transfers

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "adminConfigs": [
+    {
+      "ID": "string",
+      "providerID": "string",
+      "method": "string",
+      "configs": [
+        {
+          "name": "string",
+          "value": "string"
+        }
+      ]
+    }
+  ],
+  "enableNegativeBankTransferUniqueCode": "boolean"
+}
+
+ + +
+
+
+
+
+

+ UpsertProductCouponsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this product coupon in.

+
+
+ specs: +
+
+ UpsertProductCouponsSpec +
+
+ +
+
+

Specifications for product coupons upserting.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "code": "string",
+      "title": "string",
+      "isActive": "boolean",
+      "salesChannel": "string",
+      "discountValue": {
+        "moneyValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "scalarValue": "number",
+        "maximumDiscountValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "discountType": "string",
+        "discountField": "string"
+      },
+      "maximumUsageCount": "number",
+      "applicableSKUs": [
+        "string"
+      ],
+      "applicableStartTimestamp": "number",
+      "applicableEndTimestamp": "number",
+      "isMemberOnly": "boolean",
+      "allowedMemberLevels": [
+        "string"
+      ],
+      "minimumPurchase": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertProductCouponsSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a product coupon to be updated/inserted. Omit this to create a new coupon.

+
+
+ code: +
+
+ String +
+
+ + +
+
+

The code for this product coupon.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of this product coupon.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the product coupon is active or not.

+
+
+ salesChannel: +
+
+ String +
+
+ + +
+
+

The sales channel of the product coupon.

+
+
+ discountValue: +
+ +
+ + +
+
+

Discount value for upserting product coupons.

+
+
+ maximumUsageCount: +
+
+ Int +
+
+ + +
+
+

Maximum usage when using this product coupon.

+
+
+ applicableSKUs: +
+
+ String +
+
+ +
+
+

List of SKUs that can be used with this product coupon.

+
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ + +
+
+

A timestamp to indicate when this cart coupon is starts to be applicable.

+
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ + +
+
+

A timestamp to indicate when this cart coupon cannot be applied anymore.

+
+
+ isMemberOnly: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this coupon is limited to member only or not.

+
+
+ allowedMemberLevels: +
+
+ String +
+
+ +
+
+

Allowed member levels to use this cart coupon.

+
+
+ minimumPurchase: +
+ +
+ + +
+
+

Minimum purchase when using cart coupons.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "code": "string",
+  "title": "string",
+  "isActive": "boolean",
+  "salesChannel": "string",
+  "discountValue": {
+    "moneyValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "scalarValue": "number",
+    "maximumDiscountValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "discountType": "string",
+    "discountField": "string"
+  },
+  "maximumUsageCount": "number",
+  "applicableSKUs": [
+    "string"
+  ],
+  "applicableStartTimestamp": "number",
+  "applicableEndTimestamp": "number",
+  "isMemberOnly": "boolean",
+  "allowedMemberLevels": [
+    "string"
+  ],
+  "minimumPurchase": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertProductInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this product in.

+
+
+ specs: +
+
+ UpsertProductSpecInput +
+
+ +
+
+

Specifications for upserting product.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "details": [
+        {
+          "name": "string",
+          "description": "string",
+          "language": "string"
+        }
+      ],
+      "volume": {
+        "length": "number",
+        "height": "number",
+        "width": "number",
+        "unit": "string"
+      },
+      "weight": {
+        "value": "number",
+        "unit": "string"
+      },
+      "imageURLs": [
+        "string"
+      ],
+      "published": "boolean",
+      "variants": [
+        {
+          "SKU": "object",
+          "options": [
+            {
+              "key": "object",
+              "value": "string"
+            }
+          ],
+          "basePrices": [
+            {
+              "code": "string",
+              "value": "number"
+            }
+          ],
+          "channelIDs": [
+            "string"
+          ],
+          "attributes": [
+            {
+              "sortIndex": "number",
+              "translations": [
+                {
+                  "key": "string",
+                  "value": "string",
+                  "language": "string"
+                }
+              ]
+            }
+          ],
+          "channelAttributes": [
+            {
+              "channelID": "string",
+              "key": "object",
+              "value": "string"
+            }
+          ],
+          "imageURLs": [
+            "string"
+          ],
+          "stock": "number",
+          "warehouseID": "string",
+          "currentStock": "number",
+          "ignoreCurrentStock": "boolean",
+          "ignoreStock": "boolean"
+        }
+      ],
+      "productID": "object",
+      "slug": "string",
+      "SEOs": [
+        null
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertProductReviewInput: object + +

+
+
+
+
+
+ specs: +
+
+ UpsertProductReviewSpec +
+
+ +
+
+

Specifications for upserting product review.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "specs": [
+    {
+      "ID": "object",
+      "brandID": "object",
+      "productID": "object",
+      "imageURLs": [
+        "string"
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertProductReviewSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID for the product review

+
+
+ productID: +
+
+ ID +
+
+ + +
+
+

Product ID for the product review

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+

Image URLs for product review's image(s)

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "brandID": "object",
+  "productID": "object",
+  "imageURLs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertProductSpecInput: object + +

+
+
+
+
+
+ details: +
+
+ TranslatableDetailInput +
+
+ +
+
+

Details of the product.

+
+
+ volume: +
+ +
+ + +
+
+

Volume of the product.

+
+
+ weight: +
+ +
+ + +
+
+

Weight of the product.

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+

URL of the product's image.

+
+
+ published: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this product is published or not.

+
+
+ variants: +
+
+ VariantWithStockUpsertInput +
+
+ +
+
+

Variants of the product.

+
+
+ productID: +
+
+ ID +
+
+ +
+
+

The ID of a product to be updated/inserted. Omit this to create new product.

+
+
+ slug: +
+
+ String +
+
+ + +
+
+

Sulg of the product.

+
+
+ SEOs: +
+
+ TranslatableSEOInput +
+
+ +
+
+

Translatable SEO for the product.

+
+
+ condition: +
+
+ String +
+
+ +
+
+

Condition of the product.

+
+
+ attributes: +
+
+ TranslatableAttributeInput +
+
+ +
+
+

The product's attributes.

+
+
+ channelAttributes: +
+
+ ProductChannelAttributeInput +
+
+ +
+
+

The product's channel attributes.

+
+
+ relatedProductIds: +
+
+ ID +
+
+ +
+
+

Other products that are related to this product.

+
+
+ tagKeys: +
+
+ String +
+
+ +
+
+

Tags for this product.

+
+
+ collectionIds: +
+
+ ID +
+
+ +
+
+

List of collection IDs that have this product in them.

+
+
+ schedulePublishAt: +
+
+ Int +
+
+ +
+
+

Time when the product can be viewed.

+
+
+ scheduleOpenOrderAt: +
+
+ Int +
+
+ +
+
+

Time when the product can be ordered.

+
+
+ scheduleCloseOrderAt: +
+
+ Int +
+
+ +
+
+

Time when the product can't be ordered anymore.

+
+
+ extension: +
+ +
+ +
+
+

Product extension input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "details": [
+    {
+      "name": "string",
+      "description": "string",
+      "language": "string"
+    }
+  ],
+  "volume": {
+    "length": "number",
+    "height": "number",
+    "width": "number",
+    "unit": "string"
+  },
+  "weight": {
+    "value": "number",
+    "unit": "string"
+  },
+  "imageURLs": [
+    "string"
+  ],
+  "published": "boolean",
+  "variants": [
+    {
+      "SKU": "object",
+      "options": [
+        {
+          "key": "object",
+          "value": "string"
+        }
+      ],
+      "basePrices": [
+        {
+          "code": "string",
+          "value": "number"
+        }
+      ],
+      "channelIDs": [
+        "string"
+      ],
+      "attributes": [
+        {
+          "sortIndex": "number",
+          "translations": [
+            {
+              "key": "string",
+              "value": "string",
+              "language": "string"
+            }
+          ]
+        }
+      ],
+      "channelAttributes": [
+        {
+          "channelID": "string",
+          "key": "object",
+          "value": "string"
+        }
+      ],
+      "imageURLs": [
+        "string"
+      ],
+      "stock": "number",
+      "warehouseID": "string",
+      "currentStock": "number",
+      "ignoreCurrentStock": "boolean",
+      "ignoreStock": "boolean"
+    }
+  ],
+  "productID": "object",
+  "slug": "string",
+  "SEOs": [
+    {
+      "title": "string",
+      "description": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertSettingInput: object + +

+
+
+
+
+
+ adminEmail: +
+
+ String +
+
+ +
+
+

Admin's email of the brand.

+
+
+ bankAccount: +
+ +
+ +
+
+

Bank account of the brand.

+
+
+ brandID: +
+
+ String +
+
+ + +
+
+

The ID of an existing brand to be updated/inserted.

+
+
+ checkoutAsGuestEnabled: +
+
+ Boolean +
+
+ +
+
+

A flag to allow or disallow checkout as guest.

+
+
+ confirmPaymentMessage: +
+ +
+ +
+
+

Set the brand confirm payment message.

+
+
+ faviconURL: +
+
+ String +
+
+ +
+
+

URL of the brand favicon.

+
+
+ hideFromSearchEngine: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this brand can be found from search engine or not.

+
+
+ newsletter: +
+ +
+ +
+
+

The brand's newsletter.

+
+
+ paymentMethods: +
+ +
+ +
+
+

The brand's payment methods.

+
+
+ productFilterAndSort: +
+ +
+ +
+
+

The brand's custom filter and sort.

+
+
+ productOption: +
+ +
+ +
+
+

The brand's product option.

+
+
+ reviewsAndRatingEnabled: +
+
+ Boolean +
+
+ +
+
+

A flag to allow or disallow reviews and rating.

+
+
+ setAsMaintenance: +
+ +
+ +
+
+

Set the current brand status as maintenance.

+
+
+ socialMediaLink: +
+ +
+ +
+
+

The brand's social media link.

+
+
+ websiteDescription: +
+
+ String +
+
+ +
+
+

The brand's website description.

+
+
+ websiteTitle: +
+
+ String +
+
+ +
+
+

The brand's website title.

+
+
+ defaultExchangePointSettingID: +
+
+ ID +
+
+ +
+
+

The exchange point setting for this brand.

+
+
+ facebookAnalytics: +
+ +
+ +
+
+ googleAnalytics: +
+ +
+ +
+
+ privyID: +
+
+ String +
+
+ +
+
+ notificationCCEmail: +
+
+ String +
+
+ +
+
+

Notification default cc email

+
+
+ pushNotification: +
+ +
+ +
+
+

The push notification setting for this brand

+
+
+ googleAuth: +
+ +
+ +
+
+

The brand's Google OAuth credentials

+
+
+ stockReminderEnabled: +
+
+ Boolean +
+
+ +
+
+

Brand's stock reminder enabled flag

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "adminEmail": "string",
+  "bankAccount": {
+    "banks": [
+      {
+        "name": "string",
+        "accountNumber": "string",
+        "accountName": "string",
+        "isActive": "boolean"
+      }
+    ]
+  },
+  "brandID": "string",
+  "checkoutAsGuestEnabled": "boolean",
+  "confirmPaymentMessage": {
+    "isActive": "boolean",
+    "message": "string"
+  },
+  "faviconURL": "string",
+  "hideFromSearchEngine": "boolean",
+  "newsletter": {
+    "popupOnFirstVisit": "boolean",
+    "content": "string"
+  },
+  "paymentMethods": {
+    "paymentMethods": [
+      {
+        "name": "string",
+        "merchantID": "string",
+        "clientKey": "string",
+        "serverKey": "string",
+        "acquiringBank": "string",
+        "payPalAccount": "string",
+        "specs": [
+          {
+            "method": "string",
+            "isActive": "boolean",
+            "chargeFeeToCustomer": "boolean",
+            "expiryHour": "number"
+          }
+        ]
+      }
+    ]
+  },
+  "productFilterAndSort": {
+    "filters": [
+      {
+        "name": "string",
+        "isActive": "boolean",
+        "type": "string",
+        "variantSpecs": [
+          {
+            "key": "string",
+            "translations": [
+              {
+                "language": "string",
+                "text": "string"
+              }
+            ],
+            "options": [
+              {
+                "value": "string",
+                "translations": [
+                  {
+                    "language": "string",
+                    "text": "string"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertShippingCouponsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this shipping coupons in.

+
+
+ specs: +
+
+ UpsertShippingCouponsSpec +
+
+ +
+
+

Specifications for upserting shipping coupons.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "code": "string",
+      "title": "string",
+      "isActive": "boolean",
+      "salesChannel": "string",
+      "discountValue": {
+        "moneyValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "scalarValue": "number",
+        "maximumDiscountValue": {
+          "code": "string",
+          "value": "number"
+        },
+        "discountType": "string",
+        "discountField": "string"
+      },
+      "allowedShippingMethods": [
+        "string"
+      ],
+      "applicableStartTimestamp": "number",
+      "applicableEndTimestamp": "number",
+      "maximumUsageCount": "number",
+      "isMemberOnly": "boolean",
+      "allowedMemberLevels": [
+        "string"
+      ],
+      "minimumPurchase": {
+        "code": "string",
+        "value": "number"
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertShippingCouponsSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a shipping coupon to be updated/inserted. Omit this to create a new coupon.

+
+
+ code: +
+
+ String +
+
+ + +
+
+

The code for this shipping coupon.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of this product coupon.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the shipping coupon is active or not.

+
+
+ salesChannel: +
+
+ String +
+
+ + +
+
+

The sales channel of the shipping coupon.

+
+
+ discountValue: +
+ +
+ + +
+
+

Discount value for upserting shipping coupons.

+
+
+ allowedShippingMethods: +
+
+ String +
+
+ +
+
+

Allowed shipping method when using this shipping coupon.

+
+
+ applicableStartTimestamp: +
+
+ Int +
+
+ + +
+
+

A timestamp to indicate when this cart coupon is starts to be applicable.

+
+
+ applicableEndTimestamp: +
+
+ Int +
+
+ + +
+
+

A timestamp to indicate when this cart coupon cannot be applied anymore.

+
+
+ maximumUsageCount: +
+
+ Int +
+
+ + +
+
+

Maximum usage when using this shipping coupon.

+
+
+ isMemberOnly: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether this coupon is limited to member only or not.

+
+
+ allowedMemberLevels: +
+
+ String +
+
+ +
+
+

Allowed member levels to use this cart coupon.

+
+
+ minimumPurchase: +
+ +
+ + +
+
+

Minimum purchase for upserting shipping coupons.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "code": "string",
+  "title": "string",
+  "isActive": "boolean",
+  "salesChannel": "string",
+  "discountValue": {
+    "moneyValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "scalarValue": "number",
+    "maximumDiscountValue": {
+      "code": "string",
+      "value": "number"
+    },
+    "discountType": "string",
+    "discountField": "string"
+  },
+  "allowedShippingMethods": [
+    "string"
+  ],
+  "applicableStartTimestamp": "number",
+  "applicableEndTimestamp": "number",
+  "maximumUsageCount": "number",
+  "isMemberOnly": "boolean",
+  "allowedMemberLevels": [
+    "string"
+  ],
+  "minimumPurchase": {
+    "code": "string",
+    "value": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertShippingSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a shipping to be updated/inserted. Omit this to create a new shipping method.

+
+
+ provider: +
+
+ String +
+
+ + +
+
+

The shipping's provider.

+
+
+ services: +
+
+ ShippingServiceInput +
+
+ +
+
+

Services for upserting shipping specifications.

+
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whther the shipping is active or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "provider": "string",
+  "services": [
+    {
+      "ID": "object",
+      "name": "string",
+      "isActive": "boolean",
+      "isAutoAWB": "boolean",
+      "useInsurance": "boolean"
+    }
+  ],
+  "isActive": "boolean"
+}
+
+ + +
+
+
+
+
+

+ UpsertShippingsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this shipping in.

+
+
+ specs: +
+
+ UpsertShippingSpec +
+
+ +
+
+

Specifications for upserting shippings.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "provider": "string",
+      "services": [
+        {
+          "ID": "object",
+          "name": "string",
+          "isActive": "boolean",
+          "isAutoAWB": "boolean",
+          "useInsurance": "boolean"
+        }
+      ],
+      "isActive": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertSmsTemplatesSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

Omit this to generate a new sms template

+
+
+ translations: +
+
+ SmsTranslationInput +
+
+ +
+
+

Translations for updating/inserting SMS templates specifications.

+
+
+ destinations: +
+
+ SmsDestinationInput +
+
+ +
+
+

Destinations for updating/inserting SMS templates specifications.

+
+
+ sendOrder: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ],
+  "destinations": [
+    {
+      "phoneNumber": "string"
+    }
+  ],
+  "sendOrder": "number"
+}
+
+ + +
+
+
+
+
+

+ UpsertSocmedSettingInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+ instagramToken: +
+
+ String +
+
+ +
+
+ socmedLink: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "instagramToken": "string",
+  "socmedLink": {
+    "twitter": "string",
+    "facebook": "string",
+    "instagram": "string",
+    "youtube": "string",
+    "tiktok": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertSpec: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+

The ID of an order to be updated/inserted. Omit this to create a new order.

+
+
+ spec: +
+ +
+ + +
+
+

Specifications for upserting order specifications.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "spec": {
+    "memberID": "string",
+    "invoiceID": "string",
+    "channelID": "string",
+    "discount": {
+      "code": "string",
+      "value": "number"
+    },
+    "totalCost": {
+      "code": "string",
+      "value": "number"
+    },
+    "buyerNote": "string",
+    "billingAddress": {
+      "name": "string",
+      "email": "string",
+      "phone": "string",
+      "country": "string",
+      "province": "string",
+      "city": "string",
+      "subDistrict": "string",
+      "street": "string",
+      "districtCode": "string",
+      "postalCode": "string"
+    },
+    "deliveryAddress": {
+      "name": "string",
+      "email": "string",
+      "phone": "string",
+      "country": "string",
+      "province": "string",
+      "city": "string",
+      "subDistrict": "string",
+      "street": "string",
+      "districtCode": "string",
+      "postalCode": "string"
+    },
+    "lineItems": [
+      {
+        "title": "string",
+        "SKU": "string",
+        "quantity": "number",
+        "price": {
+          "code": "string",
+          "value": "number"
+        },
+        "imageURL": "string"
+      }
+    ],
+    "shipping": {
+      "provider": "string",
+      "service": "string",
+      "cost": {
+        "code": "string",
+        "value": "number"
+      },
+      "AWBNumber": "string"
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertTemplatesInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this template in.

+
+
+ specs: +
+
+ UpsertTemplatesSpec +
+
+ +
+
+

Specifications for upserting templates.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "eventType": "string",
+      "eventVersion": "number",
+      "isActive": "boolean",
+      "emailTemplates": [
+        {
+          "ID": "object",
+          "isActive": "boolean",
+          "destinations": [
+            {
+              "type": "string",
+              "value": "string"
+            }
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ],
+          "sendOrder": "number"
+        }
+      ],
+      "smsTemplates": [
+        {
+          "ID": "object",
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ],
+          "destinations": [
+            {
+              "phoneNumber": "string"
+            }
+          ],
+          "sendOrder": "number"
+        }
+      ],
+      "whatsAppTemplates": [
+        {
+          "ID": "object",
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ],
+          "destinations": [
+            {
+              "phoneNumber": "string"
+            }
+          ],
+          "sendOrder": "number"
+        }
+      ]
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertTemplatesInputV2: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this template in.

+
+
+ specs: +
+
+ UpsertTemplatesSpecV2 +
+
+ +
+
+

Specifications for upserting notificationV2 template.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "event": {
+        "type": "string",
+        "version": "number"
+      },
+      "emailTemplate": {
+        "buyer": {
+          "bccs": [
+            "string"
+          ],
+          "ccs": [
+            "string"
+          ],
+          "tos": [
+            "string"
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "bccs": [
+            "string"
+          ],
+          "ccs": [
+            "string"
+          ],
+          "tos": [
+            "string"
+          ],
+          "translations": [
+            {
+              "body": "string",
+              "language": "string",
+              "subject": "string"
+            }
+          ]
+        }
+      },
+      "smsTemplate": {
+        "buyer": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        },
+        "isActive": "boolean",
+        "seller": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        }
+      },
+      "whatsAppTemplate": {
+        "buyer": {
+          "targetPhoneNumbers": [
+            "string"
+          ],
+          "translations": [
+            {
+              "language": "string",
+              "body": "string"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertTemplatesSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a template to be updated/inserted. Omit this to generate a new template.

+
+
+ eventType: +
+ +
+ + +
+
+

Event type for upserting templates.

+
+
+ eventVersion: +
+
+ Int +
+
+ +
+
+

The version of event.

+
+
+ isActive: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether the template is active or not.

+
+
+ emailTemplates: +
+
+ UpsertEmailTemplatesSpec +
+
+ +
+
+

Email templates for upserting templates.

+
+
+ smsTemplates: +
+
+ UpsertSmsTemplatesSpec +
+
+ +
+
+

SMS templates for upserting templates.

+
+
+ whatsAppTemplates: +
+
+ UpsertWhatsAppTemplatesSpec +
+
+ +
+
+

WhatsApp templates for upserting templates.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "eventType": "string",
+  "eventVersion": "number",
+  "isActive": "boolean",
+  "emailTemplates": [
+    {
+      "ID": "object",
+      "isActive": "boolean",
+      "destinations": [
+        {
+          "type": "string",
+          "value": "string"
+        }
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ],
+      "sendOrder": "number"
+    }
+  ],
+  "smsTemplates": [
+    {
+      "ID": "object",
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ],
+      "destinations": [
+        {
+          "phoneNumber": "string"
+        }
+      ],
+      "sendOrder": "number"
+    }
+  ],
+  "whatsAppTemplates": [
+    {
+      "ID": "object",
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ],
+      "destinations": [
+        {
+          "phoneNumber": "string"
+        }
+      ],
+      "sendOrder": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertTemplatesSpecV2: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a template to be updated/inserted. Omit this to generate a new template.

+
+
+ event: +
+ +
+ + +
+
+

Event type for upserting notificationV2 template

+
+
+ emailTemplate: +
+ +
+ +
+
+

Email template for upserting notificationV2 template.

+
+
+ smsTemplate: +
+ +
+ +
+
+

SMS template for upserting notificationV2 template.

+
+
+ whatsAppTemplate: +
+ +
+ +
+
+

WhatsApp template for upserting notificationV2 template.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "event": {
+    "type": "string",
+    "version": "number"
+  },
+  "emailTemplate": {
+    "buyer": {
+      "bccs": [
+        "string"
+      ],
+      "ccs": [
+        "string"
+      ],
+      "tos": [
+        "string"
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "bccs": [
+        "string"
+      ],
+      "ccs": [
+        "string"
+      ],
+      "tos": [
+        "string"
+      ],
+      "translations": [
+        {
+          "body": "string",
+          "language": "string",
+          "subject": "string"
+        }
+      ]
+    }
+  },
+  "smsTemplate": {
+    "buyer": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    }
+  },
+  "whatsAppTemplate": {
+    "buyer": {
+      "targetPhoneNumbers": [
+        "string"
+      ],
+      "translations": [
+        {
+          "language": "string",
+          "body": "string"
+        }
+      ]
+    },
+    "isActive": "boolean",
+    "seller": {
+      "targetPhoneNumbers": [
+        null
+      ]
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertTestimonialSpec: object + +

+
+
+
+
+
+ ID: +
+
+ String +
+
+ + +
+
+

The ID of a testimony to be updated/inserted. Omit this to create a new testimonial.

+
+
+ email: +
+
+ String +
+
+ + +
+
+

The email of the testimony.

+
+
+ author: +
+
+ String +
+
+ +
+
+

The author of the testimony.

+
+
+ company: +
+
+ String +
+
+ +
+
+

The company of the testimony

+
+
+ website: +
+
+ String +
+
+ +
+
+

The website of the testimony.

+
+
+ memberID: +
+
+ String +
+
+ +
+
+

The member ID of the member linked to the testimony.

+
+
+ productID: +
+
+ String +
+
+ +
+
+

The product ID of the product linked to the testimony.

+
+
+ title: +
+
+ String +
+
+ + +
+
+

The title of the testimony.

+
+
+ content: +
+
+ String +
+
+ + +
+
+

The content of the testimony. Minimum 20 characters needed.

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+

URLs of the testimony's images.

+
+
+ rating: +
+
+ Int +
+
+ + +
+
+

Rating in the testimony. Between 1-5.

+
+
+ createdAt: +
+
+ Int +
+
+ +
+
+

A number representing when this testimony is created.

+
+
+ updatedAt: +
+
+ Int +
+
+ +
+
+

A number representing when this testimony is updated.

+
+
+ published: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the testimony is published or not.

+
+
+ isFeatured: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "string",
+  "email": "string",
+  "author": "string",
+  "company": "string",
+  "website": "string",
+  "memberID": "string",
+  "productID": "string",
+  "title": "string",
+  "content": "string",
+  "imageURLs": [
+    "string"
+  ],
+  "rating": "number",
+  "createdAt": "number",
+  "updatedAt": "number",
+  "published": "boolean",
+  "isFeatured": "boolean"
+}
+
+ + +
+
+
+
+
+

+ UpsertTestimonialsInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ +
+
+

Brand ID to put the testimonials in.

+
+
+ specs: +
+
+ UpsertTestimonialSpec +
+
+ +
+
+

Specifications for upserting testimonials input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string",
+  "specs": [
+    {
+      "ID": "string",
+      "email": "string",
+      "author": "string",
+      "company": "string",
+      "website": "string",
+      "memberID": "string",
+      "productID": "string",
+      "title": "string",
+      "content": "string",
+      "imageURLs": [
+        "string"
+      ],
+      "rating": "number",
+      "createdAt": "number",
+      "updatedAt": "number",
+      "published": "boolean",
+      "isFeatured": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertWarehouseInput: object + +

+
+
+
+
+
+ warehouseID: +
+
+ ID +
+
+ + +
+
+

The ID of an existing warehouse to be updated/inserted.

+
+
+ tenantID: +
+
+ ID +
+
+ + +
+
+

Tenant ID to put the warehouse in.

+
+
+ address: +
+ +
+ + +
+
+

The warehouse address.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "warehouseID": "object",
+  "tenantID": "object",
+  "address": {
+    "phones": [
+      "string"
+    ],
+    "emails": [
+      "string"
+    ],
+    "street": "string",
+    "districtCode": "string",
+    "postalCode": "string",
+    "latitude": "number",
+    "longitude": "number"
+  }
+}
+
+ + +
+
+
+
+
+

+ UpsertWhatsAppTemplatesSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

Omit this to generate a new whatsapp template

+
+
+ translations: +
+
+ SmsTranslationInput +
+
+ +
+
+

Translations for updating/inserting WhatsApp templates specifications.

+
+
+ destinations: +
+
+ SmsDestinationInput +
+
+ +
+
+

Destinations for updating/inserting WhatsApp templates specifications.

+
+
+ sendOrder: +
+
+ Int +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ],
+  "destinations": [
+    {
+      "phoneNumber": "string"
+    }
+  ],
+  "sendOrder": "number"
+}
+
+ + +
+
+
+
+
+

+ UpsertWidgetInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ + +
+
+

Brand ID to put this widget in.

+
+
+ specs: +
+
+ UpsertWidgetSpec +
+
+ +
+
+

Specifications for upserting widgets input.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "specs": [
+    {
+      "ID": "object",
+      "content": "string",
+      "name": "string",
+      "order": "number",
+      "published": "boolean",
+      "region": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ UpsertWidgetSpec: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+

The ID of a widget to be updated/inserted. Omit this to create a new widget.

+
+
+ content: +
+
+ String +
+
+ + +
+
+

Content of the widget.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the widget.

+
+
+ order: +
+
+ Int +
+
+ + +
+
+

Order of the widget.

+
+
+ published: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the widget is published or not.

+
+
+ region: +
+
+ String +
+
+ + +
+
+

Region of the widget.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "content": "string",
+  "name": "string",
+  "order": "number",
+  "published": "boolean",
+  "region": "string"
+}
+
+ + +
+
+
+
+
+

+ Usage: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string"
+}
+
+ + +
+
+
+
+
+

+ UserProfile: object + +

+
+
+
+
+
+ basicInfo: +
+
+ BasicInfo +
+
+ + +
+
+ addresses: +
+
+ ProfileAddress +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "basicInfo": {
+    "email": "string",
+    "firstName": "string",
+    "lastName": "string",
+    "gender": "string",
+    "phone": "string",
+    "dateOfBirth": "number"
+  },
+  "addresses": [
+    {
+      "addressLabel": "string",
+      "contactName": "string",
+      "districtCode": "string",
+      "street": "string",
+      "latitude": "string",
+      "longitude": "string",
+      "postalCode": "string",
+      "isPrimary": "boolean",
+      "salesChannel": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ ValidateSettingInput: object + +

+
+
+
+
+
+ adminEmail: +
+
+ String +
+
+ +
+
+

Admin's email of the brand.

+
+
+ bankAccount: +
+ +
+ +
+
+

Bank account of the brand.

+
+
+ checkoutAsGuestEnabled: +
+
+ Boolean +
+
+ +
+
+

A flag to allow or disallow checkout as guest.

+
+
+ confirmPaymentMessage: +
+ +
+ +
+
+

Set the brand confirm payment message.

+
+
+ faviconURL: +
+
+ String +
+
+ +
+
+

URL of the brand favicon.

+
+
+ hideFromSearchEngine: +
+
+ Boolean +
+
+ +
+
+

A flag to indicate whether this brand can be found from search engine or not.

+
+
+ newsletter: +
+ +
+ +
+
+

The brand's newsletter.

+
+
+ paymentMethods: +
+ +
+ +
+
+

The brand's payment methods.

+
+
+ productFilterAndSort: +
+ +
+ +
+
+

The brand's custom filter and sort.

+
+
+ productOption: +
+ +
+ +
+
+

The brand's product option.

+
+
+ reviewsAndRatingEnabled: +
+
+ Boolean +
+
+ +
+
+

A flag to allow or disallow reviews and rating.

+
+
+ setAsMaintenance: +
+ +
+ +
+
+

Set the current brand status as maintenance.

+
+
+ socialMediaLink: +
+ +
+ +
+
+

The brand's social media link.

+
+
+ websiteDescription: +
+
+ String +
+
+ +
+
+

The brand's website description.

+
+
+ websiteTitle: +
+
+ String +
+
+ +
+
+

The brand's website title.

+
+
+ defaultExchangePointSettingID: +
+
+ ID +
+
+ +
+
+

The exchange point setting for this brand.

+
+
+ facebookAnalytics: +
+ +
+ +
+
+ googleAnalytics: +
+ +
+ +
+
+ privyID: +
+
+ String +
+
+ +
+
+ googleAuth: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "adminEmail": "string",
+  "bankAccount": {
+    "banks": [
+      {
+        "name": "string",
+        "accountNumber": "string",
+        "accountName": "string",
+        "isActive": "boolean"
+      }
+    ]
+  },
+  "checkoutAsGuestEnabled": "boolean",
+  "confirmPaymentMessage": {
+    "isActive": "boolean",
+    "message": "string"
+  },
+  "faviconURL": "string",
+  "hideFromSearchEngine": "boolean",
+  "newsletter": {
+    "popupOnFirstVisit": "boolean",
+    "content": "string"
+  },
+  "paymentMethods": {
+    "paymentMethods": [
+      {
+        "name": "string",
+        "merchantID": "string",
+        "clientKey": "string",
+        "serverKey": "string",
+        "acquiringBank": "string",
+        "payPalAccount": "string",
+        "specs": [
+          {
+            "method": "string",
+            "isActive": "boolean",
+            "chargeFeeToCustomer": "boolean",
+            "expiryHour": "number"
+          }
+        ]
+      }
+    ]
+  },
+  "productFilterAndSort": {
+    "filters": [
+      {
+        "name": "string",
+        "isActive": "boolean",
+        "type": "string",
+        "variantSpecs": [
+          {
+            "key": "string",
+            "translations": [
+              {
+                "language": "string",
+                "text": "string"
+              }
+            ],
+            "options": [
+              {
+                "value": "string",
+                "translations": [
+                  {
+                    "language": "string",
+                    "text": "string"
+                  }
+                ]
+              }
+            ]
+          }
+        ],
+        "tagSpec": {
+          "options": [
+            null
+          ]
+        }
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ ValidationResult: object + +

+
+
+
+
+
+ errorMessages: +
+
+ ErrorMessage +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "errorMessages": [
+    {
+      "settingKey": "string",
+      "message": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ Variant: object + +

+
+
+
+
+
+ SKU: +
+
+ ID +
+
+ + +
+
+ optionValue: +
+
+ VariantOptionValue +
+
+ +
+
+ stock: +
+
+ Int +
+
+ + +
+
+ attributes: +
+
+ VariantAttribute +
+
+ +
+
+ channelAttributes: +
+
+ VariantChannelAttribute +
+
+ +
+
+ images: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "object",
+  "optionValue": [
+    {
+      "key": "object",
+      "value": "string"
+    }
+  ],
+  "stock": "number",
+  "attributes": [
+    {
+      "sortIndex": "number",
+      "translations": [
+        {
+          "key": "object",
+          "value": "string",
+          "language": "string"
+        }
+      ]
+    }
+  ],
+  "channelAttributes": [
+    {
+      "channelID": "object",
+      "key": "object",
+      "value": "string"
+    }
+  ],
+  "images": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ VariantAttribute: object + +

+
+
+
+
+
+ sortIndex: +
+
+ Int +
+
+ +
+
+ translations: +
+
+ VariantAttributeTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sortIndex": "number",
+  "translations": [
+    {
+      "key": "object",
+      "value": "string",
+      "language": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ VariantAttributeTranslation: object + +

+
+
+
+
+
+ key: +
+
+ ID +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "object",
+  "value": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantBasePriceSpecInput: object + +

+
+
+
+
+
+ SKU: +
+
+ ID +
+
+ + +
+
+

SKU of the variant.

+
+
+ basePrices: +
+
+ MoneyInput +
+
+ +
+
+

Base prices for variant base price specification.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "object",
+  "basePrices": [
+    {
+      "code": "string",
+      "value": "number"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ VariantChannelAttribute: object + +

+
+
+
+
+
+ channelID: +
+
+ ID +
+
+ +
+
+ key: +
+
+ ID +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "object",
+  "key": "object",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantChannelAttributeInput: object + +

+
+
+
+
+
+ channelID: +
+
+ String +
+
+ + +
+
+ key: +
+
+ ID +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "channelID": "string",
+  "key": "object",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantDetail: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantOption: object + +

+
+
+
+
+
+ variant: +
+ +
+ + +
+
+ key: +
+
+ String +
+
+ + +
+
+ keyLabel: +
+
+ VariantOptionTranslation +
+
+ +
+
+ value: +
+
+ String +
+
+ + +
+
+ valueLabel: +
+
+ VariantOptionTranslation +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "variant": {
+    "product": {
+      "ID": "object",
+      "brandID": "object",
+      "brand": {
+        "ID": "string",
+        "name": "string",
+        "tenantID": "string",
+        "tenant": {
+          "ID": "object",
+          "name": "string",
+          "language": "string",
+          "currencyCode": "string",
+          "brands": {
+            "items": [
+              {
+                "ID": "string",
+                "name": "string",
+                "tenantID": "string",
+                "tenant": {
+                  "ID": "object",
+                  "name": "string",
+                  "language": "string",
+                  "currencyCode": "string",
+                  "brands": {
+                    "items": [
+                      {
+                        "ID": "string",
+                        "name": "string",
+                        "tenantID": "string",
+                        "tenant": {
+                          "ID": "object",
+                          "name": "string",
+                          "language": "string",
+                          "currencyCode": "string",
+                          "brands": {
+                            "items": [
+                              {
+                                "ID": "string",
+                                "name": "string",
+                                "tenantID": "string",
+                                "tenant": {
+                                  "ID": "object",
+                                  "name": "string",
+                                  "language": "string",
+                                  "currencyCode": "string",
+                                  "brands": {
+                                    "items": [
+                                      {
+                                        "ID": "string",
+                                        "name": "string"
+                                      }
+                                    ]
+                                  }
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}
+
+ + +
+
+
+
+
+

+ VariantOptionSpec: object + +

+
+
+
+
+
+ optionKey: +
+
+ String +
+
+ + +
+
+ optionValue: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "optionKey": "string",
+  "optionValue": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantOptionTranslation: object + +

+
+
+
+
+
+ text: +
+
+ String +
+
+ +
+
+ language: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "text": "string",
+  "language": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantOptionType: object + +

+
+
+
+
+
+ optionKey: +
+
+ String +
+
+ + +
+
+ optionValue: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "optionKey": "string",
+  "optionValue": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantOptionValue: object + +

+
+
+
+
+
+ key: +
+
+ ID +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "object",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantOptionValueInput: object + +

+
+
+
+
+
+ key: +
+
+ ID +
+
+ + +
+
+ value: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "key": "object",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ VariantUpsertInput: object + +

+
+
+
+
+
+ SKU: +
+
+ ID +
+
+ + +
+
+ options: +
+
+ VariantOptionValueInput +
+
+ +
+
+

Options for updating/inserting variant input.

+
+
+ basePrices: +
+
+ MoneyInput +
+
+ +
+
+

Base prices for updating/inserting variant input.

+
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ attributes: +
+
+ TranslatableAttributeInput +
+
+ +
+
+

Attributes for updating.inserting variant input.

+
+
+ channelAttributes: +
+
+ VariantChannelAttributeInput +
+
+ +
+
+

Channel attributes for updating/inserting variant input.

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ stock: +
+
+ Int +
+
+ + +
+
+ ignoreStock: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "object",
+  "options": [
+    {
+      "key": "object",
+      "value": "string"
+    }
+  ],
+  "basePrices": [
+    {
+      "code": "string",
+      "value": "number"
+    }
+  ],
+  "channelIDs": [
+    "string"
+  ],
+  "attributes": [
+    {
+      "sortIndex": "number",
+      "translations": [
+        {
+          "key": "string",
+          "value": "string",
+          "language": "string"
+        }
+      ]
+    }
+  ],
+  "channelAttributes": [
+    {
+      "channelID": "string",
+      "key": "object",
+      "value": "string"
+    }
+  ],
+  "imageURLs": [
+    "string"
+  ],
+  "stock": "number",
+  "ignoreStock": "boolean"
+}
+
+ + +
+
+
+
+
+

+ VariantWithStockUpsertInput: object + +

+
+
+
+
+
+ SKU: +
+
+ ID +
+
+ + +
+
+ options: +
+
+ VariantOptionValueInput +
+
+ +
+
+

Options for updating/inserting variant input.

+
+
+ basePrices: +
+
+ MoneyInput +
+
+ +
+
+

Base prices for updating/inserting variant input.

+
+
+ channelIDs: +
+
+ String +
+
+ +
+
+ attributes: +
+
+ TranslatableAttributeInput +
+
+ +
+
+

Attributes for updating.inserting variant input.

+
+
+ channelAttributes: +
+
+ VariantChannelAttributeInput +
+
+ +
+
+

Channel attributes for updating/inserting variant input.

+
+
+ imageURLs: +
+
+ String +
+
+ +
+
+ stock: +
+
+ Int +
+
+ + +
+
+ warehouseID: +
+
+ String +
+
+ +
+
+

specific warehouse for product to be upserted

+
+
+ currentStock: +
+
+ Int +
+
+ +
+
+

current sku stock

+
+
+ ignoreCurrentStock: +
+
+ Boolean +
+
+ +
+
+

ignore current stock.

+

set to 'true' to check the current stock in inventory and add / subtract based on 'stock' field

+

set to 'false' to set current stock as defined in 'stock' field

+
+
+ ignoreStock: +
+
+ Boolean +
+
+ +
+
+

ignore stock

+

set to 'true' to make stock always available set to 'false' then the stock depend on the quantity of product

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "SKU": "object",
+  "options": [
+    {
+      "key": "object",
+      "value": "string"
+    }
+  ],
+  "basePrices": [
+    {
+      "code": "string",
+      "value": "number"
+    }
+  ],
+  "channelIDs": [
+    "string"
+  ],
+  "attributes": [
+    {
+      "sortIndex": "number",
+      "translations": [
+        {
+          "key": "string",
+          "value": "string",
+          "language": "string"
+        }
+      ]
+    }
+  ],
+  "channelAttributes": [
+    {
+      "channelID": "string",
+      "key": "object",
+      "value": "string"
+    }
+  ],
+  "imageURLs": [
+    "string"
+  ],
+  "stock": "number",
+  "warehouseID": "string",
+  "currentStock": "number",
+  "ignoreCurrentStock": "boolean",
+  "ignoreStock": "boolean"
+}
+
+ + +
+
+
+
+
+

+ VolumeInput: object + +

+
+
+
+
+
+ length: +
+
+ Int +
+
+ + +
+
+

Length of the product.

+
+
+ height: +
+
+ Int +
+
+ + +
+
+

Height of the product.

+
+
+ width: +
+
+ Int +
+
+ + +
+
+

Width of the product.

+
+
+ unit: +
+ +
+ + +
+
+

Unit for volume.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "length": "number",
+  "height": "number",
+  "width": "number",
+  "unit": "string"
+}
+
+ + +
+
+
+
+
+

+ Warehouse: object + +

+
+
+
+
+
+ warehouseID: +
+
+ ID +
+
+ +
+
+ tenantID: +
+
+ ID +
+
+ +
+
+ ID: +
+
+ ID +
+
+ +
+
+ address: +
+ +
+ +
+
+ isDefault: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "warehouseID": "object",
+  "tenantID": "object",
+  "ID": "object",
+  "address": {
+    "phones": [
+      "string"
+    ],
+    "emails": [
+      "string"
+    ],
+    "districtCode": "string",
+    "street": "string",
+    "latitude": "number",
+    "longitude": "number",
+    "postalCode": "string",
+    "formattedAddress": "string"
+  },
+  "isDefault": "boolean"
+}
+
+ + +
+
+
+
+
+

+ WarehouseAddress: object + +

+
+
+
+
+
+ phones: +
+
+ String +
+
+ +
+
+ emails: +
+
+ String +
+
+ +
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ street: +
+
+ String +
+
+ +
+
+ latitude: +
+
+ Float +
+
+ +
+
+ longitude: +
+
+ Float +
+
+ +
+
+ postalCode: +
+
+ String +
+
+ +
+
+ formattedAddress: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phones": [
+    "string"
+  ],
+  "emails": [
+    "string"
+  ],
+  "districtCode": "string",
+  "street": "string",
+  "latitude": "number",
+  "longitude": "number",
+  "postalCode": "string",
+  "formattedAddress": "string"
+}
+
+ + +
+
+
+
+
+

+ WarehouseAddressInput: object + +

+
+
+
+
+
+ phones: +
+
+ String +
+
+ +
+
+

Phone numbers for this address.

+
+
+ emails: +
+
+ String +
+
+ +
+
+

Emails for this address.

+
+
+ street: +
+
+ String +
+
+ + +
+
+

Street name for this address.

+
+
+ districtCode: +
+
+ String +
+
+ + +
+
+

District code for this address.

+
+
+ postalCode: +
+
+ String +
+
+ + +
+
+

Postal code for this address.

+
+
+ latitude: +
+
+ Float +
+
+ +
+
+

This address' latitude.

+
+
+ longitude: +
+
+ Float +
+
+ +
+
+

This address' longitude.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "phones": [
+    "string"
+  ],
+  "emails": [
+    "string"
+  ],
+  "street": "string",
+  "districtCode": "string",
+  "postalCode": "string",
+  "latitude": "number",
+  "longitude": "number"
+}
+
+ + +
+
+
+
+
+

+ WeightInput: object + +

+
+
+
+
+
+ value: +
+
+ Float +
+
+ + +
+
+

Weight value of the product.

+
+
+ unit: +
+ +
+ + +
+
+

Unit for weight.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "value": "number",
+  "unit": "string"
+}
+
+ + +
+
+
+
+
+

+ WeightUnitEnum: string + +

+
+
+
+
+
+
object
+ + GR + + +
+
+
+
object
+ + KG + + +
+
+
+
+
+
+
+
+

+ WhatsAppDestinationInput: object + +

+
+
+
+
+
+ phoneNumber: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phoneNumber": "string"
+}
+
+ + +
+
+
+
+
+

+ WhatsAppTemplateInputV2: object + +

+
+
+
+
+
+ buyer: +
+ +
+ +
+
+ isActive: +
+
+ Boolean +
+
+ + +
+
+ seller: +
+ +
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyer": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  },
+  "isActive": "boolean",
+  "seller": {
+    "targetPhoneNumbers": [
+      "string"
+    ],
+    "translations": [
+      {
+        "language": "string",
+        "body": "string"
+      }
+    ]
+  }
+}
+
+ + +
+
+
+
+
+

+ WhatsAppTranslationInput: object + +

+
+
+
+
+
+ language: +
+
+ String +
+
+ + +
+
+ body: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "language": "string",
+  "body": "string"
+}
+
+ + +
+
+
+
+
+

+ WhatsappTemplateSpecV2: object + +

+
+
+
+
+
+ targetPhoneNumbers: +
+
+ String +
+
+ +
+
+ translations: +
+
+ WhatsAppTranslationInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "targetPhoneNumbers": [
+    "string"
+  ],
+  "translations": [
+    {
+      "language": "string",
+      "body": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ Widget: object + +

+
+
+
+
+
+ ID: +
+
+ ID +
+
+ +
+
+ name: +
+
+ String +
+
+ +
+
+ region: +
+
+ String +
+
+ +
+
+ order: +
+
+ Int +
+
+ +
+
+ content: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "ID": "object",
+  "name": "string",
+  "region": "string",
+  "order": "number",
+  "content": "string",
+  "published": "boolean"
+}
+
+ + +
+
+
+
+
+

+ WidgetFilterInput: object + +

+
+
+
+
+
+ name: +
+
+ String +
+
+ +
+
+ published: +
+
+ Boolean +
+
+ +
+
+ region: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "name": "string",
+  "published": "boolean",
+  "region": "string"
+}
+
+ + +
+
+
+
+
+

+ WidgetSortInput: object + +

+
+
+
+
+
+ fieldName: +
+ +
+ + +
+
+ isAscending: +
+
+ Boolean +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "fieldName": "string",
+  "isAscending": "boolean"
+}
+
+ + +
+
+
+
+
+

+ WidgetSpec: object + +

+
+
+
+
+
+ region: +
+
+ String +
+
+ + +
+
+

Region of the widget.

+
+
+ order: +
+
+ Int +
+
+ + +
+
+

Order of the widget.

+
+
+ name: +
+
+ String +
+
+ + +
+
+

Name of the widget.

+
+
+ content: +
+
+ String +
+
+ + +
+
+

Content of the widget.

+
+
+ published: +
+
+ Boolean +
+
+ + +
+
+

A flag to indicate whether the widget is published or not.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "region": "string",
+  "order": "number",
+  "name": "string",
+  "content": "string",
+  "published": "boolean"
+}
+
+ + +
+
+
+
+
+

+ activateAccountInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of account IDs to be activated.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ createAccessTokenInput: object + +

+
+
+
+
+
+ brandID: +
+
+ ID +
+
+ +
+
+

Brand ID to log into.

+
+
+ username: +
+
+ String +
+
+ + +
+
+

Username to be used when logging in. Sometimes referred to as email.

+
+
+ password: +
+
+ String +
+
+ + +
+
+

Password to be used when logging in.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "object",
+  "username": "string",
+  "password": "string"
+}
+
+ + +
+
+
+
+
+

+ createAuthorizationCodeInput: object + +

+
+
+
+
+
+ acessToken: +
+
+ String +
+
+ + +
+
+

access token generated

+
+
+ tenantID: +
+
+ String +
+
+ +
+
+

give authorization code for the given Tenant ID or the context (in authorization headers) if not given

+
+
+ clientID: +
+
+ String +
+
+ + +
+
+

the Client that generated the access token

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "acessToken": "string",
+  "tenantID": "string",
+  "clientID": "string"
+}
+
+ + +
+
+
+
+
+

+ deactivateAccountInput: object + +

+
+
+
+
+
+ IDs: +
+
+ ID +
+
+ +
+
+

List of account IDs to be deactivated.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "IDs": [
+    "object"
+  ]
+}
+
+ + +
+
+
+
+
+

+ destinationInput: object + +

+
+
+
+
+
+ districtCode: +
+
+ String +
+
+ + +
+
+ cityCode: +
+
+ String +
+
+ + +
+
+ countryCode: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "districtCode": "string",
+  "cityCode": "string",
+  "countryCode": "string"
+}
+
+ + +
+
+
+
+
+

+ message: object + +

+
+
+
+
+
+ to: +
+
+ String +
+
+ +
+
+ from: +
+
+ String +
+
+ +
+
+ timestamp: +
+
+ String +
+
+ +
+
+ buyer_name: +
+
+ String +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+ id: +
+
+ ID +
+
+ +
+
+ message_id: +
+
+ ID +
+
+ +
+
+ gql_id: +
+
+ ID +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+ context_id: +
+
+ String +
+
+ +
+
+ caption: +
+
+ String +
+
+ +
+
+ meta: +
+
+ messageMeta +
+
+ +
+
+ channel: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "to": "string",
+  "from": "string",
+  "timestamp": "string",
+  "buyer_name": "string",
+  "message": "string",
+  "id": "object",
+  "message_id": "object",
+  "gql_id": "object",
+  "type": "string",
+  "status": "string",
+  "context_id": "string",
+  "caption": "string",
+  "meta": [
+    {
+      "gql_id": "string",
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "channel": "string"
+}
+
+ + +
+
+
+
+
+

+ messageInput: object + +

+
+
+
+
+
+ to: +
+
+ String +
+
+ +
+
+ from: +
+
+ String +
+
+ +
+
+ timestamp: +
+
+ String +
+
+ +
+
+ buyer_name: +
+
+ String +
+
+ +
+
+ message: +
+
+ String +
+
+ +
+
+ message_id: +
+
+ ID +
+
+ +
+
+ gql_id: +
+
+ ID +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+ element_name: +
+
+ String +
+
+ +
+
+ namespace: +
+
+ String +
+
+ +
+
+ id: +
+
+ ID +
+
+ +
+
+ context_id: +
+
+ String +
+
+ +
+
+ meta: +
+
+ messageMetaInput +
+
+ +
+
+ caption: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "to": "string",
+  "from": "string",
+  "timestamp": "string",
+  "buyer_name": "string",
+  "message": "string",
+  "message_id": "object",
+  "gql_id": "object",
+  "type": "string",
+  "status": "string",
+  "element_name": "string",
+  "namespace": "string",
+  "id": "object",
+  "context_id": "string",
+  "meta": [
+    {
+      "gql_id": "string",
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "caption": "string",
+  "channel": "string"
+}
+
+ + +
+
+
+
+
+

+ messageMeta: object + +

+
+
+
+
+
+ gql_id: +
+
+ String +
+
+ +
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "gql_id": "string",
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ messageMetaInput: object + +

+
+
+
+
+
+ gql_id: +
+
+ String +
+
+ +
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "gql_id": "string",
+  "key": "string",
+  "value": "string"
+}
+
+ + +
+
+
+
+
+

+ newsletterSettingInput: object + +

+
+
+
+
+
+ brandID: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "brandID": "string"
+}
+
+ + +
+
+
+
+
+

+ quickRepliesInput: object + +

+
+
+
+
+
+ keys: +
+
+ String +
+
+ +
+
+ types: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "keys": [
+    "string"
+  ],
+  "types": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ removeAccessTokenInput: object + +

+
+
+
+
+
+ accessToken: +
+
+ String +
+
+ + +
+
+

The result of access token creation.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accessToken": "string"
+}
+
+ + +
+
+
+
+
+

+ removeAdminsInput: object + +

+
+
+
+
+
+ accountIDs: +
+
+ String +
+
+ +
+
+

List of Admin AccountIDs to be removed

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountIDs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ salePrices: object + +

+
+
+
+
+
+ code: +
+
+ String +
+
+ +
+
+ value: +
+
+ Float +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "code": "string",
+  "value": "number"
+}
+
+ + +
+
+
+
+ +
+

+ searchResult: object + +

+
+
+
+
+
+ buyerName: +
+
+ String +
+
+ +
+
+ lastMessage: +
+
+ String +
+
+ +
+
+ message_id: +
+
+ String +
+
+ +
+
+ roomID: +
+
+ String +
+
+ +
+
+ id: +
+
+ Int +
+
+ +
+
+ type: +
+
+ String +
+
+ +
+
+ channel: +
+
+ String +
+
+ + +
+
+
+
+
+
+
Example
+ + + + 
{
+  "buyerName": "string",
+  "lastMessage": "string",
+  "message_id": "string",
+  "roomID": "string",
+  "id": "number",
+  "type": "string",
+  "channel": "string"
+}
+
+ + +
+
+
+
+
+

+ seller: object + +

+
+
+
+
+
+ phoneNumber: +
+
+ ID +
+
+ +
+
+ whatsappNamespace: +
+
+ String +
+
+ +
+
+ brandId: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ businessHours: +
+
+ BusinessHour +
+
+ +
+
+ settings: +
+ +
+ +
+
+ botMenus: +
+
+ DecisionMenu +
+
+ +
+
+ storeSettings: +
+
+ StoreSettings +
+
+ +
+
+ quickReplies: +
+
+ QuickReply +
+
+ +
+
+ queueCount: +
+
+ Int +
+
+ +
+
+ messageTemplates: +
+
+ MessageTemplate +
+
+ +
+
+ buyersInputShow: +
+ +
+ +
+
+ users: +
+
+ ChatUser +
+
+ +
+
+ buyer: +
+
+ Buyer +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "phoneNumber": "object",
+  "whatsappNamespace": "string",
+  "brandId": "string",
+  "email": "string",
+  "businessHours": [
+    {
+      "day": "number",
+      "shortName": "string",
+      "longName": "string",
+      "openAt": "string",
+      "closeAt": "string",
+      "isOpen": "boolean"
+    }
+  ],
+  "settings": {
+    "sellerId": "string",
+    "about": "string",
+    "photoUrl": "string",
+    "address": "string",
+    "description": "string",
+    "email": "string",
+    "vertical": "string",
+    "websites": [
+      "string"
+    ]
+  },
+  "botMenus": [
+    {
+      "id": "object",
+      "parentsId": [
+        "string"
+      ],
+      "title": "string",
+      "sequence": "number",
+      "root": "boolean",
+      "textResponse": "string",
+      "fileUrl": "string",
+      "type": "string"
+    }
+  ],
+  "storeSettings": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ],
+  "quickReplies": [
+    {
+      "id": "number",
+      "key": "string",
+      "value": "string",
+      "status": "boolean",
+      "category": "string"
+    }
+  ],
+  "queueCount": "number",
+  "messageTemplates": [
+    {
+      "sellerId": "string",
+      "id": "number",
+      "key": "string",
+      "value": "string",
+      "type": "string",
+      "status": "boolean"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ sendInvitationEmailInput: object + +

+
+
+
+
+
+ accountIDs: +
+
+ String +
+
+ +
+
+

List of AccountIDs to be send invitation email

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "accountIDs": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ setAllChatSettingsInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ about: +
+
+ String +
+
+ +
+
+ photoUrl: +
+
+ String +
+
+ +
+
+ address: +
+
+ String +
+
+ +
+
+ description: +
+
+ String +
+
+ +
+
+ email: +
+
+ String +
+
+ +
+
+ vertical: +
+
+ String +
+
+ +
+
+ websites: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "about": "string",
+  "photoUrl": "string",
+  "address": "string",
+  "description": "string",
+  "email": "string",
+  "vertical": "string",
+  "websites": [
+    "string"
+  ]
+}
+
+ + +
+
+
+
+
+

+ setOrchestratorPaymentInput: object + +

+
+
+
+
+
+ orderID: +
+
+ String +
+
+ + +
+
+

The ID of the affected order.

+
+
+ payment: +
+ +
+ + +
+
+

Payment for the order.

+
+
+
+
+
+
+
Example
+ + + + 
{
+  "orderID": "string",
+  "payment": {
+    "provider": "string",
+    "service": "string"
+  }
+}
+
+ + +
+
+
+
+
+

+ socmedLinkInput: object + +

+
+
+
+
+
+ twitter: +
+
+ String +
+
+ +
+
+ facebook: +
+
+ String +
+
+ +
+
+ instagram: +
+
+ String +
+
+ +
+
+ youtube: +
+
+ String +
+
+ +
+
+ tiktok: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "twitter": "string",
+  "facebook": "string",
+  "instagram": "string",
+  "youtube": "string",
+  "tiktok": "string"
+}
+
+ + +
+
+
+
+
+

+ syncStatusEnum: string + +

+
+
+
+
+
+
object
+ + SUCCESS + + +
+
+
+
object
+ + SYNC + + +
+
+
+
object
+ + FAILED + + +
+
+
+
object
+ + UNPUBLISH + + +
+
+
+
+
+
+
+
+

+ upsertMessageTemplateInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ key: +
+
+ String +
+
+ + +
+
+ id: +
+
+ Int +
+
+ +
+
+ value: +
+
+ String +
+
+ + +
+
+ type: +
+
+ String +
+
+ + +
+
+ status: +
+
+ Boolean +
+
+ + +
+
+ category: +
+
+ String +
+
+ + +
+
+ attachment: +
+
+ String +
+
+ +
+
+ attachmentType: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "key": "string",
+  "id": "number",
+  "value": "string",
+  "type": "string",
+  "status": "boolean",
+  "category": "string",
+  "attachment": "string",
+  "attachmentType": "string"
+}
+
+ + +
+
+
+
+
+

+ upsertMessageTemplatesInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ specs: +
+
+ upsertMessageTemplateInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "specs": [
+    {
+      "sellerId": "string",
+      "key": "string",
+      "id": "number",
+      "value": "string",
+      "type": "string",
+      "status": "boolean",
+      "category": "string",
+      "attachment": "string",
+      "attachmentType": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+

+ upsertQuickReplyInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ +
+
+ id: +
+
+ ID +
+
+ +
+
+ key: +
+
+ String +
+
+ +
+
+ value: +
+
+ String +
+
+ +
+
+ status: +
+
+ String +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "id": "object",
+  "key": "string",
+  "value": "string",
+  "status": "string"
+}
+
+ + +
+
+
+
+
+

+ upsertStoreSettingsInput: object + +

+
+
+
+
+
+ sellerId: +
+
+ String +
+
+ + +
+
+ settings: +
+
+ StoreSettingsInput +
+
+ +
+
+
+
+
+
+
Example
+ + + + 
{
+  "sellerId": "string",
+  "settings": [
+    {
+      "key": "string",
+      "value": "string"
+    }
+  ]
+}
+
+ + +
+
+
+
+
+
+ Documentation by + DociQL + +
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/javascripts/spectacle.js b/javascripts/spectacle.js similarity index 100% rename from docs/javascripts/spectacle.js rename to javascripts/spectacle.js diff --git a/javascripts/spectacle.min.js b/javascripts/spectacle.min.js new file mode 100644 index 00000000..9068ae25 --- /dev/null +++ b/javascripts/spectacle.min.js @@ -0,0 +1 @@ +function Traverse(t,e){this.$element=t,this.options=$.extend({},Traverse.defaults,this.$element.data(),e),this._init()}$(function(){var i,s,a,n,t=$("#sidebar");t.length&&($("#docs"),new Traverse(i=t.find("nav"),{threshold:10,barOffset:t.position().top}),i.on("update.traverse",function(t,e){i.find("section").removeClass("expand");e=e.parents("section:first");e.length&&e.addClass("expand")}),s=$(".drawer-layout"),a=s.find(".drawer"),n=function(){return a.removeClass("slide-right slide-left"),a.find(".drawer-overlay").remove(),s.removeClass("drawer-open drawer-slide-left-large drawer-slide-right-large"),!1},s.find("[data-drawer-slide]").click(function(t){var e=$(this).data("drawer-slide");s.addClass("drawer-open"),a.addClass("slide-"+e);e=$('');return a.append(e),e.click(n),!1}),s.find("[data-drawer-close]").click(n))}),Traverse.defaults={animationDuration:500,animationEasing:"linear",threshold:50,activeClass:"active",deepLinking:!1,barOffset:0},Traverse.prototype._init=function(){var t=this.$element[0].id;this.$targets=$("[data-traverse-target]"),this.$links=this.$element.find("a"),this.$element.attr({"data-resize":t,"data-scroll":t,id:t}),this.$active=$(),this.scrollPos=parseInt(window.pageYOffset,10),this._events()},Traverse.prototype.calcPoints=function(){var i=this,t=document.body,e=document.documentElement;this.points=[],this.winHeight=Math.round(Math.max(window.innerHeight,e.clientHeight)),this.docHeight=Math.round(Math.max(t.scrollHeight,t.offsetHeight,e.clientHeight,e.scrollHeight,e.offsetHeight)),this.$targets.each(function(){var t=$(this),e=t.offset().top;t.targetPoint=e,i.points.push(e)})},Traverse.prototype._events=function(){var e=this,i=$("html, body"),s={duration:e.options.animationDuration,easing:e.options.animationEasing};$(window).one("load",function(){e.calcPoints(),e._updateActive(),$(this).resize(function(t){e.reflow()}).scroll(function(t){e._updateActive()})}),this.$element.on("click",'a[href^="#"]',function(t){t.preventDefault();t=this.getAttribute("href").replace(".","\\."),t=$(t).offset().top-e.options.barOffset;i.stop(!0).animate({scrollTop:t},s)})},Traverse.prototype.reflow=function(){this.calcPoints(),this._updateActive()},Traverse.prototype._updateActive=function(){var i,s,a=parseInt(window.pageYOffset,10);t=a+this.winHeight===this.docHeight?this.points.length-1:a