Skip to main content
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

Filter by product type.

status
String

Filter by status. Omit to exclude deleted products only.

categoryId
String

Filter to products in this category (and its descendants).

searchValue
String

Case-insensitive partial match on name, code, or barcodes.

vendorId
String

Filter by supplying Company id.

tag
String

Filter to products tagged with this tag id.

ids
[String]

Restrict results to these product ids.

codes
[String]

Restrict results to these product code values.

excludeIds
Boolean

When true, ids becomes an exclusion list instead of an inclusion list.

excludeCodes
Boolean

When true, codes becomes an exclusion list instead of an inclusion list.

image
String

Filter by image presence: hasImage or noImage.

page
Int

1-based page index. Default: 1. See Pagination.

perPage
Int

Page size. Default: 20. See Pagination.

sortField
String

Field to sort by. Default: code.

sortDirection
SortDirection

Sort direction for sortField. Default: ascending.

Returns

ProductListResponse
data
[Product]
pagination
PaginationInfo!
Query
Response
آخر تعديل في ١١ أغسطس ٢٠٢٦