LiveMart GraphQL based headless eCommerce API API Reference

Sell Anywhere with Custom Storefront & Checkout

API Endpoints

Production:
https://api.livemart.store

Authentication

store-key

Provides Access to API

type

string

name

Store Admin/App Key

header

store-secret

Provides Access to API

type

string

name

Store Admin/App Secret

header

access-token

Provides Access to API

type

string

name

User/Customer access token

header

Store

Store endpoints

Store

Store Update

Update Store

id:

string

(no description)

params:

UpdateStoreParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateStore($id: String!, $params: UpdateStoreParams!){
  updateStore(id: $id, params: $params)
}

Variables

{
  "id": "string",
  "params": {
    "name": "string",
    "title": "string",
    "description": "string",
    "tags": [
      "string"
    ],
    "metaName": "string",
    "metaDescription": "string",
    "metaTags": [
      "string"
    ],
    "logo": "string",
    "favicon": "string",
    "bannerImage": "string",
    "isOpen": "boolean",
    "isCustomerLoyaltyEnabled": "boolean",
    "currency": "string",
    "website": "string",
    "supportEmail": "string",
    "supportPhone": "string",
    "street": "string",
    "streetOptional": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "locationID": "string"
  }
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateStore": "boolean"
  }
}

Store

Store Get by Secret

Get store by Secret

Example

Request Content-Types: application/json

Query

query storeBySecret{
  storeBySecret{
    name
    title
    description
    tags
    metaName
    metaDescription
    metaTags
    logo
    favicon
    bannerImage
    isOpen
    currency
    website
    supportEmail
    supportPhone
    createdAt
    updatedAt
    street
    streetOptional
    city
    state
    postcode
  }
}

Try it now

200 OK

Successful operation

type

PStore

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "storeBySecret": {
      "name": "string",
      "title": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "metaName": "string",
      "metaDescription": "string",
      "metaTags": [
        "string"
      ],
      "logo": "string",
      "favicon": "string",
      "bannerImage": "string",
      "isOpen": "boolean",
      "website": "string",
      "supportEmail": "string",
      "supportPhone": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "street": "string",
      "streetOptional": "string",
      "city": "string",
      "state": "string",
      "postcode": "string"
    }
  }
}

Store

Store Payment Methods

List Store Payment Methods

Example

Request Content-Types: application/json

Query

query paymentMethods{
  paymentMethods{
    id
    displayName
    currencyName
    currencySymbol
    isDigitalPayment
  }
}

Try it now

200 OK

Successful operation

type

PaymentMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "paymentMethods": [
      {
        "id": "string",
        "displayName": "string",
        "currencyName": "string",
        "currencySymbol": "string",
        "isDigitalPayment": "boolean"
      }
    ]
  }
}

Store

Calculate Payment Processing Fee

paymentMethodId:

string

(no description)

cartId:

string

(no description)

shippingMethodId:

string

(no description)

Example

Request Content-Types: application/json

Query

query checkPaymentProcessingFee($paymentMethodId: String!, $cartId: String!, $shippingMethodId: String){
  checkPaymentProcessingFee(paymentMethodId: $paymentMethodId, cartId: $cartId, shippingMethodId: $shippingMethodId)
}

Variables

{
  "paymentMethodId": "string",
  "cartId": "string",
  "shippingMethodId": "string"
}

Try it now

200 OK

Successful operation

type

integer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "checkPaymentProcessingFee": "integer"
  }
}

Store Media

Store Media endpoints

Store Media

Store Media New

New Store Media

bucket:

string

(no description)

contentFile:

object

(no description)

Example

Request Content-Types: application/json

Query

mutation newMedia($bucket: String!, $contentFile: Upload!){
  newMedia(bucket: $bucket, contentFile: $contentFile)
}

Variables

{
  "bucket": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newMedia": "string"
  }
}

Store Media

Store Media List

List Store Media

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query mediaByAdmin($sort: Sort, $pagination: Pagination){
  mediaByAdmin(sort: $sort, pagination: $pagination){
    path
  }
}

Variables

{
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

ShopMedia

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "mediaByAdmin": [
      {
        "path": "string"
      }
    ]
  }
}

Store Media

Store Media Delete

Delete Store Media

path:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation deleteMedia($path: String!){
  deleteMedia(path: $path)
}

Variables

{
  "path": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "deleteMedia": "boolean"
  }
}

Collection

Product collection endpoints

Collection

Collection New

New Collection

params:

NewCollectionParams

(no description)

Example

Request Content-Types: application/json

Query

mutation newCollection($params: NewCollectionParams!){
  newCollection(params: $params){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "params": {
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

Collection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newCollection": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Collection

Collection Update

Update Collection

id:

string

(no description)

params:

UpdateCollectionParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateCollection($id: String!, $params: UpdateCollectionParams!){
  updateCollection(id: $id, params: $params){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "id": "string",
  "params": {
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

Collection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateCollection": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Collection

Collection by Admin

Get Collection by ID as Admin

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query collectionByAdmin($id: String!){
  collectionByAdmin(id: $id){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Collection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "collectionByAdmin": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Collection

Collections by Admin

List collections as Admin

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query collectionsByAdmin($search: Search, $sort: Sort, $pagination: Pagination){
  collectionsByAdmin(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

Collection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "collectionsByAdmin": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "isPublished": "boolean",
        "description": "string",
        "image": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "productCount": "integer",
        "position": "integer"
      }
    ]
  }
}

Collection

Get collection by ID

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query collection($id: String!){
  collection(id: $id){
    id
    name
    slug
    description
    image
    productCount
    position
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

PCollection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "collection": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "image": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Collection

Collections

List collections

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query collections($search: Search, $sort: Sort, $pagination: Pagination){
  collections(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    description
    image
    productCount
    position
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

PCollection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "collections": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "image": "string",
        "productCount": "integer",
        "position": "integer"
      }
    ]
  }
}

Collection

Collection Add products

Add products to collection

collectionId:

string

(no description)

productIds:

string[]

(no description)

Example

Request Content-Types: application/json

Query

mutation collectionAddProducts($collectionId: String!, $productIds: [String!]!){
  collectionAddProducts(collectionId: $collectionId, productIds: $productIds)
}

Variables

{
  "collectionId": "string",
  "productIds": [
    "string"
  ]
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "collectionAddProducts": "boolean"
  }
}

Collection

Collection Remove products

Remove products from collection

collectionId:

string

(no description)

productIds:

string[]

(no description)

Example

Request Content-Types: application/json

Query

mutation collectionRemoveProducts($collectionId: String!, $productIds: [String!]!){
  collectionRemoveProducts(collectionId: $collectionId, productIds: $productIds)
}

Variables

{
  "collectionId": "string",
  "productIds": [
    "string"
  ]
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "collectionRemoveProducts": "boolean"
  }
}

Category

Product categories

Category

Category New

New Category

params:

NewCategoryParams

(no description)

Example

Request Content-Types: application/json

Query

mutation newCategory($params: NewCategoryParams!){
  newCategory(params: $params){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "params": {
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

Category

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newCategory": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Category

Category Update

Update Category

id:

string

(no description)

params:

UpdateCategoryParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateCategory($id: String!, $params: UpdateCategoryParams!){
  updateCategory(id: $id, params: $params){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "id": "string",
  "params": {
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

Category

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateCategory": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Category

Category by Admin

Get Category by ID as Admin

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query categoryByAdmin($id: String!){
  categoryByAdmin(id: $id){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Category

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "categoryByAdmin": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Category

Categories by Admin

List categories as Admin

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query categoriesByAdmin($search: Search, $sort: Sort, $pagination: Pagination){
  categoriesByAdmin(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    isPublished
    description
    image
    createdAt
    updatedAt
    productCount
    position
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

Category

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "categoriesByAdmin": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "isPublished": "boolean",
        "description": "string",
        "image": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "productCount": "integer",
        "position": "integer"
      }
    ]
  }
}

Category

Get category by ID

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query category($id: String!){
  category(id: $id){
    id
    name
    slug
    description
    image
    productCount
    position
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

PCategory

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "category": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "image": "string",
      "productCount": "integer",
      "position": "integer"
    }
  }
}

Category

Product

Store product endpoints

Product

Product New

Creates new product

params:

NewProduct

(no description)

Example

Request Content-Types: application/json

Query

mutation newProduct($params: NewProduct!){
  newProduct(params: $params){
    id
    name
    slug
    description
    isPublished
    sku
    stock
    maxItemPerOrder
    price
    cost
    images
    isDigitalProduct
    views
    createdAt
    weight
    weightUnit
    productUnit
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "params": {
    "name": "string",
    "slug": "string",
    "description": "string",
    "isPublished": "boolean",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "cost": "number",
    "weight": "number",
    "weightUnit": "string",
    "productUnit": "string",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "categoryId": "string",
    "productSpecificDiscount": "number"
  }
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newProduct": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "isPublished": "boolean",
      "sku": "string",
      "stock": "integer",
      "maxItemPerOrder": "integer",
      "price": "integer",
      "cost": "integer",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "integer",
      "createdAt": "string",
      "weight": "number",
      "updatedAt": "string",
      "productSpecificDiscount": "integer"
    }
  }
}

Product

Product Update

Update an existing product by ID

productId:

string

(no description)

params:

UpdateProduct

(no description)

Example

Request Content-Types: application/json

Query

mutation updateProduct($productId: String!, $params: UpdateProduct!){
  updateProduct(productId: $productId, params: $params){
    id
    name
    slug
    description
    isPublished
    sku
    stock
    maxItemPerOrder
    price
    cost
    images
    isDigitalProduct
    views
    createdAt
    weight
    weightUnit
    productUnit
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "productId": "string",
  "params": {
    "name": "string",
    "slug": "string",
    "description": "string",
    "isPublished": "boolean",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "cost": "number",
    "weight": "number",
    "weightUnit": "string",
    "productUnit": "string",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "categoryId": "string",
    "productSpecificDiscount": "number"
  }
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateProduct": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "isPublished": "boolean",
      "sku": "string",
      "stock": "integer",
      "maxItemPerOrder": "integer",
      "price": "integer",
      "cost": "integer",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "integer",
      "createdAt": "string",
      "weight": "number",
      "updatedAt": "string",
      "productSpecificDiscount": "integer"
    }
  }
}

Product

Product as Admin

Get single product by ID as Admin

productId:

string

(no description)

Example

Request Content-Types: application/json

Query

query productByAdmin($productId: String!){
  productByAdmin(productId: $productId){
    id
    name
    slug
    description
    isPublished
    sku
    stock
    maxItemPerOrder
    price
    cost
    images
    isDigitalProduct
    views
    createdAt
    weight
    weightUnit
    productUnit
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "productId": "string"
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productByAdmin": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "isPublished": "boolean",
      "sku": "string",
      "stock": "integer",
      "maxItemPerOrder": "integer",
      "price": "integer",
      "cost": "integer",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "integer",
      "createdAt": "string",
      "weight": "number",
      "updatedAt": "string",
      "productSpecificDiscount": "integer"
    }
  }
}

Product

Products as Admin

List all products as Admin

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query productsByAdmin($search: Search, $sort: Sort, $pagination: Pagination){
  productsByAdmin(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    description
    isPublished
    sku
    stock
    maxItemPerOrder
    price
    cost
    images
    isDigitalProduct
    views
    createdAt
    weight
    weightUnit
    productUnit
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productsByAdmin": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "isPublished": "boolean",
        "sku": "string",
        "stock": "integer",
        "maxItemPerOrder": "integer",
        "price": "integer",
        "cost": "integer",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "integer",
        "createdAt": "string",
        "weight": "number",
        "updatedAt": "string",
        "productSpecificDiscount": "integer"
      }
    ]
  }
}

Product

Search products as Admin

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query productSearchByAdmin($search: Search, $sort: Sort, $pagination: Pagination){
  productSearchByAdmin(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    description
    isPublished
    sku
    stock
    maxItemPerOrder
    price
    cost
    images
    isDigitalProduct
    views
    createdAt
    weight
    weightUnit
    productUnit
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productSearchByAdmin": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "isPublished": "boolean",
        "sku": "string",
        "stock": "integer",
        "maxItemPerOrder": "integer",
        "price": "integer",
        "cost": "integer",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "integer",
        "createdAt": "string",
        "weight": "number",
        "updatedAt": "string",
        "productSpecificDiscount": "integer"
      }
    ]
  }
}

Product

Search products

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query productSearch($search: Search, $sort: Sort, $pagination: Pagination){
  productSearch(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    description
    sku
    stock
    maxItemPerOrder
    price
    images
    isDigitalProduct
    views
    productUnit
    createdAt
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

PProduct

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productSearch": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "sku": "string",
        "stock": "integer",
        "maxItemPerOrder": "integer",
        "price": "integer",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "integer",
        "createdAt": "string",
        "updatedAt": "string",
        "productSpecificDiscount": "integer"
      }
    ]
  }
}

Product

Get single product by ID

Get single product using ID

productId:

string

(no description)

Example

Request Content-Types: application/json

Query

query product($productId: String!){
  product(productId: $productId){
    id
    name
    slug
    description
    sku
    stock
    maxItemPerOrder
    price
    images
    isDigitalProduct
    views
    productUnit
    createdAt
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "productId": "string"
}

Try it now

200 OK

Successful operation

type

PProduct

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "product": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "sku": "string",
      "stock": "integer",
      "maxItemPerOrder": "integer",
      "price": "integer",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "integer",
      "createdAt": "string",
      "updatedAt": "string",
      "productSpecificDiscount": "integer"
    }
  }
}

Product

Get single product by Slug

Get single product using Slug

productSlug:

string

(no description)

Example

Request Content-Types: application/json

Query

query productBySlug($productSlug: String!){
  productBySlug(productSlug: $productSlug){
    id
    name
    slug
    description
    sku
    stock
    maxItemPerOrder
    price
    images
    isDigitalProduct
    views
    productUnit
    createdAt
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "productSlug": "string"
}

Try it now

200 OK

Successful operation

type

PProduct

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productBySlug": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "sku": "string",
      "stock": "integer",
      "maxItemPerOrder": "integer",
      "price": "integer",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "integer",
      "createdAt": "string",
      "updatedAt": "string",
      "productSpecificDiscount": "integer"
    }
  }
}

Product

Products

List all products

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query products($search: Search, $sort: Sort, $pagination: Pagination){
  products(search: $search, sort: $sort, pagination: $pagination){
    id
    name
    slug
    description
    sku
    stock
    maxItemPerOrder
    price
    images
    isDigitalProduct
    views
    productUnit
    createdAt
    updatedAt
    productSpecificDiscount
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

PProduct

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "products": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "sku": "string",
        "stock": "integer",
        "maxItemPerOrder": "integer",
        "price": "integer",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "integer",
        "createdAt": "string",
        "updatedAt": "string",
        "productSpecificDiscount": "integer"
      }
    ]
  }
}

Product

Attribute Add

Add new attribute to a product

productId:

string

(no description)

params:

AddAttributeParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productAddAttribute($productId: String!, $params: AddAttributeParams!){
  productAddAttribute(productId: $productId, params: $params){
    id
    name
    values
    isRequired
    createdAt
    updateAt
  }
}

Variables

{
  "productId": "string",
  "params": {
    "name": "string",
    "values": [
      "string"
    ],
    "isRequired": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

ProductAttribute

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productAddAttribute": {
      "id": "string",
      "name": "string",
      "values": [
        "string"
      ],
      "isRequired": "boolean",
      "createdAt": "string",
      "updateAt": "string"
    }
  }
}

Product

Attribute Update

Update Attribute

productId:

string

(no description)

attributeId:

string

(no description)

params:

UpdateAttributeParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productUpdateAttribute($productId: String!, $attributeId: String!, $params: UpdateAttributeParams!){
  productUpdateAttribute(productId: $productId, attributeId: $attributeId, params: $params){
    id
    name
    values
    isRequired
    createdAt
    updateAt
  }
}

Variables

{
  "productId": "string",
  "attributeId": "string",
  "params": {
    "name": "string",
    "values": [
      "string"
    ],
    "isRequired": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

ProductAttribute

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productUpdateAttribute": {
      "id": "string",
      "name": "string",
      "values": [
        "string"
      ],
      "isRequired": "boolean",
      "createdAt": "string",
      "updateAt": "string"
    }
  }
}

Product

Attribute Remove

Remove Attribute

productId:

string

(no description)

attributeId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation productRemoveAttribute($productId: String!, $attributeId: String!){
  productRemoveAttribute(productId: $productId, attributeId: $attributeId)
}

Variables

{
  "productId": "string",
  "attributeId": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productRemoveAttribute": "boolean"
  }
}

Product

Variation Add

Add new variation to product

productId:

string

(no description)

params:

AddVariationParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productAddVariation($productId: String!, $params: AddVariationParams!){
  productAddVariation(productId: $productId, params: $params){
    id
    name
    price
    cost
    sku
    stock
  }
}

Variables

{
  "productId": "string",
  "params": {
    "name": "string",
    "price": "number",
    "cost": "number",
    "sku": "string",
    "stock": "number",
    "weight": "number",
    "weightUnit": "string"
  }
}

Try it now

200 OK

Successful operation

type

ProductVariation

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productAddVariation": {
      "id": "string",
      "name": "string",
      "price": "integer",
      "cost": "integer",
      "sku": "string",
      "stock": "integer"
    }
  }
}

Product

Variation Update

Update Variation

productId:

string

(no description)

variationId:

string

(no description)

params:

UpdateVariationParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productUpdateVariation($productId: String!, $variationId: String!, $params: UpdateVariationParams!){
  productUpdateVariation(productId: $productId, variationId: $variationId, params: $params){
    id
    name
    price
    cost
    sku
    stock
  }
}

Variables

{
  "productId": "string",
  "variationId": "string",
  "params": {
    "name": "string",
    "price": "number",
    "cost": "number",
    "sku": "string",
    "stock": "number",
    "weight": "number",
    "weightUnit": "string"
  }
}

Try it now

200 OK

Successful operation

type

ProductVariation

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productUpdateVariation": {
      "id": "string",
      "name": "string",
      "price": "integer",
      "cost": "integer",
      "sku": "string",
      "stock": "integer"
    }
  }
}

Product

Variation Remove

Remove Variation

productId:

string

(no description)

variationId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation productRemoveVariation($productId: String!, $variationId: String!){
  productRemoveVariation(productId: $productId, variationId: $variationId)
}

Variables

{
  "productId": "string",
  "variationId": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productRemoveVariation": "boolean"
  }
}

Product

Digital Item Add

Add new digital to product

productId:

string

(no description)

params:

AddDigitalItemParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productAddDigitalItem($productId: String!, $params: AddDigitalItemParams!){
  productAddDigitalItem(productId: $productId, params: $params){
    id
    title
    description
    position
  }
}

Variables

{
  "productId": "string",
  "params": {
    "title": "string",
    "description": "string",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

DigitalItem

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productAddDigitalItem": {
      "id": "string",
      "title": "string",
      "description": "string",
      "position": "integer"
    }
  }
}

Product

Digital Item Update

Update Digital Item

productId:

string

(no description)

itemId:

string

(no description)

params:

UpdateDigitalItemParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productUpdateDigitalItem($productId: String!, $itemId: String!, $params: UpdateDigitalItemParams!){
  productUpdateDigitalItem(productId: $productId, itemId: $itemId, params: $params){
    id
    title
    description
    position
  }
}

Variables

{
  "productId": "string",
  "itemId": "string",
  "params": {
    "title": "string",
    "description": "string",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

DigitalItem

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productUpdateDigitalItem": {
      "id": "string",
      "title": "string",
      "description": "string",
      "position": "integer"
    }
  }
}

Product

Digital Item Remove

Remove Digital Item

productId:

string

(no description)

itemId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation productRemoveDigitalItem($productId: String!, $itemId: String!){
  productRemoveDigitalItem(productId: $productId, itemId: $itemId)
}

Variables

{
  "productId": "string",
  "itemId": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productRemoveDigitalItem": "boolean"
  }
}

Product

Digital Content Add

Add new digital content to product

productId:

string

(no description)

itemId:

string

(no description)

params:

AddDigitalContentParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productAddDigitalContent($productId: String!, $itemId: String!, $params: AddDigitalContentParams!){
  productAddDigitalContent(productId: $productId, itemId: $itemId, params: $params){
    id
    title
    contentType
    isTrialAllowed
    contentText
    contentUrl
    updatedAt
    position
  }
}

Variables

{
  "productId": "string",
  "itemId": "string",
  "params": {
    "title": "string",
    "contentType": "string",
    "isTrialAllowed": "boolean",
    "contentText": "string",
    "contentFile": "object",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

DigitalContent

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productAddDigitalContent": {
      "id": "string",
      "title": "string",
      "isTrialAllowed": "boolean",
      "contentText": "string",
      "contentUrl": "string",
      "updatedAt": "string",
      "position": "integer"
    }
  }
}

Product

Digital Content Update

Update Digital Content

productId:

string

(no description)

itemId:

string

(no description)

contentId:

string

(no description)

params:

UpdateDigitalContentParams

(no description)

Example

Request Content-Types: application/json

Query

mutation productUpdateDigitalContent($productId: String!, $itemId: String!, $contentId: String!, $params: UpdateDigitalContentParams!){
  productUpdateDigitalContent(productId: $productId, itemId: $itemId, contentId: $contentId, params: $params){
    id
    title
    contentType
    isTrialAllowed
    contentText
    contentUrl
    updatedAt
    position
  }
}

Variables

{
  "productId": "string",
  "itemId": "string",
  "contentId": "string",
  "params": {
    "title": "string",
    "contentType": "string",
    "isTrialAllowed": "boolean",
    "contentText": "string",
    "contentFile": "object",
    "position": "number"
  }
}

Try it now

200 OK

Successful operation

type

DigitalContent

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productUpdateDigitalContent": {
      "id": "string",
      "title": "string",
      "isTrialAllowed": "boolean",
      "contentText": "string",
      "contentUrl": "string",
      "updatedAt": "string",
      "position": "integer"
    }
  }
}

Product

Digital Content Remove

Remove Digital Content

productId:

string

(no description)

itemId:

string

(no description)

contentId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation productRemoveDigitalContent($productId: String!, $itemId: String!, $contentId: String!){
  productRemoveDigitalContent(productId: $productId, itemId: $itemId, contentId: $contentId)
}

Variables

{
  "productId": "string",
  "itemId": "string",
  "contentId": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productRemoveDigitalContent": "boolean"
  }
}

Coupon Code

Store coupon code endpoints

Coupon Code

New coupon code

params:

NewCouponCodeParams

(no description)

Example

Request Content-Types: application/json

Query

mutation newCouponCode($params: NewCouponCodeParams!){
  newCouponCode(params: $params){
    id
    code
    amount
    minOrderAmount
    maxDiscountAmount
    isActive
    isFlatDiscount
    isForNewUsersOnly
    isUserSpecific
    maxUsage
    maxUsagePerUser
    discountType
    description
    image
    startAt
    endAt
    createdAt
    updatedAt
  }
}

Variables

{
  "params": {
    "code": "string",
    "amount": "number",
    "minOrderAmount": "number",
    "maxDiscountAmount": "number",
    "isActive": "boolean",
    "isFlatDiscount": "boolean",
    "isForNewUsersOnly": "boolean",
    "isUserSpecific": "boolean",
    "maxUsage": "number",
    "maxUsagePerUser": "number",
    "discountType": "string",
    "description": "string",
    "image": "string",
    "startAt": "string",
    "endAt": "string",
    "customers": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

CouponCode

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newCouponCode": {
      "id": "string",
      "code": "string",
      "amount": "integer",
      "minOrderAmount": "integer",
      "maxDiscountAmount": "integer",
      "isActive": "boolean",
      "isFlatDiscount": "boolean",
      "isForNewUsersOnly": "boolean",
      "isUserSpecific": "boolean",
      "maxUsage": "integer",
      "maxUsagePerUser": "integer",
      "description": "string",
      "image": "string",
      "startAt": "string",
      "endAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Coupon Code

Update coupon code

id:

string

(no description)

params:

UpdateCouponCodeParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateCouponCode($id: String!, $params: UpdateCouponCodeParams!){
  updateCouponCode(id: $id, params: $params){
    id
    code
    amount
    minOrderAmount
    maxDiscountAmount
    isActive
    isFlatDiscount
    isForNewUsersOnly
    isUserSpecific
    maxUsage
    maxUsagePerUser
    discountType
    description
    image
    startAt
    endAt
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "string",
  "params": {
    "code": "string",
    "amount": "number",
    "minOrderAmount": "number",
    "maxDiscountAmount": "number",
    "isActive": "boolean",
    "isFlatDiscount": "boolean",
    "isForNewUsersOnly": "boolean",
    "isUserSpecific": "boolean",
    "maxUsage": "number",
    "maxUsagePerUser": "number",
    "discountType": "string",
    "description": "string",
    "image": "string",
    "startAt": "string",
    "endAt": "string",
    "customers": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

CouponCode

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateCouponCode": {
      "id": "string",
      "code": "string",
      "amount": "integer",
      "minOrderAmount": "integer",
      "maxDiscountAmount": "integer",
      "isActive": "boolean",
      "isFlatDiscount": "boolean",
      "isForNewUsersOnly": "boolean",
      "isUserSpecific": "boolean",
      "maxUsage": "integer",
      "maxUsagePerUser": "integer",
      "description": "string",
      "image": "string",
      "startAt": "string",
      "endAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Coupon Code

Delete coupon code

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation deleteCouponCode($id: String!){
  deleteCouponCode(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "deleteCouponCode": "boolean"
  }
}

Coupon Code

Get coupon code

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query couponCode($id: String!){
  couponCode(id: $id){
    id
    code
    amount
    minOrderAmount
    maxDiscountAmount
    isActive
    isFlatDiscount
    isForNewUsersOnly
    isUserSpecific
    maxUsage
    maxUsagePerUser
    discountType
    description
    image
    startAt
    endAt
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

CouponCode

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "couponCode": {
      "id": "string",
      "code": "string",
      "amount": "integer",
      "minOrderAmount": "integer",
      "maxDiscountAmount": "integer",
      "isActive": "boolean",
      "isFlatDiscount": "boolean",
      "isForNewUsersOnly": "boolean",
      "isUserSpecific": "boolean",
      "maxUsage": "integer",
      "maxUsagePerUser": "integer",
      "description": "string",
      "image": "string",
      "startAt": "string",
      "endAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Coupon Code

List coupon codes

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query couponCodes($search: Search, $sort: Sort, $pagination: Pagination){
  couponCodes(search: $search, sort: $sort, pagination: $pagination){
    id
    code
    amount
    minOrderAmount
    maxDiscountAmount
    isActive
    isFlatDiscount
    isForNewUsersOnly
    isUserSpecific
    maxUsage
    maxUsagePerUser
    discountType
    description
    image
    startAt
    endAt
    createdAt
    updatedAt
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

CouponCode

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "couponCodes": [
      {
        "id": "string",
        "code": "string",
        "amount": "integer",
        "minOrderAmount": "integer",
        "maxDiscountAmount": "integer",
        "isActive": "boolean",
        "isFlatDiscount": "boolean",
        "isForNewUsersOnly": "boolean",
        "isUserSpecific": "boolean",
        "maxUsage": "integer",
        "maxUsagePerUser": "integer",
        "description": "string",
        "image": "string",
        "startAt": "string",
        "endAt": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Coupon Code

Check Discount Amount

couponCode:

string

(no description)

cartId:

string

(no description)

shippingMethodId:

string

(no description)

Example

Request Content-Types: application/json

Query

query checkDiscount($couponCode: String!, $cartId: String!, $shippingMethodId: String){
  checkDiscount(couponCode: $couponCode, cartId: $cartId, shippingMethodId: $shippingMethodId)
}

Variables

{
  "couponCode": "string",
  "cartId": "string",
  "shippingMethodId": "string"
}

Try it now

200 OK

Successful operation

type

integer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "checkDiscount": "integer"
  }
}

Cart

Store carts endpoints

Cart

Cart New

New Cart

params:

NewCartParams

(no description)

Example

Request Content-Types: application/json

Query

mutation newCart($params: NewCartParams!){
  newCart(params: $params){
    id
    isShippingRequired
  }
}

Variables

{
  "params": {
    "cartItems": [
      {
        "productId": "string",
        "productAttributes": [
          {
            "Id": "string",
            "attributeSelectedValue": "string"
          }
        ],
        "productVariationId": "string",
        "quantity": "number"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

PCart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newCart": {
      "id": "string",
      "isShippingRequired": "boolean"
    }
  }
}

Cart

Cart Update

Update Cart

id:

string

(no description)

params:

UpdateCartParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateCart($id: String!, $params: UpdateCartParams!){
  updateCart(id: $id, params: $params){
    id
    isShippingRequired
  }
}

Variables

{
  "id": "string",
  "params": {
    "cartItems": [
      {
        "productId": "string",
        "productAttributes": [
          {
            "Id": "string",
            "attributeSelectedValue": "string"
          }
        ],
        "productVariationId": "string",
        "quantity": "number"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

PCart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateCart": {
      "id": "string",
      "isShippingRequired": "boolean"
    }
  }
}

Cart

Cart Get

Get Cart by ID

cartId:

string

(no description)

Example

Request Content-Types: application/json

Query

query cart($cartId: String!){
  cart(cartId: $cartId){
    id
    isShippingRequired
  }
}

Variables

{
  "cartId": "string"
}

Try it now

200 OK

Successful operation

type

PCart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "cart": {
      "id": "string",
      "isShippingRequired": "boolean"
    }
  }
}

Cart

Cart List by Admin

List Abandoned Carts

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query abandonedCarts($pagination: Pagination){
  abandonedCarts(pagination: $pagination){
    id
    isShippingRequired
  }
}

Variables

{
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

Cart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "abandonedCarts": [
      {
        "id": "string",
        "isShippingRequired": "boolean"
      }
    ]
  }
}

Order

Store Orders

Order

Order checkout by Customer

Place order for checkout by Customer

params:

PlaceOrderParams

(no description)

Example

Request Content-Types: application/json

Query

mutation orderCheckout($params: PlaceOrderParams){
  orderCheckout(params: $params){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "params": {
    "cartId": "string",
    "billingAddress": {
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "locationId": "string"
    },
    "shippingAddress": {
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "locationId": "string"
    },
    "paymentMethodId": "string",
    "shippingMethodId": "string",
    "couponCode": "string"
  }
}

Try it now

200 OK

Successful operation

type

POrder

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderCheckout": {
      "id": "string",
      "hash": "string",
      "shippingCharge": "integer",
      "paymentProcessingFee": "integer",
      "subtotal": "integer",
      "grandTotal": "integer",
      "discountedAmount": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Order

Order checkout by Admin

Place order for checkout by Admin

params:

PlaceOrderByAdminParams

(no description)

Example

Request Content-Types: application/json

Query

mutation orderCheckoutByAdmin($params: PlaceOrderByAdminParams){
  orderCheckoutByAdmin(params: $params){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "params": {
    "cartId": "string",
    "billingAddress": {
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "locationId": "string"
    },
    "shippingAddress": {
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "locationId": "string"
    },
    "paymentMethodId": "string",
    "shippingMethodId": "string",
    "couponCode": "string",
    "customerId": "string"
  }
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderCheckoutByAdmin": {
      "id": "string",
      "hash": "string",
      "shippingCharge": "integer",
      "paymentProcessingFee": "integer",
      "subtotal": "integer",
      "grandTotal": "integer",
      "discountedAmount": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Order

Order update by Admin

Update order by Admin

id:

string

(no description)

params:

OrderUpdateParams

(no description)

Example

Request Content-Types: application/json

Query

mutation orderUpdateByAdmin($id: String!, $params: OrderUpdateParams!){
  orderUpdateByAdmin(id: $id, params: $params){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "string",
  "params": {
    "status": "string",
    "paymentStatus": "string",
    "payments": [
      {
        "payableAmount": "number"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderUpdateByAdmin": {
      "id": "string",
      "hash": "string",
      "shippingCharge": "integer",
      "paymentProcessingFee": "integer",
      "subtotal": "integer",
      "grandTotal": "integer",
      "discountedAmount": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Order

Order Get

Get order by Hash as Customer

hash:

string

(no description)

Example

Request Content-Types: application/json

Query

query order($hash: String!){
  order(hash: $hash){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "hash": "string"
}

Try it now

200 OK

Successful operation

type

POrder

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "order": {
      "id": "string",
      "hash": "string",
      "shippingCharge": "integer",
      "paymentProcessingFee": "integer",
      "subtotal": "integer",
      "grandTotal": "integer",
      "discountedAmount": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Order

Order Get by ID as Admin

Get Order by ID by Admin

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query orderByAdmin($id: String!){
  orderByAdmin(id: $id){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderByAdmin": {
      "id": "string",
      "hash": "string",
      "shippingCharge": "integer",
      "paymentProcessingFee": "integer",
      "subtotal": "integer",
      "grandTotal": "integer",
      "discountedAmount": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Order

Order List as Customer

List orders as Customer

params:

POrderSearchParams

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query orders($params: POrderSearchParams, $sort: Sort, $pagination: Pagination){
  orders(params: $params, sort: $sort, pagination: $pagination){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "params": {
    "shopName": "string",
    "orderHash": "string"
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

POrder

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orders": [
      {
        "id": "string",
        "hash": "string",
        "shippingCharge": "integer",
        "paymentProcessingFee": "integer",
        "subtotal": "integer",
        "grandTotal": "integer",
        "discountedAmount": "integer",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Order

Order List as Admin

List orders as Admin

params:

OrderSearchParams

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query ordersByAdmin($params: OrderSearchParams, $sort: Sort, $pagination: Pagination){
  ordersByAdmin(params: $params, sort: $sort, pagination: $pagination){
    id
    hash
    shippingCharge
    paymentProcessingFee
    subtotal
    grandTotal
    discountedAmount
    status
    paymentStatus
    createdAt
    updatedAt
  }
}

Variables

{
  "params": {
    "customerEmail": "string",
    "orderHash": "string"
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ordersByAdmin": [
      {
        "id": "string",
        "hash": "string",
        "shippingCharge": "integer",
        "paymentProcessingFee": "integer",
        "subtotal": "integer",
        "grandTotal": "integer",
        "discountedAmount": "integer",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Order

Generate Payment Nonce

Generate payment nonce for specific order

orderId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation orderGeneratePaymentNonce($orderId: String!){
  orderGeneratePaymentNonce(orderId: $orderId){
    PaymentGatewayName
    Nonce
    StripePublishableKey
  }
}

Variables

{
  "orderId": "string"
}

Try it now

200 OK

Successful operation

type

GeneratePaymentNoneResponse

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderGeneratePaymentNonce": {
      "PaymentGatewayName": "string",
      "Nonce": "string",
      "StripePublishableKey": "string"
    }
  }
}

Order

List product digital contents

productId:

string

(no description)

itemId:

string

(no description)

Example

Request Content-Types: application/json

Query

query productDigitalContents($productId: String!, $itemId: String!){
  productDigitalContents(productId: $productId, itemId: $itemId){
    id
    title
    contentType
    isTrialAllowed
    contentText
    contentUrl
    updatedAt
    position
  }
}

Variables

{
  "productId": "string",
  "itemId": "string"
}

Try it now

200 OK

Successful operation

type

DigitalContent

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productDigitalContents": [
      {
        "id": "string",
        "title": "string",
        "isTrialAllowed": "boolean",
        "contentText": "string",
        "contentUrl": "string",
        "updatedAt": "string",
        "position": "integer"
      }
    ]
  }
}

Order

List product digital contents by customer

orderHash:

string

(no description)

productId:

string

(no description)

itemId:

string

(no description)

Example

Request Content-Types: application/json

Query

query productDigitalContentsByCustomer($orderHash: String!, $productId: String!, $itemId: String!){
  productDigitalContentsByCustomer(orderHash: $orderHash, productId: $productId, itemId: $itemId){
    id
    title
    contentType
    isTrialAllowed
    contentText
    contentUrl
    updatedAt
    position
  }
}

Variables

{
  "orderHash": "string",
  "productId": "string",
  "itemId": "string"
}

Try it now

200 OK

Successful operation

type

DigitalContent

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productDigitalContentsByCustomer": [
      {
        "id": "string",
        "title": "string",
        "isTrialAllowed": "boolean",
        "contentText": "string",
        "contentUrl": "string",
        "updatedAt": "string",
        "position": "integer"
      }
    ]
  }
}

Order

Get product digital content by admin

productId:

string

(no description)

itemId:

string

(no description)

contentId:

string

(no description)

Example

Request Content-Types: application/json

Query

query productDigitalContentByAdmin($productId: String!, $itemId: String!, $contentId: String!){
  productDigitalContentByAdmin(productId: $productId, itemId: $itemId, contentId: $contentId){
    id
    title
    contentType
    isTrialAllowed
    contentText
    contentUrl
    updatedAt
    position
  }
}

Variables

{
  "productId": "string",
  "itemId": "string",
  "contentId": "string"
}

Try it now

200 OK

Successful operation

type

DigitalContent

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productDigitalContentByAdmin": {
      "id": "string",
      "title": "string",
      "isTrialAllowed": "boolean",
      "contentText": "string",
      "contentUrl": "string",
      "updatedAt": "string",
      "position": "integer"
    }
  }
}

Order

List product digital items by customer

Get product digital items by customer

orderHash:

string

(no description)

productId:

string

(no description)

Example

Request Content-Types: application/json

Query

query productDigitalItemsByCustomer($orderHash: String!, $productId: String!){
  productDigitalItemsByCustomer(orderHash: $orderHash, productId: $productId){
    id
    title
    description
    position
  }
}

Variables

{
  "orderHash": "string",
  "productId": "string"
}

Try it now

200 OK

Successful operation

type

DigitalItem

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productDigitalItemsByCustomer": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "position": "integer"
      }
    ]
  }
}

Order

Generate Digital Content

Generate digital content for specific order's product item

hash:

string

(no description)

productId:

string

(no description)

itemId:

string

(no description)

contentId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation orderGenerateDigitalContent($hash: String!, $productId: String!, $itemId: String!, $contentId: String!){
  orderGenerateDigitalContent(hash: $hash, productId: $productId, itemId: $itemId, contentId: $contentId){
    type
    content
    contentUrl
  }
}

Variables

{
  "hash": "string",
  "productId": "string",
  "itemId": "string",
  "contentId": "string"
}

Try it now

200 OK

Successful operation

type

OrderGenerateDigitalContent

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderGenerateDigitalContent": {
      "content": "string",
      "contentUrl": "string"
    }
  }
}

Order

Add Feedback

Add feedback

hash:

string

(no description)

params:

AddFeedbackParams

(no description)

Example

Request Content-Types: application/json

Query

mutation orderAddFeedback($hash: String!, $params: AddFeedbackParams!){
  orderAddFeedback(hash: $hash, params: $params){
    rating
    comment
    createdAt
  }
}

Variables

{
  "hash": "string",
  "params": {
    "rating": "number",
    "comment": "string"
  }
}

Try it now

200 OK

Successful operation

type

Feedback

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orderAddFeedback": {
      "rating": "integer",
      "comment": "string",
      "createdAt": "string"
    }
  }
}

Report

Store Report

Report

Get store report

params:

ReportParams

(no description)

Example

Request Content-Types: application/json

Query

query report($params: ReportParams){
  report(params: $params){
    totalSale
    totalSalePending
    totalCost
    totalOrders
    totalOrdersPending
    totalCustomers
    totalDiscount
    totalDue
  }
}

Variables

{
  "params": {
    "startDate": "string",
    "endDate": "string"
  }
}

Try it now

200 OK

Successful operation

type

Report

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "report": {
      "totalSale": "integer",
      "totalSalePending": "integer",
      "totalCost": "integer",
      "totalOrders": "integer",
      "totalOrdersPending": "integer",
      "totalCustomers": "integer",
      "totalDiscount": "integer",
      "totalDue": "integer"
    }
  }
}

Location

Available locations

Location

Locations List

List locations

Example

Request Content-Types: application/json

Query

query locations{
  locations{
    id
    name
    shortCode
  }
}

Try it now

200 OK

Successful operation

type

Location

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "locations": [
      {
        "id": "string",
        "name": "string",
        "shortCode": "string"
      }
    ]
  }
}

Location

Location by ID

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query locationById($id: String!){
  locationById(id: $id){
    id
    name
    shortCode
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Location

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "locationById": {
      "id": "string",
      "name": "string",
      "shortCode": "string"
    }
  }
}

Customer

Store Customers

Customer

Customer Register

params:

RegisterCustomerParams

(no description)

Example

Request Content-Types: application/json

Query

mutation customerRegister($params: RegisterCustomerParams){
  customerRegister(params: $params){
    accessToken
  }
}

Variables

{
  "params": {
    "email": "string",
    "password": "string",
    "phone": "string",
    "firstName": "string",
    "lastName": "string",
    "profilePicture": "string"
  }
}

Try it now

200 OK

Successful operation

type

RegisterCustomerResponse

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerRegister": {
      "accessToken": "string"
    }
  }
}

Customer

Customer Login

params:

LoginCustomerParams

(no description)

Example

Request Content-Types: application/json

Query

mutation customerLogin($params: LoginCustomerParams){
  customerLogin(params: $params){
    accessToken
    refreshToken
  }
}

Variables

{
  "params": {
    "email": "string",
    "password": "string"
  }
}

Try it now

200 OK

Successful operation

type

LoginCustomerResponse

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerLogin": {
      "accessToken": "string",
      "refreshToken": "string"
    }
  }
}

Customer

Customer Reset Password Request

params:

CustomerResetPasswordRequestParams

(no description)

Example

Request Content-Types: application/json

Query

mutation customerResetPasswordRequest($params: CustomerResetPasswordRequestParams!){
  customerResetPasswordRequest(params: $params)
}

Variables

{
  "params": {
    "email": "string"
  }
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerResetPasswordRequest": "boolean"
  }
}

Customer

Customer Reset Password

params:

CustomerResetPasswordParams

(no description)

Example

Request Content-Types: application/json

Query

mutation customerResetPassword($params: CustomerResetPasswordParams!){
  customerResetPassword(params: $params)
}

Variables

{
  "params": {
    "email": "string",
    "resetToken": "string",
    "newPassword": "string"
  }
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerResetPassword": "boolean"
  }
}

Customer

Customer Change Password

params:

CustomerChangePasswordParams

(no description)

Example

Request Content-Types: application/json

Query

mutation customerChangePassword($params: CustomerChangePasswordParams!){
  customerChangePassword(params: $params)
}

Variables

{
  "params": {
    "oldPassword": "string",
    "newPassword": "string"
  }
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerChangePassword": "boolean"
  }
}

Customer

Customer Profile

Example

Request Content-Types: application/json

Query

query customerProfile{
  customerProfile{
    email
    phone
    firstName
    lastName
    profilePicture
  }
}

Try it now

200 OK

Successful operation

type

Customer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerProfile": {
      "email": "string",
      "phone": "string",
      "firstName": "string",
      "lastName": "string",
      "profilePicture": "string"
    }
  }
}

Customer

Customer Update Profile

params:

UpdateCustomerParams

(no description)

Example

Request Content-Types: application/json

Query

mutation customerUpdateProfile($params: UpdateCustomerParams!){
  customerUpdateProfile(params: $params){
    email
    phone
    firstName
    lastName
    profilePicture
  }
}

Variables

{
  "params": {
    "phone": "string",
    "firstName": "string",
    "lastName": "string",
    "profilePicture": "string"
  }
}

Try it now

200 OK

Successful operation

type

Customer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customerUpdateProfile": {
      "email": "string",
      "phone": "string",
      "firstName": "string",
      "lastName": "string",
      "profilePicture": "string"
    }
  }
}

Customer

Customer List

params:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query customersByAdmin($params: Search, $sort: Sort, $pagination: Pagination){
  customersByAdmin(params: $params, sort: $sort, pagination: $pagination){
    id
    email
    phone
    firstName
    lastName
    profilePicture
    due
  }
}

Variables

{
  "params": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

SCustomer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customersByAdmin": [
      {
        "id": "string",
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string",
        "profilePicture": "string",
        "due": "integer"
      }
    ]
  }
}

Blog

Store Blog

Blog

Blog Post create

Blog Post Create

params:

NewBlogPostParams

(no description)

Example

Request Content-Types: application/json

Query

mutation newBlogPost($params: NewBlogPostParams!){
  newBlogPost(params: $params){
    id
    title
    slug
    bannerImage
    content
    tags
    isPublished
    isFeatured
    views
    favourites
    createdAt
    updatedAt
  }
}

Variables

{
  "params": {
    "title": "string",
    "slug": "string",
    "bannerImage": "string",
    "content": "string",
    "tags": [
      "string"
    ],
    "isPublished": "boolean",
    "isFeatured": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

BlogPost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newBlogPost": {
      "id": "string",
      "title": "string",
      "slug": "string",
      "bannerImage": "string",
      "content": "string",
      "tags": [
        "string"
      ],
      "isPublished": "boolean",
      "isFeatured": "boolean",
      "views": "integer",
      "favourites": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Blog

Blog Post update

Blog Post Update

postId:

string

(no description)

params:

UpdateBlogPostParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateBlogPost($postId: String!, $params: UpdateBlogPostParams!){
  updateBlogPost(postId: $postId, params: $params){
    id
    title
    slug
    bannerImage
    content
    tags
    isPublished
    isFeatured
    views
    favourites
    createdAt
    updatedAt
  }
}

Variables

{
  "postId": "string",
  "params": {
    "title": "string",
    "slug": "string",
    "bannerImage": "string",
    "content": "string",
    "tags": [
      "string"
    ],
    "isPublished": "boolean",
    "isFeatured": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

BlogPost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateBlogPost": {
      "id": "string",
      "title": "string",
      "slug": "string",
      "bannerImage": "string",
      "content": "string",
      "tags": [
        "string"
      ],
      "isPublished": "boolean",
      "isFeatured": "boolean",
      "views": "integer",
      "favourites": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Blog

Blog Post Get by Admin

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query blogPostByAdmin($id: String!){
  blogPostByAdmin(id: $id){
    id
    title
    slug
    bannerImage
    content
    tags
    isPublished
    isFeatured
    views
    favourites
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

BlogPost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPostByAdmin": {
      "id": "string",
      "title": "string",
      "slug": "string",
      "bannerImage": "string",
      "content": "string",
      "tags": [
        "string"
      ],
      "isPublished": "boolean",
      "isFeatured": "boolean",
      "views": "integer",
      "favourites": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Blog

Blog Post Get

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query blogPost($id: String!){
  blogPost(id: $id){
    id
    title
    slug
    bannerImage
    content
    tags
    isPublished
    isFeatured
    views
    favourites
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

PBlogPost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPost": {
      "id": "string",
      "title": "string",
      "slug": "string",
      "bannerImage": "string",
      "content": "string",
      "tags": [
        "string"
      ],
      "isPublished": "boolean",
      "isFeatured": "boolean",
      "views": "integer",
      "favourites": "integer",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Blog

Blog Post List by Admin

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query blogPostsByAdmin($search: Search, $sort: Sort, $pagination: Pagination){
  blogPostsByAdmin(search: $search, sort: $sort, pagination: $pagination){
    id
    title
    slug
    bannerImage
    content
    tags
    isPublished
    isFeatured
    views
    favourites
    createdAt
    updatedAt
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

BlogPost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPostsByAdmin": [
      {
        "id": "string",
        "title": "string",
        "slug": "string",
        "bannerImage": "string",
        "content": "string",
        "tags": [
          "string"
        ],
        "isPublished": "boolean",
        "isFeatured": "boolean",
        "views": "integer",
        "favourites": "integer",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Blog

Blog Post List

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query blogPosts($search: Search, $sort: Sort, $pagination: Pagination){
  blogPosts(search: $search, sort: $sort, pagination: $pagination){
    id
    title
    slug
    bannerImage
    content
    tags
    isPublished
    isFeatured
    views
    favourites
    createdAt
    updatedAt
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

PBlogPost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPosts": [
      {
        "id": "string",
        "title": "string",
        "slug": "string",
        "bannerImage": "string",
        "content": "string",
        "tags": [
          "string"
        ],
        "isPublished": "boolean",
        "isFeatured": "boolean",
        "views": "integer",
        "favourites": "integer",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Blog

Blog Post Add Comment

postId:

string

(no description)

params:

AddBlogPostComment

(no description)

Example

Request Content-Types: application/json

Query

mutation blogPostAddComment($postId: String!, $params: AddBlogPostComment){
  blogPostAddComment(postId: $postId, params: $params){
    id
    content
    createdAt
    updatedAt
  }
}

Variables

{
  "postId": "string",
  "params": {
    "content": "string"
  }
}

Try it now

200 OK

Successful operation

type

BlogPostComment

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPostAddComment": {
      "id": "string",
      "content": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Blog

Blog Post Update Comment

postId:

string

(no description)

commentId:

string

(no description)

params:

UpdateBlogPostComment

(no description)

Example

Request Content-Types: application/json

Query

mutation blogPostUpdateComment($postId: String!, $commentId: String!, $params: UpdateBlogPostComment){
  blogPostUpdateComment(postId: $postId, commentId: $commentId, params: $params){
    id
    content
    createdAt
    updatedAt
  }
}

Variables

{
  "postId": "string",
  "commentId": "string",
  "params": {
    "content": "string"
  }
}

Try it now

200 OK

Successful operation

type

BlogPostComment

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPostUpdateComment": {
      "id": "string",
      "content": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Blog

Blog Post Delete Comment

postId:

string

(no description)

commentId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation blogPostDeleteComment($postId: String!, $commentId: String!){
  blogPostDeleteComment(postId: $postId, commentId: $commentId)
}

Variables

{
  "postId": "string",
  "commentId": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blogPostDeleteComment": "boolean"
  }
}

Shipping Method

Store Shipping Method

Shipping Method

Shipping Method New

params:

NewShippingMethodParams

(no description)

Example

Request Content-Types: application/json

Query

mutation newShippingMethod($params: NewShippingMethodParams!){
  newShippingMethod(params: $params){
    id
    displayName
    deliveryCharge
    deliveryTimeInDays
    WeightUnit
    isFlat
    isActive
  }
}

Variables

{
  "params": {
    "displayName": "string",
    "deliveryCharge": "number",
    "deliveryTimeInDays": "number",
    "WeightUnit": "string",
    "isFlat": "boolean",
    "isActive": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

ShippingMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "newShippingMethod": {
      "id": "string",
      "displayName": "string",
      "deliveryCharge": "integer",
      "deliveryTimeInDays": "integer",
      "isFlat": "boolean",
      "isActive": "boolean"
    }
  }
}

Shipping Method

Shipping Method Update

id:

string

(no description)

params:

UpdateShippingMethodParams

(no description)

Example

Request Content-Types: application/json

Query

mutation updateShippingMethod($id: String!, $params: UpdateShippingMethodParams!){
  updateShippingMethod(id: $id, params: $params){
    id
    displayName
    deliveryCharge
    deliveryTimeInDays
    WeightUnit
    isFlat
    isActive
  }
}

Variables

{
  "id": "string",
  "params": {
    "displayName": "string",
    "deliveryCharge": "number",
    "deliveryTimeInDays": "number",
    "WeightUnit": "string",
    "isFlat": "boolean",
    "isActive": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

ShippingMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateShippingMethod": {
      "id": "string",
      "displayName": "string",
      "deliveryCharge": "integer",
      "deliveryTimeInDays": "integer",
      "isFlat": "boolean",
      "isActive": "boolean"
    }
  }
}

Shipping Method

Shipping Method Delete

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation deleteShippingMethod($id: String!){
  deleteShippingMethod(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "deleteShippingMethod": "boolean"
  }
}

Shipping Method

Shipping Method List as Admin

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query shippingMethodsByAdmin($search: Search, $sort: Sort, $pagination: Pagination){
  shippingMethodsByAdmin(search: $search, sort: $sort, pagination: $pagination){
    id
    displayName
    deliveryCharge
    deliveryTimeInDays
    WeightUnit
    isFlat
    isActive
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

ShippingMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "shippingMethodsByAdmin": [
      {
        "id": "string",
        "displayName": "string",
        "deliveryCharge": "integer",
        "deliveryTimeInDays": "integer",
        "isFlat": "boolean",
        "isActive": "boolean"
      }
    ]
  }
}

Shipping Method

Shipping Method Get as Admin

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query shippingMethodByAdmin($id: String!){
  shippingMethodByAdmin(id: $id){
    id
    displayName
    deliveryCharge
    deliveryTimeInDays
    WeightUnit
    isFlat
    isActive
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

ShippingMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "shippingMethodByAdmin": {
      "id": "string",
      "displayName": "string",
      "deliveryCharge": "integer",
      "deliveryTimeInDays": "integer",
      "isFlat": "boolean",
      "isActive": "boolean"
    }
  }
}

Shipping Method

Shipping Method List

search:

(no description)

sort:

Sort

(no description)

pagination:

Pagination

(no description)

Example

Request Content-Types: application/json

Query

query shippingMethods($search: Search, $sort: Sort, $pagination: Pagination){
  shippingMethods(search: $search, sort: $sort, pagination: $pagination){
    id
    displayName
    deliveryCharge
    deliveryTimeInDays
    WeightUnit
    isFlat
    isActive
  }
}

Variables

{
  "search": {
    "query": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sort": {
    "by": "string",
    "direction": "string"
  },
  "pagination": {
    "perPage": "number",
    "page": "number"
  }
}

Try it now

200 OK

Successful operation

type

ShippingMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "shippingMethods": [
      {
        "id": "string",
        "displayName": "string",
        "deliveryCharge": "integer",
        "deliveryTimeInDays": "integer",
        "isFlat": "boolean",
        "isActive": "boolean"
      }
    ]
  }
}

Shipping Method

Shipping Method Get

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query shippingMethod($id: String!){
  shippingMethod(id: $id){
    id
    displayName
    deliveryCharge
    deliveryTimeInDays
    WeightUnit
    isFlat
    isActive
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

ShippingMethod

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "shippingMethod": {
      "id": "string",
      "displayName": "string",
      "deliveryCharge": "integer",
      "deliveryTimeInDays": "integer",
      "isFlat": "boolean",
      "isActive": "boolean"
    }
  }
}

Shipping Method

Calculate Shipping Charge

shippingMethodId:

string

(no description)

cartId:

string

(no description)

Example

Request Content-Types: application/json

Query

query checkShippingCharge($shippingMethodId: String!, $cartId: String!){
  checkShippingCharge(shippingMethodId: $shippingMethodId, cartId: $cartId)
}

Variables

{
  "shippingMethodId": "string",
  "cartId": "string"
}

Try it now

200 OK

Successful operation

type

integer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "checkShippingCharge": "integer"
  }
}

Schema Definitions

AddAttributeParams: object

name: String
values: String
isRequired: Boolean

Example

{
  "name": "string",
  "values": [
    "string"
  ],
  "isRequired": "boolean"
}

AddAttributeResponse: object

attribute: ProductAttribute

Example

{
  "attribute": {
    "id": "string",
    "name": "string",
    "values": [
      "string"
    ],
    "isRequired": "boolean",
    "createdAt": "string",
    "updateAt": "string"
  }
}

AddAttributeToProductParams: object

productId: String
attribute: AddAttributeParams

Example

{
  "productId": "string",
  "attribute": {
    "name": "string",
    "values": [
      "string"
    ],
    "isRequired": "boolean"
  }
}

AddBlogPostComment: object

content: String

Example

{
  "content": "string"
}

AddBlogPostCommentResponse: object

comment: BlogPostComment

Example

{
  "comment": {
    "id": "string",
    "content": "string",
    "customer": {
      "email": "string",
      "phone": "string",
      "firstName": "string",
      "lastName": "string",
      "profilePicture": "string"
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

AddCouponCodeResponse: object

coupon: CouponCode

Example

{
  "coupon": {
    "id": "string",
    "code": "string",
    "amount": "number",
    "minOrderAmount": "number",
    "maxDiscountAmount": "number",
    "isActive": "boolean",
    "isFlatDiscount": "boolean",
    "isForNewUsersOnly": "boolean",
    "isUserSpecific": "boolean",
    "maxUsage": "number",
    "maxUsagePerUser": "number",
    "discountType": "string",
    "description": "string",
    "image": "string",
    "startAt": "string",
    "endAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "customers": [
      {
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string",
        "profilePicture": "string"
      }
    ]
  }
}

AddDigitalContentParams: object

title: String
contentType: DigitalContentType
isTrialAllowed: Boolean
contentText: String
contentFile: Upload
position: Int

Example

{
  "title": "string",
  "contentType": "string",
  "isTrialAllowed": "boolean",
  "contentText": "string",
  "contentFile": "object",
  "position": "number"
}

AddDigitalItemParams: object

title: String
description: String
position: Int

Example

{
  "title": "string",
  "description": "string",
  "position": "number"
}

AddFeedbackParams: object

rating: Int
comment: String

Example

{
  "rating": "number",
  "comment": "string"
}

AddProductsToCollectionParams: object

collectionId: String
productIds: String

Example

{
  "collectionId": "string",
  "productIds": [
    "string"
  ]
}

AddVariationParams: object

name: String
price: Int
cost: Int
sku: String
stock: Int
weight: Float
weightUnit: WeightUnit

Example

{
  "name": "string",
  "price": "number",
  "cost": "number",
  "sku": "string",
  "stock": "number",
  "weight": "number",
  "weightUnit": "string"
}

AddVariationResponse: object

variation: ProductVariation

Example

{
  "variation": {
    "id": "string",
    "name": "string",
    "price": "number",
    "cost": "number",
    "sku": "string",
    "stock": "number"
  }
}

AddVariationToProductParams: object

productId: String
variation: AddVariationParams

Example

{
  "productId": "string",
  "variation": {
    "name": "string",
    "price": "number",
    "cost": "number",
    "sku": "string",
    "stock": "number",
    "weight": "number",
    "weightUnit": "string"
  }
}

Address: object

id: String
street: String
streetTwo: String
city: String
state: String
postcode: String
email: String
phone: String
location: Location

Example

{
  "id": "string",
  "street": "string",
  "streetTwo": "string",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "email": "string",
  "phone": "string",
  "location": {
    "id": "string",
    "name": "string",
    "shortCode": "string"
  }
}

AddressParams: object

street: String
streetTwo: String
city: String
state: String
postcode: String
email: String
phone: String
locationId: String

Example

{
  "street": "string",
  "streetTwo": "string",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "email": "string",
  "phone": "string",
  "locationId": "string"
}

BlogPost: object

id: String
title: String
slug: String
bannerImage: String
content: String
tags: String
isPublished: Boolean
isFeatured: Boolean
views: Int
favourites: Int
comments: BlogPostComment
createdAt: String
updatedAt: String

Example

{
  "id": "string",
  "title": "string",
  "slug": "string",
  "bannerImage": "string",
  "content": "string",
  "tags": [
    "string"
  ],
  "isPublished": "boolean",
  "isFeatured": "boolean",
  "views": "number",
  "favourites": "number",
  "comments": [
    {
      "id": "string",
      "content": "string",
      "customer": {
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string",
        "profilePicture": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string"
}

BlogPostComment: object

id: String
content: String
customer: Customer
createdAt: String
updatedAt: String

Example

{
  "id": "string",
  "content": "string",
  "customer": {
    "email": "string",
    "phone": "string",
    "firstName": "string",
    "lastName": "string",
    "profilePicture": "string"
  },
  "createdAt": "string",
  "updatedAt": "string"
}

Boolean: boolean

The Boolean scalar type represents true or false.

Example

boolean

Cart: object

id: String
isShippingRequired: Boolean
cartItems: CartItem

Example

{
  "id": "string",
  "isShippingRequired": "boolean",
  "cartItems": [
    {
      "id": "number",
      "product": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "isPublished": "boolean",
        "sku": "string",
        "stock": "number",
        "maxItemPerOrder": "number",
        "price": "number",
        "cost": "number",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "number",
        "createdAt": "string",
        "weight": "number",
        "weightUnit": "string",
        "productUnit": "string",
        "updatedAt": "string",
        "category": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "isPublished": "boolean",
          "description": "string",
          "image": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "productCount": "number",
          "position": "number"
        },
        "attributes": [
          {
            "id": "string",
            "name": "string",
            "values": [
              "string"
            ],
            "isRequired": "boolean",
            "createdAt": "string",
            "updateAt": "string"
          }
        ],
        "variations": [
          {
            "id": "string",
            "name": "string",
            "price": "number",
            "cost": "number",
            "sku": "string"
          }
        ]
      }
    }
  ]
}

CartItem: object

id: Int
product: Product
quantity: Int
purchasePrice: Int
purchaseTimeCost: Int
attributes: CartProductAttribute
variation: ProductVariation

Example

{
  "id": "number",
  "product": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "isPublished": "boolean",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "cost": "number",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "views": "number",
    "createdAt": "string",
    "weight": "number",
    "weightUnit": "string",
    "productUnit": "string",
    "updatedAt": "string",
    "category": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "number",
      "position": "number"
    },
    "attributes": [
      {
        "id": "string",
        "name": "string",
        "values": [
          "string"
        ],
        "isRequired": "boolean",
        "createdAt": "string",
        "updateAt": "string"
      }
    ],
    "variations": [
      {
        "id": "string",
        "name": "string",
        "price": "number",
        "cost": "number",
        "sku": "string",
        "stock": "number"
      }
    ],
    "digitalItems": [
      {
        "id": "string"
      }
    ]
  }
}

CartItemAttributeParams: object

Id: String
attributeSelectedValue: String

Example

{
  "Id": "string",
  "attributeSelectedValue": "string"
}

CartItemParams: object

productId: String
productAttributes: CartItemAttributeParams
productVariationId: String
quantity: Int

Example

{
  "productId": "string",
  "productAttributes": [
    {
      "Id": "string",
      "attributeSelectedValue": "string"
    }
  ],
  "productVariationId": "string",
  "quantity": "number"
}

CartProductAttribute: object

name: String
selectedValue: String

Example

{
  "name": "string",
  "selectedValue": "string"
}

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "isPublished": "boolean",
  "description": "string",
  "image": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "productCount": "number",
  "position": "number"
}

Collection: object

id: String
name: String
slug: String
isPublished: Boolean
description: String
image: String
createdAt: String
updatedAt: String
products: Product
productCount: Int
position: Int

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "isPublished": "boolean",
  "description": "string",
  "image": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "products": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "isPublished": "boolean",
      "sku": "string",
      "stock": "number",
      "maxItemPerOrder": "number",
      "price": "number",
      "cost": "number",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "number",
      "createdAt": "string",
      "weight": "number",
      "weightUnit": "string",
      "productUnit": "string",
      "updatedAt": "string",
      "category": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "isPublished": "boolean",
        "description": "string",
        "image": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "productCount": "number",
        "position": "number"
      },
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "values": [
            "string"
          ],
          "isRequired": "boolean",
          "createdAt": "string",
          "updateAt": "string"
        }
      ],
      "variations": [
        {
          "id": "string"
        }
      ]
    }
  ]
}

CouponCode: object

id: String
code: String
amount: Int
minOrderAmount: Int
maxDiscountAmount: Int
isActive: Boolean
isFlatDiscount: Boolean
isForNewUsersOnly: Boolean
isUserSpecific: Boolean
maxUsage: Int
maxUsagePerUser: Int
discountType: DiscountType
description: String
image: String
startAt: String
endAt: String
createdAt: String
updatedAt: String
customers: Customer

Example

{
  "id": "string",
  "code": "string",
  "amount": "number",
  "minOrderAmount": "number",
  "maxDiscountAmount": "number",
  "isActive": "boolean",
  "isFlatDiscount": "boolean",
  "isForNewUsersOnly": "boolean",
  "isUserSpecific": "boolean",
  "maxUsage": "number",
  "maxUsagePerUser": "number",
  "discountType": "string",
  "description": "string",
  "image": "string",
  "startAt": "string",
  "endAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "customers": [
    {
      "email": "string",
      "phone": "string",
      "firstName": "string",
      "lastName": "string",
      "profilePicture": "string"
    }
  ]
}

CreateBlogPostResponse: object

post: BlogPost

Example

{
  "post": {
    "id": "string",
    "title": "string",
    "slug": "string",
    "bannerImage": "string",
    "content": "string",
    "tags": [
      "string"
    ],
    "isPublished": "boolean",
    "isFeatured": "boolean",
    "views": "number",
    "favourites": "number",
    "comments": [
      {
        "id": "string",
        "content": "string",
        "customer": {
          "email": "string",
          "phone": "string",
          "firstName": "string",
          "lastName": "string",
          "profilePicture": "string"
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

CreateCartResponse: object

cart: Cart

Example

{
  "cart": {
    "id": "string",
    "isShippingRequired": "boolean",
    "cartItems": [
      {
        "id": "number",
        "product": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "isPublished": "boolean",
          "sku": "string",
          "stock": "number",
          "maxItemPerOrder": "number",
          "price": "number",
          "cost": "number",
          "images": [
            "string"
          ],
          "isDigitalProduct": "boolean",
          "views": "number",
          "createdAt": "string",
          "weight": "number",
          "weightUnit": "string",
          "productUnit": "string",
          "updatedAt": "string",
          "category": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "isPublished": "boolean",
            "description": "string",
            "image": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "productCount": "number",
            "position": "number"
          },
          "attributes": [
            {
              "id": "string",
              "name": "string",
              "values": [
                "string"
              ],
              "isRequired": "boolean",
              "createdAt": "string",
              "updateAt": "string"
            }
          ],
          "variations": [
            {
              "id": "string",
              "name": "string",
              "price": "number",
              "cost": "number"
            }
          ]
        }
      }
    ]
  }
}

CreateCategoryResponse: object

category: Category

Example

{
  "category": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "productCount": "number",
    "position": "number"
  }
}

CreateCollectionResponse: object

collection: Collection

Example

{
  "collection": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "products": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "isPublished": "boolean",
        "sku": "string",
        "stock": "number",
        "maxItemPerOrder": "number",
        "price": "number",
        "cost": "number",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "number",
        "createdAt": "string",
        "weight": "number",
        "weightUnit": "string",
        "productUnit": "string",
        "updatedAt": "string",
        "category": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "isPublished": "boolean",
          "description": "string",
          "image": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "productCount": "number",
          "position": "number"
        },
        "attributes": [
          {
            "id": "string",
            "name": "string",
            "values": [
              "string"
            ],
            "isRequired": "boolean",
            "createdAt": "string",
            "updateAt": "string"
          }
        ],
        "variations": [
          {}
        ]
      }
    ]
  }
}

CreateProductResponse: object

product: Product

Example

{
  "product": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "isPublished": "boolean",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "cost": "number",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "views": "number",
    "createdAt": "string",
    "weight": "number",
    "weightUnit": "string",
    "productUnit": "string",
    "updatedAt": "string",
    "category": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "number",
      "position": "number"
    },
    "attributes": [
      {
        "id": "string",
        "name": "string",
        "values": [
          "string"
        ],
        "isRequired": "boolean",
        "createdAt": "string",
        "updateAt": "string"
      }
    ],
    "variations": [
      {
        "id": "string",
        "name": "string",
        "price": "number",
        "cost": "number",
        "sku": "string",
        "stock": "number"
      }
    ],
    "digitalItems": [
      {
        "id": "string",
        "title": "string"
      }
    ]
  }
}

CreateShippingMethodResponse: object

method: ShippingMethod

Example

{
  "method": {
    "id": "string",
    "displayName": "string",
    "deliveryCharge": "number",
    "deliveryTimeInDays": "number",
    "WeightUnit": "string",
    "isFlat": "boolean",
    "isActive": "boolean"
  }
}

CreateShopResponse: object

shop: Store

Example

{
  "shop": {
    "id": "string",
    "name": "string",
    "title": "string",
    "description": "string",
    "tags": [
      "string"
    ],
    "metaName": "string",
    "metaDescription": "string",
    "metaTags": [
      "string"
    ],
    "logo": "string",
    "favicon": "string",
    "bannerImage": "string",
    "isOpen": "boolean",
    "isCustomerLoyaltyEnabled": "boolean",
    "currency": "string",
    "website": "string",
    "supportEmail": "string",
    "supportPhone": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "street": "string",
    "streetOptional": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "location": {
      "id": "string",
      "name": "string",
      "shortCode": "string"
    }
  }
}

Currency: string

object USD
object BDT

Customer: object

email: String
phone: String
firstName: String
lastName: String
profilePicture: String

Example

{
  "email": "string",
  "phone": "string",
  "firstName": "string",
  "lastName": "string",
  "profilePicture": "string"
}

CustomerChangePasswordParams: object

oldPassword: String
newPassword: String

Example

{
  "oldPassword": "string",
  "newPassword": "string"
}

CustomerResetPasswordParams: object

email: String
resetToken: String
newPassword: String

Example

{
  "email": "string",
  "resetToken": "string",
  "newPassword": "string"
}

CustomerResetPasswordRequestParams: object

email: String

Example

{
  "email": "string"
}

DigitalContent: object

id: String
title: String
contentType: DigitalContentType
isTrialAllowed: Boolean
contentText: String
contentUrl: String
updatedAt: String
position: Int

Example

{
  "id": "string",
  "title": "string",
  "contentType": "string",
  "isTrialAllowed": "boolean",
  "contentText": "string",
  "contentUrl": "string",
  "updatedAt": "string",
  "position": "number"
}

DigitalContentType: string

object File
object Text
object Video

DigitalItem: object

id: String
title: String
description: String
position: Int
contents: DigitalContent

Example

{
  "id": "string",
  "title": "string",
  "description": "string",
  "position": "number",
  "contents": [
    {
      "id": "string",
      "title": "string",
      "contentType": "string",
      "isTrialAllowed": "boolean",
      "contentText": "string",
      "contentUrl": "string",
      "updatedAt": "string",
      "position": "number"
    }
  ]
}

DiscountType: string

object Product
object Shipping
object Overall

Feedback: object

rating: Int
comment: String
createdAt: String

Example

{
  "rating": "number",
  "comment": "string",
  "createdAt": "string"
}

FilterKey: string

object collection
object category
object email

FilterQuery: object

key: FilterKey
value: String

Example

{
  "key": "string",
  "value": "string"
}

Float: number

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

Example

number

GeneratePaymentNoneResponse: object

PaymentGatewayName: String
Nonce: String
StripePublishableKey: String

Example

{
  "PaymentGatewayName": "string",
  "Nonce": "string",
  "StripePublishableKey": "string"
}

GenerateShopSecretResponse: object

secret: StoreSecret

Example

{
  "secret": {
    "id": "string",
    "key": "string",
    "secret": "string",
    "secretType": "string"
  }
}

GetAdminBlogPostResponse: object

post: BlogPost

Example

{
  "post": {
    "id": "string",
    "title": "string",
    "slug": "string",
    "bannerImage": "string",
    "content": "string",
    "tags": [
      "string"
    ],
    "isPublished": "boolean",
    "isFeatured": "boolean",
    "views": "number",
    "favourites": "number",
    "comments": [
      {
        "id": "string",
        "content": "string",
        "customer": {
          "email": "string",
          "phone": "string",
          "firstName": "string",
          "lastName": "string",
          "profilePicture": "string"
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

GetAdminCategoryByIdResponse: object

category: Category

Example

{
  "category": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "productCount": "number",
    "position": "number"
  }
}

GetAdminCollectionByIdResponse: object

collection: Collection

Example

{
  "collection": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "isPublished": "boolean",
    "description": "string",
    "image": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "products": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "isPublished": "boolean",
        "sku": "string",
        "stock": "number",
        "maxItemPerOrder": "number",
        "price": "number",
        "cost": "number",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "number",
        "createdAt": "string",
        "weight": "number",
        "weightUnit": "string",
        "productUnit": "string",
        "updatedAt": "string",
        "category": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "isPublished": "boolean",
          "description": "string",
          "image": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "productCount": "number",
          "position": "number"
        },
        "attributes": [
          {
            "id": "string",
            "name": "string",
            "values": [
              "string"
            ],
            "isRequired": "boolean",
            "createdAt": "string",
            "updateAt": "string"
          }
        ],
        "variations": [
          {}
        ]
      }
    ]
  }
}

GetAdminProductByIDResponse: object

product: Product

Example

{
  "product": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "isPublished": "boolean",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "cost": "number",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "views": "number",
    "createdAt": "string",
    "weight": "number",
    "weightUnit": "string",
    "productUnit": "string",
    "updatedAt": "string",
    "category": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "number",
      "position": "number"
    },
    "attributes": [
      {
        "id": "string",
        "name": "string",
        "values": [
          "string"
        ],
        "isRequired": "boolean",
        "createdAt": "string",
        "updateAt": "string"
      }
    ],
    "variations": [
      {
        "id": "string",
        "name": "string",
        "price": "number",
        "cost": "number",
        "sku": "string",
        "stock": "number"
      }
    ],
    "digitalItems": [
      {
        "id": "string",
        "title": "string"
      }
    ]
  }
}

GetBlogPostResponse: object

post: PBlogPost

Example

{
  "post": {
    "id": "string",
    "title": "string",
    "slug": "string",
    "bannerImage": "string",
    "content": "string",
    "tags": [
      "string"
    ],
    "isPublished": "boolean",
    "isFeatured": "boolean",
    "views": "number",
    "favourites": "number",
    "comments": [
      {
        "id": "string",
        "content": "string",
        "customer": {
          "email": "string",
          "phone": "string",
          "firstName": "string",
          "lastName": "string",
          "profilePicture": "string"
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

GetCartByIDResponse: object

cart: Cart

Example

{
  "cart": {
    "id": "string",
    "isShippingRequired": "boolean",
    "cartItems": [
      {
        "id": "number",
        "product": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "isPublished": "boolean",
          "sku": "string",
          "stock": "number",
          "maxItemPerOrder": "number",
          "price": "number",
          "cost": "number",
          "images": [
            "string"
          ],
          "isDigitalProduct": "boolean",
          "views": "number",
          "createdAt": "string",
          "weight": "number",
          "weightUnit": "string",
          "productUnit": "string",
          "updatedAt": "string",
          "category": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "isPublished": "boolean",
            "description": "string",
            "image": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "productCount": "number",
            "position": "number"
          },
          "attributes": [
            {
              "id": "string",
              "name": "string",
              "values": [
                "string"
              ],
              "isRequired": "boolean",
              "createdAt": "string",
              "updateAt": "string"
            }
          ],
          "variations": [
            {
              "id": "string",
              "name": "string",
              "price": "number",
              "cost": "number"
            }
          ]
        }
      }
    ]
  }
}

GetCategoryByIdResponse: object

category: PCategory

Example

{
  "category": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "image": "string",
    "productCount": "number",
    "position": "number"
  }
}

GetCollectionByIdResponse: object

collection: PCollection

Example

{
  "collection": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "image": "string",
    "products": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "isPublished": "boolean",
        "sku": "string",
        "stock": "number",
        "maxItemPerOrder": "number",
        "price": "number",
        "cost": "number",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "number",
        "createdAt": "string",
        "weight": "number",
        "weightUnit": "string",
        "productUnit": "string",
        "updatedAt": "string",
        "category": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "isPublished": "boolean",
          "description": "string",
          "image": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "productCount": "number",
          "position": "number"
        },
        "attributes": [
          {
            "id": "string",
            "name": "string",
            "values": [
              "string"
            ],
            "isRequired": "boolean",
            "createdAt": "string",
            "updateAt": "string"
          }
        ],
        "variations": [
          {
            "id": "string",
            "name": "string",
            "price": "number"
          }
        ]
      }
    ]
  }
}

GetCouponCodeByCodeResponse: object

coupon: CouponCode

Example

{
  "coupon": {
    "id": "string",
    "code": "string",
    "amount": "number",
    "minOrderAmount": "number",
    "maxDiscountAmount": "number",
    "isActive": "boolean",
    "isFlatDiscount": "boolean",
    "isForNewUsersOnly": "boolean",
    "isUserSpecific": "boolean",
    "maxUsage": "number",
    "maxUsagePerUser": "number",
    "discountType": "string",
    "description": "string",
    "image": "string",
    "startAt": "string",
    "endAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "customers": [
      {
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string",
        "profilePicture": "string"
      }
    ]
  }
}

GetCouponCodeByIdResponse: object

coupon: CouponCode

Example

{
  "coupon": {
    "id": "string",
    "code": "string",
    "amount": "number",
    "minOrderAmount": "number",
    "maxDiscountAmount": "number",
    "isActive": "boolean",
    "isFlatDiscount": "boolean",
    "isForNewUsersOnly": "boolean",
    "isUserSpecific": "boolean",
    "maxUsage": "number",
    "maxUsagePerUser": "number",
    "discountType": "string",
    "description": "string",
    "image": "string",
    "startAt": "string",
    "endAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "customers": [
      {
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string",
        "profilePicture": "string"
      }
    ]
  }
}

GetCustomerOrderByHashResponse: object

order: Order

Example

{
  "order": {
    "id": "string",
    "hash": "string",
    "shippingCharge": "number",
    "paymentProcessingFee": "number",
    "subtotal": "number",
    "grandTotal": "number",
    "discountedAmount": "number",
    "status": "string",
    "paymentStatus": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "billingAddress": {
      "id": "string",
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "location": {
        "id": "string",
        "name": "string",
        "shortCode": "string"
      }
    },
    "shippingAddress": {
      "id": "string",
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "location": {
        "id": "string",
        "name": "string",
        "shortCode": "string"
      }
    },
    "cart": {
      "id": "string",
      "isShippingRequired": "boolean",
      "cartItems": [
        {
          "id": "number",
          "product": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "description": "string",
            "isPublished": "boolean"
          }
        }
      ]
    }
  }
}

GetCustomerOrderByIdResponse: object

order: Order

Example

{
  "order": {
    "id": "string",
    "hash": "string",
    "shippingCharge": "number",
    "paymentProcessingFee": "number",
    "subtotal": "number",
    "grandTotal": "number",
    "discountedAmount": "number",
    "status": "string",
    "paymentStatus": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "billingAddress": {
      "id": "string",
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "location": {
        "id": "string",
        "name": "string",
        "shortCode": "string"
      }
    },
    "shippingAddress": {
      "id": "string",
      "street": "string",
      "streetTwo": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "email": "string",
      "phone": "string",
      "location": {
        "id": "string",
        "name": "string",
        "shortCode": "string"
      }
    },
    "cart": {
      "id": "string",
      "isShippingRequired": "boolean",
      "cartItems": [
        {
          "id": "number",
          "product": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "description": "string",
            "isPublished": "boolean"
          }
        }
      ]
    }
  }
}

GetProductByIDResponse: object

product: PProduct

Example

{
  "product": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "views": "number",
    "productUnit": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "category": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "image": "string",
      "productCount": "number",
      "position": "number"
    },
    "attributes": [
      {
        "id": "string",
        "name": "string",
        "values": [
          "string"
        ],
        "isRequired": "boolean",
        "createdAt": "string",
        "updateAt": "string"
      }
    ],
    "variations": [
      {
        "id": "string",
        "name": "string",
        "price": "number",
        "sku": "string",
        "stock": "number"
      }
    ],
    "digitalItems": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "position": "number",
        "contents": [
          {
            "id": "string",
            "title": "string",
            "contentType": "string",
            "isTrialAllowed": "boolean"
          }
        ]
      }
    ]
  }
}

GetShippingMethodByIdResponse: object

method: ShippingMethod

Example

{
  "method": {
    "id": "string",
    "displayName": "string",
    "deliveryCharge": "number",
    "deliveryTimeInDays": "number",
    "WeightUnit": "string",
    "isFlat": "boolean",
    "isActive": "boolean"
  }
}

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

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

ListAdminBlogPostResponse: object

posts: BlogPost

Example

{
  "posts": [
    {
      "id": "string",
      "title": "string",
      "slug": "string",
      "bannerImage": "string",
      "content": "string",
      "tags": [
        "string"
      ],
      "isPublished": "boolean",
      "isFeatured": "boolean",
      "views": "number",
      "favourites": "number",
      "comments": [
        {
          "id": "string",
          "content": "string",
          "customer": {
            "email": "string",
            "phone": "string",
            "firstName": "string",
            "lastName": "string",
            "profilePicture": "string"
          },
          "createdAt": "string",
          "updatedAt": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

ListAdminCategoryResponse: object

categories: Category

Example

{
  "categories": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "productCount": "number",
      "position": "number"
    }
  ]
}

ListAdminCollectionResponse: object

collections: Collection

Example

{
  "collections": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "isPublished": "boolean",
      "description": "string",
      "image": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "products": [
        {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "isPublished": "boolean",
          "sku": "string",
          "stock": "number",
          "maxItemPerOrder": "number",
          "price": "number",
          "cost": "number",
          "images": [
            "string"
          ],
          "isDigitalProduct": "boolean",
          "views": "number",
          "createdAt": "string",
          "weight": "number",
          "weightUnit": "string",
          "productUnit": "string",
          "updatedAt": "string",
          "category": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "isPublished": "boolean",
            "description": "string",
            "image": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "productCount": "number",
            "position": "number"
          },
          "attributes": [
            {
              "id": "string",
              "name": "string",
              "values": [
                "string"
              ],
              "isRequired": "boolean",
              "createdAt": "string",
              "updateAt": "string"
            }
          ],
          "variations": [
            null
          ]
        }
      ]
    }
  ]
}

ListAdminProductAttributeResponse: object

attributes: ProductAttribute

Example

{
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "values": [
        "string"
      ],
      "isRequired": "boolean",
      "createdAt": "string",
      "updateAt": "string"
    }
  ]
}

ListAdminProductResponse: object

products: Product

Example

{
  "products": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "isPublished": "boolean",
      "sku": "string",
      "stock": "number",
      "maxItemPerOrder": "number",
      "price": "number",
      "cost": "number",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "number",
      "createdAt": "string",
      "weight": "number",
      "weightUnit": "string",
      "productUnit": "string",
      "updatedAt": "string",
      "category": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "isPublished": "boolean",
        "description": "string",
        "image": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "productCount": "number",
        "position": "number"
      },
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "values": [
            "string"
          ],
          "isRequired": "boolean",
          "createdAt": "string",
          "updateAt": "string"
        }
      ],
      "variations": [
        {
          "id": "string",
          "name": "string",
          "price": "number",
          "cost": "number",
          "sku": "string",
          "stock": "number"
        }
      ],
      "digitalItems": [
        {
          "id": "string"
        }
      ]
    }
  ]
}

ListAdminProductVariationResponse: object

variations: ProductVariation

Example

{
  "variations": [
    {
      "id": "string",
      "name": "string",
      "price": "number",
      "cost": "number",
      "sku": "string",
      "stock": "number"
    }
  ]
}

ListBlogPostResponse: object

posts: PBlogPost

Example

{
  "posts": [
    {
      "id": "string",
      "title": "string",
      "slug": "string",
      "bannerImage": "string",
      "content": "string",
      "tags": [
        "string"
      ],
      "isPublished": "boolean",
      "isFeatured": "boolean",
      "views": "number",
      "favourites": "number",
      "comments": [
        {
          "id": "string",
          "content": "string",
          "customer": {
            "email": "string",
            "phone": "string",
            "firstName": "string",
            "lastName": "string",
            "profilePicture": "string"
          },
          "createdAt": "string",
          "updatedAt": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

ListCategoryResponse: object

categories: PCategory

Example

{
  "categories": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "image": "string",
      "productCount": "number",
      "position": "number"
    }
  ]
}

ListCollectionResponse: object

collections: PCollection

Example

{
  "collections": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "image": "string",
      "products": [
        {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "isPublished": "boolean",
          "sku": "string",
          "stock": "number",
          "maxItemPerOrder": "number",
          "price": "number",
          "cost": "number",
          "images": [
            "string"
          ],
          "isDigitalProduct": "boolean",
          "views": "number",
          "createdAt": "string",
          "weight": "number",
          "weightUnit": "string",
          "productUnit": "string",
          "updatedAt": "string",
          "category": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "isPublished": "boolean",
            "description": "string",
            "image": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "productCount": "number",
            "position": "number"
          },
          "attributes": [
            {
              "id": "string",
              "name": "string",
              "values": [
                "string"
              ],
              "isRequired": "boolean",
              "createdAt": "string",
              "updateAt": "string"
            }
          ],
          "variations": [
            {
              "id": "string",
              "name": "string"
            }
          ]
        }
      ]
    }
  ]
}

ListCouponCodesResponse: object

coupons: CouponCode

Example

{
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "amount": "number",
      "minOrderAmount": "number",
      "maxDiscountAmount": "number",
      "isActive": "boolean",
      "isFlatDiscount": "boolean",
      "isForNewUsersOnly": "boolean",
      "isUserSpecific": "boolean",
      "maxUsage": "number",
      "maxUsagePerUser": "number",
      "discountType": "string",
      "description": "string",
      "image": "string",
      "startAt": "string",
      "endAt": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "customers": [
        {
          "email": "string",
          "phone": "string",
          "firstName": "string",
          "lastName": "string",
          "profilePicture": "string"
        }
      ]
    }
  ]
}

ListCustomerOrdersResponse: object

orders: Order

Example

{
  "orders": [
    {
      "id": "string",
      "hash": "string",
      "shippingCharge": "number",
      "paymentProcessingFee": "number",
      "subtotal": "number",
      "grandTotal": "number",
      "discountedAmount": "number",
      "status": "string",
      "paymentStatus": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "billingAddress": {
        "id": "string",
        "street": "string",
        "streetTwo": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "email": "string",
        "phone": "string",
        "location": {
          "id": "string",
          "name": "string",
          "shortCode": "string"
        }
      },
      "shippingAddress": {
        "id": "string",
        "street": "string",
        "streetTwo": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "email": "string",
        "phone": "string",
        "location": {
          "id": "string",
          "name": "string",
          "shortCode": "string"
        }
      },
      "cart": {
        "id": "string",
        "isShippingRequired": "boolean",
        "cartItems": [
          {
            "id": "number",
            "product": {
              "id": "string",
              "name": "string",
              "slug": "string",
              "description": "string"
            }
          }
        ]
      }
    }
  ]
}

ListPaymentMethodResponse: object

methods: PaymentMethod

Example

{
  "methods": [
    {
      "id": "string",
      "displayName": "string",
      "currencyName": "string",
      "currencySymbol": "string",
      "isDigitalPayment": "boolean"
    }
  ]
}

ListProductAttributeResponse: object

attributes: ProductAttribute

Example

{
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "values": [
        "string"
      ],
      "isRequired": "boolean",
      "createdAt": "string",
      "updateAt": "string"
    }
  ]
}

ListProductResponse: object

products: PProduct

Example

{
  "products": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "sku": "string",
      "stock": "number",
      "maxItemPerOrder": "number",
      "price": "number",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "number",
      "productUnit": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "category": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "image": "string",
        "productCount": "number",
        "position": "number"
      },
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "values": [
            "string"
          ],
          "isRequired": "boolean",
          "createdAt": "string",
          "updateAt": "string"
        }
      ],
      "variations": [
        {
          "id": "string",
          "name": "string",
          "price": "number",
          "sku": "string",
          "stock": "number"
        }
      ],
      "digitalItems": [
        {
          "id": "string",
          "title": "string",
          "description": "string",
          "position": "number",
          "contents": [
            {
              "id": "string",
              "title": "string",
              "contentType": "string",
              "isTrialAllowed": "boolean"
            }
          ]
        }
      ]
    }
  ]
}

ListProductVariationResponse: object

variations: PProductVariation

Example

{
  "variations": [
    {
      "id": "string",
      "name": "string",
      "price": "number",
      "sku": "string",
      "stock": "number"
    }
  ]
}

ListShippingMethodResponse: object

methods: ShippingMethod

Example

{
  "methods": [
    {
      "id": "string",
      "displayName": "string",
      "deliveryCharge": "number",
      "deliveryTimeInDays": "number",
      "WeightUnit": "string",
      "isFlat": "boolean",
      "isActive": "boolean"
    }
  ]
}

ListShopMediaResponse: object

items: ShopMedia

Example

{
  "items": [
    {
      "path": "string"
    }
  ]
}

Location: object

id: String
name: String
shortCode: String

Example

{
  "id": "string",
  "name": "string",
  "shortCode": "string"
}

LoginCustomerParams: object

email: String
password: String

Example

{
  "email": "string",
  "password": "string"
}

LoginCustomerResponse: object

accessToken: String
refreshToken: String

Example

{
  "accessToken": "string",
  "refreshToken": "string"
}

LoginUserParams: object

email: String
password: String

Example

{
  "email": "string",
  "password": "string"
}

LoginUserResponse: object

accessToken: String
refreshToken: String

Example

{
  "accessToken": "string",
  "refreshToken": "string"
}

NewBlogPostParams: object

title: String
slug: String
bannerImage: String
content: String
tags: String
isPublished: Boolean
isFeatured: Boolean

Example

{
  "title": "string",
  "slug": "string",
  "bannerImage": "string",
  "content": "string",
  "tags": [
    "string"
  ],
  "isPublished": "boolean",
  "isFeatured": "boolean"
}

NewCartParams: object

cartItems: CartItemParams

Example

{
  "cartItems": [
    {
      "productId": "string",
      "productAttributes": [
        {
          "Id": "string",
          "attributeSelectedValue": "string"
        }
      ],
      "productVariationId": "string",
      "quantity": "number"
    }
  ]
}

NewCategoryParams: object

name: String
slug: String
isPublished: Boolean
description: String
image: String
position: Int

Example

{
  "name": "string",
  "slug": "string",
  "isPublished": "boolean",
  "description": "string",
  "image": "string",
  "position": "number"
}

NewCollectionParams: object

name: String
slug: String
isPublished: Boolean
description: String
image: String
position: Int

Example

{
  "name": "string",
  "slug": "string",
  "isPublished": "boolean",
  "description": "string",
  "image": "string",
  "position": "number"
}

NewCouponCodeParams: object

code: String
amount: Int
minOrderAmount: Int
maxDiscountAmount: Int
isActive: Boolean
isFlatDiscount: Boolean
isForNewUsersOnly: Boolean
isUserSpecific: Boolean
maxUsage: Int
maxUsagePerUser: Int
discountType: DiscountType
description: String
image: String
startAt: String
endAt: String
customers: String

Example

{
  "code": "string",
  "amount": "number",
  "minOrderAmount": "number",
  "maxDiscountAmount": "number",
  "isActive": "boolean",
  "isFlatDiscount": "boolean",
  "isForNewUsersOnly": "boolean",
  "isUserSpecific": "boolean",
  "maxUsage": "number",
  "maxUsagePerUser": "number",
  "discountType": "string",
  "description": "string",
  "image": "string",
  "startAt": "string",
  "endAt": "string",
  "customers": [
    "string"
  ]
}

NewProduct: object

name: String
slug: String
description: String
isPublished: Boolean
sku: String
stock: Int
maxItemPerOrder: Int
price: Int
cost: Int
weight: Float
weightUnit: WeightUnit
productUnit: ProductUnit
images: String
isDigitalProduct: Boolean
categoryId: String
productSpecificDiscount: Int

Example

{
  "name": "string",
  "slug": "string",
  "description": "string",
  "isPublished": "boolean",
  "sku": "string",
  "stock": "number",
  "maxItemPerOrder": "number",
  "price": "number",
  "cost": "number",
  "weight": "number",
  "weightUnit": "string",
  "productUnit": "string",
  "images": [
    "string"
  ],
  "isDigitalProduct": "boolean",
  "categoryId": "string",
  "productSpecificDiscount": "number"
}

NewShippingMethodParams: object

displayName: String
deliveryCharge: Int
deliveryTimeInDays: Int
WeightUnit: WeightUnit
isFlat: Boolean
isActive: Boolean

Example

{
  "displayName": "string",
  "deliveryCharge": "number",
  "deliveryTimeInDays": "number",
  "WeightUnit": "string",
  "isFlat": "boolean",
  "isActive": "boolean"
}

NewStoreParams: object

name: String
title: String
description: String
tags: String
metaName: String
metaDescription: String
metaTags: String
logo: Upload
favicon: Upload
bannerImage: Upload
isOpen: Boolean
isCustomerLoyaltyEnabled: Boolean
currency: Currency
website: String
supportEmail: String
supportPhone: String
street: String
streetOptional: String
city: String
state: String
postcode: String
locationID: String

Example

{
  "name": "string",
  "title": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "metaName": "string",
  "metaDescription": "string",
  "metaTags": [
    "string"
  ],
  "logo": "object",
  "favicon": "object",
  "bannerImage": "object",
  "isOpen": "boolean",
  "isCustomerLoyaltyEnabled": "boolean",
  "currency": "string",
  "website": "string",
  "supportEmail": "string",
  "supportPhone": "string",
  "street": "string",
  "streetOptional": "string",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "locationID": "string"
}

NewStoreSecretParams: object

secretType: SecretType

Example

{
  "secretType": "string"
}

Order: object

id: String
hash: String
shippingCharge: Int
paymentProcessingFee: Int
subtotal: Int
grandTotal: Int
discountedAmount: Int
status: OrderStatus
paymentStatus: OrderPaymentStatus
createdAt: String
updatedAt: String
billingAddress: Address
shippingAddress: Address
cart: Cart
customer: Customer
shop: PStore
paymentMethod: PaymentMethod
shippingMethod: ShippingMethod
couponCode: UserCouponCode
payments: Payment
feedback: Feedback

Example

{
  "id": "string",
  "hash": "string",
  "shippingCharge": "number",
  "paymentProcessingFee": "number",
  "subtotal": "number",
  "grandTotal": "number",
  "discountedAmount": "number",
  "status": "string",
  "paymentStatus": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "billingAddress": {
    "id": "string",
    "street": "string",
    "streetTwo": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "email": "string",
    "phone": "string",
    "location": {
      "id": "string",
      "name": "string",
      "shortCode": "string"
    }
  },
  "shippingAddress": {
    "id": "string",
    "street": "string",
    "streetTwo": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "email": "string",
    "phone": "string",
    "location": {
      "id": "string",
      "name": "string",
      "shortCode": "string"
    }
  },
  "cart": {
    "id": "string",
    "isShippingRequired": "boolean",
    "cartItems": [
      {
        "id": "number",
        "product": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "isPublished": "boolean",
          "sku": "string"
        }
      }
    ]
  }
}

OrderBy: string

object ID
object CreatedAt
object UpdatedAt
object Price
object View

OrderDirection: string

object Asc
object Desc

OrderGenerateDigitalContent: object

type: DigitalContentType
content: String
contentUrl: String

Example

{
  "type": "string",
  "content": "string",
  "contentUrl": "string"
}

OrderPaymentParams: object

payableAmount: Int

Example

{
  "payableAmount": "number"
}

OrderPaymentStatus: string

object Pending
object Paid
object Failed
object Refunded
object Lending

OrderSearchParams: object

customerEmail: String
orderHash: String

Example

{
  "customerEmail": "string",
  "orderHash": "string"
}

OrderStatus: string

object Pending
object Processing
object Shipping
object Delivered
object Completed
object Cancelled
object Returned

OrderUpdateParams: object

status: OrderStatus
paymentStatus: OrderPaymentStatus
payments: OrderPaymentParams

Example

{
  "status": "string",
  "paymentStatus": "string",
  "payments": [
    {
      "payableAmount": "number"
    }
  ]
}

PBlogPost: object

id: String
title: String
slug: String
bannerImage: String
content: String
tags: String
isPublished: Boolean
isFeatured: Boolean
views: Int
favourites: Int
comments: BlogPostComment
createdAt: String
updatedAt: String

Example

{
  "id": "string",
  "title": "string",
  "slug": "string",
  "bannerImage": "string",
  "content": "string",
  "tags": [
    "string"
  ],
  "isPublished": "boolean",
  "isFeatured": "boolean",
  "views": "number",
  "favourites": "number",
  "comments": [
    {
      "id": "string",
      "content": "string",
      "customer": {
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string",
        "profilePicture": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string"
}

PCart: object

id: String
isShippingRequired: Boolean
cartItems: PCartItem

Example

{
  "id": "string",
  "isShippingRequired": "boolean",
  "cartItems": [
    {
      "id": "number",
      "product": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "sku": "string",
        "stock": "number",
        "maxItemPerOrder": "number",
        "price": "number",
        "images": [
          "string"
        ],
        "isDigitalProduct": "boolean",
        "views": "number",
        "productUnit": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "category": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "image": "string",
          "productCount": "number",
          "position": "number"
        },
        "attributes": [
          {
            "id": "string",
            "name": "string",
            "values": [
              "string"
            ],
            "isRequired": "boolean",
            "createdAt": "string",
            "updateAt": "string"
          }
        ],
        "variations": [
          {
            "id": "string",
            "name": "string",
            "price": "number",
            "sku": "string",
            "stock": "number"
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "title": "string",
            "description": "string",
            "position": "number",
            "contents": [
              {}
            ]
          }
        ]
      }
    }
  ]
}

PCartItem: object

id: Int
product: PProduct
quantity: Int
purchasePrice: Int
attributes: CartProductAttribute
variation: PProductVariation

Example

{
  "id": "number",
  "product": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "sku": "string",
    "stock": "number",
    "maxItemPerOrder": "number",
    "price": "number",
    "images": [
      "string"
    ],
    "isDigitalProduct": "boolean",
    "views": "number",
    "productUnit": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "category": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "image": "string",
      "productCount": "number",
      "position": "number"
    },
    "attributes": [
      {
        "id": "string",
        "name": "string",
        "values": [
          "string"
        ],
        "isRequired": "boolean",
        "createdAt": "string",
        "updateAt": "string"
      }
    ],
    "variations": [
      {
        "id": "string",
        "name": "string",
        "price": "number",
        "sku": "string",
        "stock": "number"
      }
    ],
    "digitalItems": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "position": "number",
        "contents": [
          {
            "id": "string",
            "title": "string",
            "contentType": "string"
          }
        ]
      }
    ]
  }
}

PCategory: object

id: String
name: String
slug: String
description: String
image: String
productCount: Int
position: Int

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "image": "string",
  "productCount": "number",
  "position": "number"
}

PCollection: object

id: String
name: String
slug: String
description: String
image: String
products: Product
productCount: Int
position: Int

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "image": "string",
  "products": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "isPublished": "boolean",
      "sku": "string",
      "stock": "number",
      "maxItemPerOrder": "number",
      "price": "number",
      "cost": "number",
      "images": [
        "string"
      ],
      "isDigitalProduct": "boolean",
      "views": "number",
      "createdAt": "string",
      "weight": "number",
      "weightUnit": "string",
      "productUnit": "string",
      "updatedAt": "string",
      "category": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "isPublished": "boolean",
        "description": "string",
        "image": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "productCount": "number",
        "position": "number"
      },
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "values": [
            "string"
          ],
          "isRequired": "boolean",
          "createdAt": "string",
          "updateAt": "string"
        }
      ],
      "variations": [
        {
          "id": "string",
          "name": "string",
          "price": "number",
          "cost": "number"
        }
      ]
    }
  ]
}

PDigitalItem: object

id: String
title: String
description: String
position: Int
contents: DigitalContent

Example

{
  "id": "string",
  "title": "string",
  "description": "string",
  "position": "number",
  "contents": [
    {
      "id": "string",
      "title": "string",
      "contentType": "string",
      "isTrialAllowed": "boolean",
      "contentText": "string",
      "contentUrl": "string",
      "updatedAt": "string",
      "position": "number"
    }
  ]
}

POrder: object

id: String
hash: String
shippingCharge: Int
paymentProcessingFee: Int
subtotal: Int
grandTotal: Int
discountedAmount: Int
status: OrderStatus
paymentStatus: OrderPaymentStatus
createdAt: String
updatedAt: String
billingAddress: Address
shippingAddress: Address
cart: PCart
customer: Customer
shop: PStore
paymentMethod: PaymentMethod
shippingMethod: ShippingMethod
couponCode: UserCouponCode
payments: Payment
feedback: Feedback

Example

{
  "id": "string",
  "hash": "string",
  "shippingCharge": "number",
  "paymentProcessingFee": "number",
  "subtotal": "number",
  "grandTotal": "number",
  "discountedAmount": "number",
  "status": "string",
  "paymentStatus": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "billingAddress": {
    "id": "string",
    "street": "string",
    "streetTwo": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "email": "string",
    "phone": "string",
    "location": {
      "id": "string",
      "name": "string",
      "shortCode": "string"
    }
  },
  "shippingAddress": {
    "id": "string",
    "street": "string",
    "streetTwo": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "email": "string",
    "phone": "string",
    "location": {
      "id": "string",
      "name": "string",
      "shortCode": "string"
    }
  },
  "cart": {
    "id": "string",
    "isShippingRequired": "boolean",
    "cartItems": [
      {
        "id": "number",
        "product": {
          "id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "sku": "string",
          "stock": "number"
        }
      }
    ]
  }
}

POrderSearchParams: object

shopName: String
orderHash: String

Example

{
  "shopName": "string",
  "orderHash": "string"
}

PProduct: object

id: String
name: String
slug: String
description: String
sku: String
stock: Int
maxItemPerOrder: Int
price: Int
images: String
isDigitalProduct: Boolean
views: Int
productUnit: ProductUnit
createdAt: String
updatedAt: String
category: PCategory
attributes: ProductAttribute
variations: PProductVariation
digitalItems: PDigitalItem
feedbacks: Feedback
productSpecificDiscount: Int

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "sku": "string",
  "stock": "number",
  "maxItemPerOrder": "number",
  "price": "number",
  "images": [
    "string"
  ],
  "isDigitalProduct": "boolean",
  "views": "number",
  "productUnit": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "category": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "image": "string",
    "productCount": "number",
    "position": "number"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "values": [
        "string"
      ],
      "isRequired": "boolean",
      "createdAt": "string",
      "updateAt": "string"
    }
  ],
  "variations": [
    {
      "id": "string",
      "name": "string",
      "price": "number",
      "sku": "string",
      "stock": "number"
    }
  ],
  "digitalItems": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "position": "number",
      "contents": [
        {
          "id": "string",
          "title": "string",
          "contentType": "string",
          "isTrialAllowed": "boolean",
          "contentText": "string"
        }
      ]
    }
  ]
}

PProductVariation: object

id: String
name: String
price: Int
sku: String
stock: Int

Example

{
  "id": "string",
  "name": "string",
  "price": "number",
  "sku": "string",
  "stock": "number"
}

PStore: object

name: