Karzoun Docs

QUERY

products(type: String, status: String, categoryId: String, searchValue: String, vendorId: String, tag: String, ids: [String], codes: [String], excludeIds: Boolean, excludeCodes: Boolean, image: String, page: Int, perPage: Int, sortField: String, sortDirection: SortDirection): ProductListResponse

Arguments

type

String

status

String

categoryId

String

searchValue

String

vendorId

String

tag

String

ids

[String]

codes

[String]

excludeIds

Boolean

excludeCodes

Boolean

image

String

page

Int

perPage

Int

sortField

String

sortDirection

SortDirection

Returns

ProductListResponse

data

[Product]

pagination

PaginationInfo!

Query

query Products {
  products {
    data {
      _id
      name
      shortName
      slug
      status
      code
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "products": {
      "data": [
        {
          "_id": "string",
          "name": "string",
          "shortName": "string",
          "slug": "string",
          "status": "string",
          "code": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Last modified on August 8, 2026

⌘I

Query

query Products {
  products {
    data {
      _id
      name
      shortName
      slug
      status
      code
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "products": {
      "data": [
        {
          "_id": "string",
          "name": "string",
          "shortName": "string",
          "slug": "string",
          "status": "string",
          "code": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Getting started

Guides

Try it

Queries

Mutations

Types

products

Arguments

Returns