📄️ addressesByCompanyId
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))
📄️ addressesByCustomerId
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))
📄️ addressesByOrderId
Use orderAddresses
📄️ addressesByUserId
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))
📄️ adminUserTenant
Retrieve detailed information about a specific tenant.
📄️ adminUserViewer
Retrieve the currently authenticated administrative user's profile information.
📄️ adminUser
Retrieve detailed information about a specific administrative user by their email address.
📄️ adminUsers
Retrieve a paginated list of administrative users with optional filtering and sorting.
📄️ attributeDescription
Retrieve comprehensive information about a specific attribute description by its unique identifier.
📄️ attributeDescriptions
Search and retrieve attribute descriptions with comprehensive filtering and pagination capabilities.
📄️ attributeResultByCategoryId
Retrieve comprehensive attribute results for a specific category with optional default values.
📄️ attributeResultByClusterId
Retrieve comprehensive attribute results for a specific cluster with optional default values.
📄️ attributeResultByCompanyId
Retrieve comprehensive attribute results for a specific company with optional default values.
📄️ attributeResultByContactId
Retrieve comprehensive attribute results for a specific contact with optional default values.
📄️ attributeResultByCustomerId
Retrieve comprehensive attribute results for a specific customer with optional default values.
📄️ attributeResultByProductId
Retrieve comprehensive attribute results for a specific product with optional default values.
📄️ attribute
Retrieve detailed information about a specific attribute by its unique identifier.
📄️ attributesByProductId
Retrieve all attributes associated with a specific product with filtering and pagination.
📄️ attributes
Search and retrieve attributes with comprehensive filtering and pagination capabilities.
📄️ authentication
Retrieve user account information by email address.
📄️ bulkCostPrices
Search and retrieve bulk cost price records with filtering and pagination.
📄️ bulkPrices
Search and retrieve bulk price records with filtering and pagination.
📄️ bundle
Retrieve detailed information about a specific product bundle.
📄️ bundles
Search and retrieve product bundles with comprehensive filtering and pagination.
📄️ businessRuleDecisionTable
Retrieve a specific decision table from a business rule by its identifiers.
📄️ businessRuleFieldDefinitions
Retrieve field definitions for business rule input and output mapping by group name.
📄️ businessRuleJDM
Convert a business rule to JSON Decision Model (JDM) format for execution in compatible rule engines.
📄️ businessRule
Retrieve detailed information about a specific business rule by its unique identifier.
📄️ businessRules
Search and retrieve business rules with comprehensive filtering and pagination support.
📄️ carrier
Retrieve detailed information about a specific shipping carrier.
📄️ carriers
Search and retrieve shipping carriers with comprehensive filtering and pagination.
📄️ cart
Retrieve detailed information about a specific shopping cart.
📄️ carts
Search and retrieve shopping carts with comprehensive filtering and pagination.
📄️ categories
Search and retrieve product categories with comprehensive filtering and pagination.
📄️ category
Retrieve detailed information about a specific product category.
📄️ channel
Retrieves a specific channel by its unique identifier.
📄️ channels
Retrieves all channels accessible to the current user.
📄️ clusterConfig
Retrieve a specific cluster configuration template by ID.
📄️ clusterConfigs
Retrieve all available cluster configuration templates.
📄️ cluster
Retrieve detailed information about a specific product cluster.
📄️ companies
Search and retrieve companies with advanced filtering, sorting, and pagination capabilities.
📄️ companySearch
This query is deprecated and will be removed in a future version.
📄️ company
Retrieve a specific company by its internal identifier.
📄️ computedOrderlists
Get computed orderlists for a customer or contact/company.
📄️ contact
Retrieves a contact by their internal ID with complete contact information including personal details,
📄️ contacts
Searches and retrieves contacts with advanced filtering, pagination, and sorting capabilities.
📄️ costPrices
Search and retrieve cost price records with filtering and pagination.
📄️ crossupsell
Retrieve a cross-sell/upsell recommendation by ID.
📄️ crossupsells
Retrieve recommendations with filters and pagination.
📄️ customer
Retrieve a specific customer by their unique internal identifier.
📄️ customers
Search customers with advanced filtering, sorting, and pagination capabilities.
📄️ discount
Retrieve detailed information about a specific discount record.
📄 ️ discounts
Search and filter discount records with pagination support.
📄️ eventActionConfig
Retrieve detailed information about a specific event action configuration.
📄️ eventActionConfigs
Search and retrieve event action configurations with comprehensive filtering and pagination.
📄️ externalAddress
AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER] OR ('user is authenticated')
📄️ favoriteList
Retrieve detailed information about a specific favorite list.
📄️ favoriteLists
Search and retrieve favorite lists with comprehensive filtering and pagination.
📄️ inventory
Retrieve detailed inventory information for a specific inventory record.
📄️ machine
Retrieve detailed information about a specific spare parts machine.
📄️ machines
Search and retrieve spare parts machines with comprehensive filtering and pagination.
📄️ magicToken
Retrieve a specific magic token by its unique identifier.
📄️ magicTokens
Search and retrieve magic tokens with pagination support.
📄️ mediaDocument
Deprecated in favor of media.document
📄️ mediaDocuments
Deprecated in favor of media.documents
📄️ mediaImage
Deprecated in favor of media.image
📄️ mediaImages
Deprecated in favor of media.images
📄️ mediaVideo
Deprecated in favor of media.video
📄️ mediaVideos
Deprecated in favor of media.videos
📄️ media
Access point for media management operations.
📄️ orderAddress
Retrieve a specific order address by its identifier and order ID.
📄️ orderAddresses
Retrieve all addresses associated with a specific order, optionally filtered by address type.
📄️ orderGetPDF
Generate and retrieve a PDF document for an order.
📄️ orderRevision
Retrieve a specific order revision by order ID and revision number.
📄️ orderRevisions
Search and retrieve order revisions with comprehensive filtering and pagination capabilities.
📄️ orderStatusSet
Retrieve detailed information about a specific order status set.
📄️ orderStatusSets
Search and retrieve order status sets with comprehensive filtering and pagination.
📄️ orderStatus
Retrieve detailed information about a specific order status.
📄️ orderStatuses
Search and retrieve order statuses with comprehensive filtering and pagination.
📄️ order
Retrieve comprehensive information about a specific order by its identifier.
📄️ orderlist
Retrieve detailed information about a specific order list by its unique identifier.
📄️ orderlists
Search and retrieve order lists with comprehensive filtering, sorting, and pagination capabilities.
📄️ orders
Search and retrieve orders with comprehensive filtering and pagination capabilities.
📄️ payMethod
Retrieve detailed information about a specific payment method.
📄️ payMethods
Search and retrieve payment methods with comprehensive filtering and pagination.
📄️ payment
Retrieve detailed information about a specific payment.
📄️ payments
Search and retrieve payments with comprehensive filtering and pagination.
📄️ priceCalculate
Calculate the final price for a product based on customer context and business rules.
📄️ priceDefault
Retrieve default pricing for products without customer-specific context.
📄️ priceExplain
Explain the price calculation process with detailed breakdown.
📄️ price
Retrieve detailed information about a specific price record.
📄️ prices
Search and retrieve price records with comprehensive filtering and pagination.
📄️ pricesheet
Retrieve detailed information about a specific pricesheet.
📄️ pricesheetsEffective
Get effective pricesheets for a customer or contact.
📄️ pricesheets
Search and retrieve pricesheets with comprehensive filtering and pagination.
📄️ productSurcharges
Retrieve surcharges associated with a specific product.
📄️ product
Retrieve detailed information about a specific product.
📄️ products
Search and retrieve products with comprehensive filtering, sorting, and aggregation capabilities.
📄️ purchaseAuthorizationConfig
Query for retrieving a PurchaseAuthorizationConfig by ID. The purchase authorization config defines the purchase role of a contact within a company as well as their authorization limit. AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR ('user is authenticated'),
📄️ purchaseAuthorizationConfigs
Query for searching through PurchaseAuthorizationConfig entities. AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT')),
📄️ quoteGetPDF
Generate and retrieve a PDF quote document for an order.
📄️ roleDefinition
Retrieve detailed information about a specific role definition.
📄️ roleDefinitions
Search and retrieve role definitions with comprehensive filtering and pagination.
📄️ role
Retrieve detailed information about a specific role.
📄️ roles
Search and retrieve roles with comprehensive filtering and pagination.
📄️ shipmentItem
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ shipmentItems
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ shipment
Retrieve detailed information about a specific shipment by its identifier.
📄️ shipments
Search and retrieve shipments with comprehensive filtering and pagination capabilities.
📄️ shop
This query will be removed in a future version
📄️ shops
This query will be removed in a future version
📄️ site
Deprecated in favor of channel
📄️ surcharge
Retrieve detailed information about a specific surcharge.
📄️ surcharges
Search and retrieve surcharges with comprehensive filtering and pagination.
📄️ tax
Retrieve tax information by various identifiers.
📄️ taxes
Search and retrieve tax configurations with filtering and pagination.
📄️ templateErrorLogStats
Retrieve statistical summary of template error logs for monitoring and analysis.
📄️ templateErrorLog
Retrieve detailed information about a specific template error log entry.
📄️ templateErrorLogs
Search and retrieve template error logs with comprehensive filtering.
📄️ template
Retrieve detailed information about a specific message template.
📄️ templates
Search and retrieve message templates with comprehensive filtering.
📄️ tenant
Retrieves the current tenant information based on user context.
📄️ tender
Retrieve detailed information about a specific tender or create a new tender from an existing order.
📄️ ticket
Retrieve detailed information about a specific ticket.
📄️ tickets
Retrieve a list of tickets with optional filtering and sorting.
📄️ trackAndTrace
Retrieve detailed tracking information for a specific shipment by its tracking identifier.
📄️ trackAndTraces
Search and retrieve tracking information with comprehensive filtering and pagination capabilities.
📄️ user
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))
📄️ usergroup
This query is deprecated and will be removed in a future
📄️ usergroups
This query is deprecated and will be removed in a future
📄️ valuesetItems
Search and retrieve value set items with comprehensive filtering and pagination.
📄️ valueset
Retrieve detailed information about a specific value set.
📄️ valuesets
Search and retrieve value sets with comprehensive filtering and pagination.
📄️ viewer
No description
📄️ warehouse
Retrieve detailed information about a specific warehouse.
📄️ warehouses
Search and retrieve warehouses with comprehensive filtering and pagination.
📄️ zoneTaxCode
Retrieve detailed information about a specific zone tax code record.
📄️ zoneTaxCodes
Search and filter zone tax code records with pagination support.