📄️ 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
No description
📄️ attributeDescriptions
No description
📄️ attributeResultByCategoryId
No description
📄️ attributeResultByClusterId
No description
📄️ attributeResultByCompanyId
No description
📄️ attributeResultByContactId
No description
📄️ attributeResultByCustomerId
No description
📄️ attributeResultByProductId
No description
📄️ attribute
No description
📄️ attributesByProductId
No description
📄️ attributes
No description
📄️ 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
No description
📄️ carriers
No description
📄️ 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
No description
📄️ category
No description
📄️ channel
No description
📄️ channels
No description
📄️ clusterConfig
AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]
📄️ clusterConfigs
AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]
📄️ cluster
No description
📄️ companies
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]
📄️ companySearch
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]
📄️ company
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))
📄️ contact
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('contactId if present in input matches JWT'))
📄️ contacts
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]
📄️ costPrices
No description
📄️ crossupsell
AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]
📄️ crossupsells
AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]
📄️ customer
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))
📄️ customers
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]
📄️ 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
AUTH: Role=[logistics.OWNER,logistics.EDITOR,logistics.VIEWER]
📄️ 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
📄️ 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
AUTH: Role=[shop.OWNER,shop.EDITOR,shop.VIEWER] OR ('user is authenticated')
📄️ orderlists
AUTH: Role=[shop.OWNER,shop.EDITOR,shop.VIEWER] OR ('user is authenticated')
📄️ 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
No description
📄️ payMethods
No description
📄️ 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
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ product
No description
📄️ products
AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))
📄️ purchaseAuthorizationConfig
Query for retrieving a PurchaseAuthorizationConfig entity 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
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
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ surcharges
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ 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
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
No description
📄️ valueset
No description
📄️ valuesets
No description
📄️ viewer
No description
📄️ warehouse
No description
📄️ warehouses
No description
📄️ zoneTaxCode
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]
📄️ zoneTaxCodes
AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]