📄️ 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
AUTH: Role=[role.OWNER,role.EDITOR]
📄️ adminUserViewer
AUTH: Role=[] OR ('user is authenticated')
📄️ adminUser
AUTH: Role=[role.OWNER,role.EDITOR,role.VIEWER] OR (('user is authenticated') AND ('email if present in input matches JWT'))
📄️ adminUsers
AUTH: Role=[role.OWNER,role.EDITOR,role.VIEWER]
📄️ 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
AUTH: Role=[system] OR ('user is authenticated')
📄️ bulkCostPrices
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ bulkPrices
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ bundle
No description
📄️ bundles
No description
📄️ businessRuleDecisionTable
Returns a decisionTable by ruleId and tableId
📄️ businessRuleFieldDefinitions
No description
📄️ businessRuleJDM
Returns the JDM Json representation of the business rule that can be use in the GoRules Zen Engine
📄️ businessRule
Returns a business rule by its ID.
📄️ businessRules
Returns a paginated response of rules based on the provider filter
📄️ carrier
Retrieve detailed information about a specific shipping carrier.
📄️ carriers
Search and retrieve shipping carriers with comprehensive filtering and pagination.
📄️ cart
No description
📄️ carts
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('contactId if present in input matches JWT' AND 'customerId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))
📄️ categories
Search and retrieve product categories with comprehensive filtering and pagination.
📄️ category
Retrieve detailed information about a specific product category.
📄️ channel
No description
📄️ channels
No description
📄️ 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 pagination support.
📄️ companySearch
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]
📄️ company
Retrieve detailed information about a specific company.
📄️ contact
Retrieve detailed information about a specific contact.
📄️ contacts
Search and retrieve contacts with pagination support.
📄️ costPrices
No description
📄️ crossupsell
Retrieve a cross-sell/upsell recommendation by ID.
📄️ crossupsells
Retrieve recommendations with filters and pagination.
📄️ customer
Retrieve detailed information about a specific customer.
📄️ customers
Search and retrieve customers with filtering and pagination.
📄️ discount
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ discounts
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ eventActionConfig
Query for retrieving an EventActionConfig entity by ID, returns either EventToEmailConfig or EventToWebHookConfig depending on the type
📄️ eventActionConfigs
Query for retrieving EventActionConfig entities, returns both EventToEmailConfig or EventToWebHookConfig depending on the type
📄️ externalAddress
AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER] OR ('user is authenticated')
📄️ favoriteList
AUTH: Role=[system] OR ('user is authenticated')
📄️ favoriteLists
Get favorite lists, use either an id or a source
📄️ inventory
Retrieve detailed inventory information for a specific inventory record.
📄️ machine
Get a single machine, either by id, slug & language or by source & sourceId
📄️ machines
List machines
📄️ magicToken
AUTH: Role=[system]
📄️ magicTokens
AUTH: Role=[system]
📄️ 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
No description
📄️ orderAddress
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ orderAddresses
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ orderGetPDF
No description
📄️ orderRevision
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ orderRevisions
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ orderStatusSet
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ orderStatusSets
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ orderStatus
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ orderStatuses
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ order
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ 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
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))
📄️ payMethod
Retrieve detailed information about a specific payment method.
📄️ payMethods
Search and retrieve payment methods with comprehensive filtering and pagination.
📄️ payment
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ payments
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ priceCalculate
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ priceDefault
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ priceExplain
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ price
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ prices
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ pricesheet
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ pricesheets
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ 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
Retrieve detailed purchase authorization configuration by identifier.
📄️ purchaseAuthorizationConfigs
Search and retrieve purchase authorization configurations with filtering.
📄️ quoteGetPDF
No description
📄️ roleDefinition
No description
📄️ roleDefinitions
No description
📄️ role
AUTH: Role=[role.OWNER,role.EDITOR,role.VIEWER]
📄️ roles
AUTH: Role=[role.OWNER,role.EDITOR,role.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))
📄️ 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
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ shipments
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ shop
AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ shops
AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ 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
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ taxes
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ templateErrorLogStats
Get template error log statisticsAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ templateErrorLog
Find a Template Error Log by IDAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ templateErrorLogs
Find Template Error Logs by search criteriaAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ template
Find a Template by IDAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ templates
Find Templates by TemplateSearchInputAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
📄️ tender
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]
📄️ trackAndTrace
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ trackAndTraces
AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')
📄️ user
Retrieve user information by ID or login email.
📄️ 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
No description
📄️ valueset
No description
📄️ valuesets
No description
📄️ viewer
Retrieve information about the currently authenticated user.
📄️ warehouse
No description
📄️ warehouses
No description
📄️ zoneTaxCode
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ zoneTaxCodes
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]