Filtering Reference

Overview

This section details the filters available for refining or searching list results in the Merchi SDK. For practical usage examples, refer to the SDK documentation specific to your programming language.

Naming Conventions:

The Merchi backend accepts filter names in both mixedCase and underscore_case.
Filters in this reference are listed in mixedCase. Use the naming convention most appropriate for your language (e.g., mixedCase for TypeScript SDK).

as

Input: User ID

Description: Limits results to entities the specified user has access to (in addition to the current user).

asRole

Input: Integer representing a permission role (refer to the Entity Reference Enum for a complete list).

Description: Restricts the result set to only EnrolledDomain entities matching the specified role.

Applicable Entities: Available exclusively on the EnrolledDomain entity.

tab

Input: Tab name (string)

Description: Restricts results to entities suitable for a specific UI tab.

Applicable Entities:

Notification: read, unread
Invoice: all, overdue, unpaid
Job: all, or any Category name
Shipment: receiving, sending
User: super
Theme: public

state

Input: State name (string)

Description: Filters entities based on their state.

Applicable Entities:

Quote: canAddToInvoice
Assignment: assignmentsNeedShipping, assignmentsAll
Job: Various states
- jobsActive,
- jobsAll (does nothing)
- jobsAllActive
- jobsAllActiveDrafting
- jobsArchived
- jobsCompleted
- jobsUnpaid
- jobsAllWithoutInvoices
- jobsUnassignedProduction
- jobsNeedShipping
- jobsAllShipments
- jobsShipments
- jobsDraftingActiveDesigner
- jobsDraftingUnassignedDesigner
- jobsDraftingDraftsWaitingDesigner
- jobsDraftingDraftsChangesRequestedDesigner
- jobsProductionAllActiveSupplier
- jobsProductionShipmentReady
- jobsProductionShipmentDispatched
- jobsProductionQuotingSupplier
- jobsProductionCompleteSupplier
- jobsActiveProductionSupplier
- jobsProductionShipmentsSupplier
- jobsProductionQuoteSuccessfulSupplier
Shipment: notInvoiced, notQuoted, notQuotedOrInvoiced

section

Input: Section ID (number)

Description: Filters Notification and User entities based on a section ID.

senderRole

Input: system or other string

Description: Filters Notificationentities by sender role.

system: Notifications from the system itself.
Other: Notifications from other users.

Applicable Entities: Notification

inDomain

Input: Domain ID

Description: Restricts results to entities in the specified domain .

Applicable Entities: It is available on most entity types.

inDomainName

Input: Domain name

Description:

Similar to inDomain, but filters by domain name instead of ID.
Note: inDomain and inDomainName are mutually exclusive.

Applicable Entities: It is available on most entity types.

inDomainRoles

Input: List of user roles types (JSON syntax)

Description: Filters User entities by roles within a specified domain. Requires either inDomain or inDomainName has been specified.

Applicable Entities: User

publicOnly

Input: Boolean (JSON syntax)

Description: If true, the result set is restricted to only those entities which are shown publicly.

Applicable Entities:

Category
Product
SubscriptionPlan
DomainTag

isPrivate

Input: Boolean (JSON syntax)

Description:

If true, the result set is restricted to only those entities which are marked private.

Applicable Entities: SubscriptionPlan

managedOnly

Input: Any string to enable

Description: If enabled, the result set is restricted to only those products which the user is a manager of.

Applicable Entities: It is available only on Product entities. entities.

clientOnly

Input: Any string to enable

Description: Filters Job entities to only those where the user is a client.

Applicable Entities: Job

teamOnly

Input: "true" (string) to enable

Description: Filters Job and Domain entities to only those where the user is a team member or manager.

Applicable Entities: Job and Domain

managedDomainsOnly

Input: Any string to enable the filter.

Description:

Restricts the result set to entities where the user is either an admin or a manager of the domain to which the entity belongs.

Applicable Entities: It is available on Category, User, Theme and Domain entities.

businessDomainsOnly

Input: Any string to enable

Description:

Restricts the result set to include only those domains in which the user is a team member (e.g., manager, admin).

Applicable Entities: It is available only on Domain entities. entities.

relatedAssignment

Input: An Assignment ID.

Description: Restricts the result set to only those ProductionComments that are attached to the specified Assignment.

Applicable Entities: Production, Comment.

relatedJob

Input: A Job ID.

Description: Restricts the result set to only those entities attached to the specified job.

Applicable Entities: Notification, JobComment, User.

relatedProduct

Input: A Product ID.

Description: Restricts the result set to only those entities attached to the specified product.

Applicable Entities: ShipmentMethod, DiscountGroup, DomainTag.

jobNotifiable

Input: A Job ID.

Description: Restricts the result set to only those Users who should be notified about changes to the specified job.

Applicable Entities: User.

notificationType

Input: An integer representing the notification type.

Description: Restricts the result set to only those Notifications of the specified type. (Refer to enum definition for complete list.)

Applicable Entities: Notification.

notificationJob

Input: A Job ID.

Description: Restricts the result set to only those Notifications related to the specified job.

Applicable Entities: Notification.

notificationRecipient

Input: A User ID.

Description: Restricts the result set to only those Notifications directed to the specified user.

Applicable Entities: Notification.

isOrder

Input: A boolean (JSON syntax).

Description: Restricts the result set to only those entities marked as orders.

Applicable Entities: Jobs.

clientId

Input: A User ID (an integer).

Description: Restricts the result set to only those entities where the specified user is a client.

Applicable Entities: Job, Assignment, Quote, Invoice.

managerId

Input: A User ID (an integer).

Description: Restricts the result set to only those entities where the specified user is a manager.

Applicable Entities: Invoice.

clientCompanyId

Input: A Company ID (an integer).

Description: Restricts the result set to only those entities where the specified company is a client.

Applicable Entities: Shipment, Job, Quote, Invoice.

senderCompanyId

Input: A Company ID (an integer).
Description: Restricts the result set to only those entities where the specified company is the sender.
Applicable Entities: Shipment, Assignment.

relatedUser

Input: A User ID (an integer).

Description: Restricts the result set to only those entities related to the specified user. The definition of “related” depends on the entity type. For example, a user might be related to a Job if they were a manager, designer, or supplier for it.

Applicable Entities: File, EnrolledDomain, Category, Product, Job, Company.

dateFrom

Input: A Unix timestamp (it will attempt to guess the meaning of other timestamp formats).

Description: Restricts the result set to only those entities created after the specified timestamp. Usually, the creation date of the entity is meant.

Applicable Entities: Invoice, Job.

dateTo

Input: A Unix timestamp (it will attempt to guess the meaning of other timestamp formats).

Description: Restricts the result set to only those entities created before the specified timestamp.

Applicable Entities: Invoice, Job.

categoryId

Input: A Category ID (an integer).

Description: Restricts the result set to only those products within the specified category.

Applicable Entities: Product.

platformCategoryId

Input: A Category ID (an integer).

Description: Restricts the result set to only those products within the specified platform category.

Applicable Entities: Product.

companyId

Input: A Company ID (an integer).

Description: Restricts the result set to only those products which are in the specified company.

Applicable Entities: User, SubscriptionPlan, Domain, Shipment, Job, ShipmentMethod, Invoice, CountryTax.

componentId

Input: A Component ID (an integer).

Description: Restricts the result set to only those ComponentTags which are attached to the specified Component.

Applicable Entities: ComponentTag.

name

Input: A string.

Description: Restricts the result set to only those entities whose name matches the specified string.

Applicable Entities: Domain, Component.

tagNames

Input: A comma-separated list of strings representing tag names.

Description: Restricts the result set to only those entities tagged with the specified tags by name.

Applicable Entities: Component.

exclude

Input: A comma-separated list of integers representing entity IDs.

Description: Restricts the result set to exclude the specified entities.

Applicable Entities: All entities.

excludeDomains

Input: A comma-separated list of integers representing Domain IDs.

Description: Restricts the result set to exclude products in the specified domains.

Applicable Entities: Product.

includeOnly

Input: A comma-separated list of integers representing entity IDs.

Description: Restricts the result set to include only the specified entities as an alternative to fetching each entity with separate requests.

Applicable Entities: All entities.

domainRoles

Input: A comma-separated list of integers representing permission roles.

Description:

Restricts the result set to only those domains where the user has one of the specified roles.
Not to be confused with inDomainRoles, which is a separate filter.

Applicable Entities: Domain.

domainTypes

Input: A comma-separated list of integers representing domain types.

Description: Restricts the result set to only those domains of the specified types.

Applicable Entities: Domain, Theme.

productTypes

Input: A comma-separated list of integers representing product types.

Description: Restricts the result set to only those products of the specified types.

Applicable Entities: Product.

memberOnly

Input: A boolean.

Description: Restricts the result set to only those companies of which the user is a member.

Applicable Entities: Company.

merchiOnly

Input: A boolean.

Description: Restricts the result set to only those entities considered platform-global.

Applicable Entities: Product, Category.

inbound

Input: A boolean.

Description: Restricts the result set to only those Invoices where the user is a client or part of a client company.

Applicable Entities: Invoice.

savedByUser

Input: A User ID.

Description: Restricts the result set to only those Products saved by the specified user.

Applicable Entities: Product.

receiverId

Input: A User ID (an integer).

Description: Restricts the result set to only those Shipments received by the specified user.

Applicable Entities: Shipment.

turnAroundTime

Input: A day number (an integer).

Description: Restricts the result set to only those Product with a certain turn around time.

Applicable Entities: Product.

priceRange

Input: An array of two integers representing a range (inclusive), e.g., [0, 50].

Description: Restricts the product set to the expected price range.

Applicable Entities: Product.