DemandHq
The parent-most entity of the DemandHq Domain
type DemandHq {
automationSettings: DemandHqAutomationSettings
collection(
collectionId: ID
slug: String
): Collection!
collections(
after: String
before: String
collectionIds: [ID]
collectionType: StringFilterInput
first: Int
last: Int
numberOfTermAggregations: CollectionNumberOfTermAggregationsInput
query: String
slugs: [String]
sortOrder: [CollectionSortInput]
status: DemandEntityStatusFilterInput
storefrontIds: IDFilterInput
tagPrefixes: [StringFilterInput]
tags: [StringFilterInput]
): CollectionConnectionWithSearch!
comments(
after: String
before: String
entityId: ID!
first: Int
last: Int
): DemandHqCommentConnection!
createdAt: String!
defaultCurrency: ResonanceCurrency!
defaultLocaleType: ResonanceLocaleType!
demandHqId: ID!
demandHqIdentities(
after: String
before: String
first: Int
identityParentEntityId: ID
identityType: DemandHqIdentityType
last: Int
): DemandHqIdentityConnection!
demandHqIdentity(
demandHqId: ID!
identityId: ID!
): DemandHqIdentity
demandHqSupplier(
supplierId: ID!
): DemandHqSupplier
demandHqSuppliers(
after: String
before: String
first: Int
last: Int
status: DemandHqSupplierStatus
): DemandHqSupplierConnection!
demandSubscriptionCodes: [DemandSubscriptionCode!]
description: String
name: String!
notificationUserNames: DemandHqNotificationUserNames
notifications(
after: String
before: String
category: DemandHqNotificationCategory
first: Int
last: Int
status: DemandHqNotificationStatus!
): DemandHqNotificationConnection!
order(
orderId: ID!
): Order
orders(
after: String
before: String
first: Int
last: Int
orderIds: [ID]
): OrderConnection!
ownerUser: PublicIdentity
ownerUserName: String!
page(
pageId: ID
slug: String
): Page!
pages(
after: String
author: StringFilterInput
before: String
first: Int
last: Int
numberOfTermAggregations: PageNumberOfTermAggregationsInput
pageIds: [ID]
pageType: StringFilterInput
query: String
slugs: [String]
sortOrder: [PageSortInput]
status: DemandEntityStatusFilterInput
storefrontIds: IDFilterInput
tagPrefixes: [StringFilterInput]
tags: [StringFilterInput]
): PageConnectionWithSearch!
product(
productId: ID
slug: String
): Product
products(
after: String
before: String
first: Int
last: Int
manufacturer: [StringFilterInput]
msrp: [FloatRangeFilterInput]
numberOfTermAggregations: ProductNumberOfTermAggregationsInput
price: [FloatRangeFilterInput]
productIds: [ID]
query: String
slugs: [String]
sortOrder: [ProductSortInput]
standardizedColor: [ProductStandardizedColorFilterInput]
status: DemandEntityStatusFilterInput
storefrontIds: IDFilterInput
tagPrefixes: [StringFilterInput]
tags: [StringFilterInput]
vendor: StringFilterInput
): ProductConnectionWithSearch!
quickLink(
appId: ID!
quickLinkType: DemandHqQuickLinkType!
): DemandHqQuickLink
quickLinks(
after: String
before: String
first: Int
last: Int
quickLinkType: DemandHqQuickLinkType!
): DemandHqQuickLinkConnection!
status: DemandHqStatus!
storefront(
storefrontId: ID!
): Storefront
storefronts(
after: String
before: String
first: Int
last: Int
): StorefrontConnection
taxonomyBranches(
after: String
before: String
collectionId: ID
first: Int
last: Int
productTag: String
taxonomyBranchIds: [ID]
taxonomyLevel: TaxonomyLevel
taxonomyTree: String
): TaxonomyBranchConnection!
updatedAt: String!
updatedBy: ID!
}
Fields
DemandHq.automationSettings
● DemandHqAutomationSettings
object
The settings for Automation for this DemandHq.
Requires the demandhqautomationsettings/read permission on the associated DemandHq.
DemandHq.collection
● Collection!
non-null object
Get a collection by collectionId or slug (one must be provided).
Required collection/read permission on the given DemandHq.
DemandHq.collection.collectionId
●ID
scalar
DemandHq.collection.slug
● String
scalar
DemandHq.collections
● CollectionConnectionWithSearch!
non-null object
List collections for a DemandHq with optional filters.
Required collection/read permission on the given DemandHq.
DemandHq.collections.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.collections.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.collections.collectionIds
● [ID]
list scalar
Filter Collections to a set of collectionIds
DemandHq.collections.collectionType
● StringFilterInput
input
Filter Collections using collectionType
DemandHq.collections.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.collections.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.collections.numberOfTermAggregations
● CollectionNumberOfTermAggregationsInput
input
The number of results to return for each term aggregation. Defaults to 0 for each.
DemandHq.collections.query
● String
scalar
Query collections for certain terms. Searches several fields, including collection.description, collection.subtitle, collection.title, collectionTags, and the actual primary and secondary content of the collection.
DemandHq.collections.slugs
● [String]
list scalar
Filter Collections to a set of slugs
DemandHq.collections.sortOrder
● [CollectionSortInput]
list input
Sort Collections by a series of fields and directions, defaults to CREATED_AT/ASC.
DemandHq.collections.status
● DemandEntityStatusFilterInput
input
Filter Collections using status
DemandHq.collections.storefrontIds
● IDFilterInput
input
Optionally filter by storefrontIds.
DemandHq.collections.tagPrefixes
● [StringFilterInput]
list input
Filter Collections using Tag Prefixes (starts with).
DemandHq.collections.tags
● [StringFilterInput]
list input
Filter Collections using Tags.
DemandHq.comments
● DemandHqCommentConnection!
non-null object
A list of comments made by DemandHqIdentities (users) about this DemandHqEntity (product, collection, etc.)
Requires the demandhqnotification/read permission on the associated DemandHq.
DemandHq.comments.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.comments.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.comments.entityId
● ID!
non-null scalar
DemandHq.comments.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.comments.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.createdAt
● String!
non-null scalar
DemandHq.defaultCurrency
● ResonanceCurrency!
non-null enum
DemandHq.defaultLocaleType
● ResonanceLocaleType!
non-null enum
DemandHq.demandHqId
● ID!
non-null scalar
DemandHq.demandHqIdentities
● DemandHqIdentityConnection!
non-null object
Returns DemandHqIdentities for the given DemandHq
Requires demandHqidentity/read permission on the requesting identity
DemandHq.demandHqIdentities.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.demandHqIdentities.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.demandHqIdentities.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.demandHqIdentities.identityParentEntityId
● ID
scalar
Filter the results to a specific identityParentEntityId (optional)
DemandHq.demandHqIdentities.identityType
● DemandHqIdentityType
enum
Filter the results to a specific identity type (optional)
DemandHq.demandHqIdentities.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.demandHqIdentity
● DemandHqIdentity
object
Returns a DemandHqIdentity for the given DemandHq
Requires demandHqidentity/read permission on the requesting identity, or you can request your own identity.
DemandHq.demandHqIdentity.demandHqId
●ID!
non-null scalar
DemandHq.demandHqIdentity.identityId
● ID!
non-null scalar
DemandHq.demandHqSupplier
● DemandHqSupplier
object
Get a DemandHqSupplier by SupplierId.
Requires the requesting identity to have the "demandhqsupplier/read" permission on the associated DemandHq.
DemandHq.demandHqSupplier.supplierId
●ID!
non-null scalar
DemandHq.demandHqSuppliers
● DemandHqSupplierConnection!
non-null object
Get a list of DemandHqSuppliers for a DemandHQ.
Requires the requesting identity to have the "demandhqsupplier/read" permission on the associated DemandHq.
DemandHq.demandHqSuppliers.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.demandHqSuppliers.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.demandHqSuppliers.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.demandHqSuppliers.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.demandHqSuppliers.status
● DemandHqSupplierStatus
enum
DemandHq.demandSubscriptionCodes
● [DemandSubscriptionCode!]
list enum
DemandHq.description
● String
scalar
DemandHq.name
● String!
non-null scalar
DemandHq.notificationUserNames
● DemandHqNotificationUserNames
object
These users will get notified if something requires attention for this DemandHq. If none are provided, ownerUserName will be notified.
DemandHq.notifications
● DemandHqNotificationConnection!
non-null object
List notifications for a DemandHq.
Requires the demandhqnotification/read permission on the associated DemandHq.
DemandHq.notifications.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.notifications.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.notifications.category
● DemandHqNotificationCategory
enum
DemandHq.notifications.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.notifications.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.notifications.status
● DemandHqNotificationStatus!
non-null enum
DemandHq.order
● Order
object
Get an order for an orderId.
Requires the order/read scope on the associated DemandHq.
DemandHq.order.orderId
●ID!
non-null scalar
DemandHq.orders
● OrderConnection!
non-null object
Get a list of orders for a DemandHq.
Requires the order/read scope on the associated DemandHq.
DemandHq.orders.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.orders.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.orders.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.orders.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.orders.orderIds
● [ID]
list scalar
DemandHq.ownerUser
● PublicIdentity
object
Get a public identity for the owner of this DemandHq
DemandHq.ownerUserName
● String!
non-null scalar
DemandHq.page
● Page!
non-null object
Get a page by pageId or slug (one must be provided).
Required page/read permission on the given DemandHq.
DemandHq.page.pageId
●ID
scalar
DemandHq.page.slug
● String
scalar
DemandHq.pages
● PageConnectionWithSearch!
non-null object
List pages for a DemandHq with optional filters.
Required page/read permission on the given DemandHq.
DemandHq.pages.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.pages.author
● StringFilterInput
input
Filter Pages using author
DemandHq.pages.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.pages.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.pages.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.pages.numberOfTermAggregations
● PageNumberOfTermAggregationsInput
input
The number of results to return for each term aggregation. Defaults to 0 for each.
DemandHq.pages.pageIds
● [ID]
list scalar
Filter Pages to a set of pageIds
DemandHq.pages.pageType
● StringFilterInput
input
Filter Pages using pageType
DemandHq.pages.query
● String
scalar
Query pages for certain terms. Searches several fields, including page.author, page.description, page.subtitle, page.title, pageTags, and the actual content of the page.
DemandHq.pages.slugs
● [String]
list scalar
Filter Pages to a set of slugs
DemandHq.pages.sortOrder
● [PageSortInput]
list input
Sort Pages by a series of fields and directions, defaults to CREATED_AT/ASC.
DemandHq.pages.status
● DemandEntityStatusFilterInput
input
Filter Pages using status
DemandHq.pages.storefrontIds
● IDFilterInput
input
Optionally filter by storefrontIds.
DemandHq.pages.tagPrefixes
● [StringFilterInput]
list input
Filter Pages using Tag Prefixes (starts with).
DemandHq.pages.tags
● [StringFilterInput]
list input
Filter Pages using Tags.
DemandHq.product
● Product
object
Get a single product by ID or slug.
Requires the product/read scope on the associated DemandHq.
DemandHq.product.productId
●ID
scalar
DemandHq.product.slug
● String
scalar
DemandHq.products
● ProductConnectionWithSearch!
non-null object
Get a list of products.
Requires the product/read scope on the associated DemandHq.
DemandHq.products.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.products.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.products.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.products.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.products.manufacturer
● [StringFilterInput]
list input
Optionally filter by manufacturer.
DemandHq.products.msrp
● [FloatRangeFilterInput]
list input
Optionally filter by msrp.
DemandHq.products.numberOfTermAggregations
● ProductNumberOfTermAggregationsInput
input
The number of results to return for each term aggregation. Defaults to 0 for each.
DemandHq.products.price
● [FloatRangeFilterInput]
list input
Optionally filter by price.
DemandHq.products.productIds
● [ID]
list scalar
Filter Products to a set of productIds
DemandHq.products.query
● String
scalar
Query products for certain terms. Searches several fields, including product.tags, product.title, product.vendor, productLocales.description, productLocales.featureBullets, variant.barcode, variant.mpn, variant.sku
DemandHq.products.slugs
● [String]
list scalar
Filter Products to a set of slugs
DemandHq.products.sortOrder
● [ProductSortInput]
list input
Sort Products by a series of fields and directions, defaults to CREATED_AT/ASC.
DemandHq.products.standardizedColor
● [ProductStandardizedColorFilterInput]
list input
Optionally filter by standardized color.
DemandHq.products.status
● DemandEntityStatusFilterInput
input
Filter Products using Status.
DemandHq.products.storefrontIds
● IDFilterInput
input
Optionally filter by storefrontIds.
DemandHq.products.tagPrefixes
● [StringFilterInput]
list input
Filter Products using Tag Prefixes (starts with).
DemandHq.products.tags
● [StringFilterInput]
list input
Filter Products using Tags.
DemandHq.products.vendor
● StringFilterInput
input
Optionally filter by vendor.
DemandHq.quickLink
● DemandHqQuickLink
object
Get a single DemandHqQuickLink by its ids
DemandHq.quickLink.appId
●ID!
non-null scalar
DemandHq.quickLink.quickLinkType
● DemandHqQuickLinkType!
non-null enum
DemandHq.quickLinks
● DemandHqQuickLinkConnection!
non-null object
List multiple DemandHqQuickLinks for a single DemandHqQuickLinkType
DemandHq.quickLinks.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.quickLinks.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.quickLinks.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.quickLinks.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.quickLinks.quickLinkType
● DemandHqQuickLinkType!
non-null enum
DemandHq.status
● DemandHqStatus!
non-null enum
DemandHq.storefront
● Storefront
object
Get a storefront by its storefrontId.
Requires the storefront/read permission on the associated DemandHq.
DemandHq.storefront.storefrontId
●ID!
non-null scalar
DemandHq.storefronts
● StorefrontConnection
object
List storefronts for a DemandHq.
Requires the storefront/read permission on the associated DemandHq.
DemandHq.storefronts.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.storefronts.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.storefronts.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.storefronts.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.taxonomyBranches
● TaxonomyBranchConnection!
non-null object
List TaxonomyBranches for a DemandHq.
Requires the user to have the taxonomyBranch/read permission on the associated DemandHq.
DemandHq.taxonomyBranches.after
●String
scalarReturns the elements in the list that come after the specified cursor.
DemandHq.taxonomyBranches.before
● String
scalar
Returns the elements in the list that come before the specified cursor.
DemandHq.taxonomyBranches.collectionId
● ID
scalar
DemandHq.taxonomyBranches.first
● Int
scalar
Returns the first n elements from the list.
DemandHq.taxonomyBranches.last
● Int
scalar
Returns the last n elements from the list.
DemandHq.taxonomyBranches.productTag
● String
scalar
DemandHq.taxonomyBranches.taxonomyBranchIds
● [ID]
list scalar
DemandHq.taxonomyBranches.taxonomyLevel
● TaxonomyLevel
enum
DemandHq.taxonomyBranches.taxonomyTree
● String
scalar
DemandHq.updatedAt
● String!
non-null scalar
DemandHq.updatedBy
● ID!
non-null scalar
Returned by
createDemandHq
mutation ● demandHq
query ● updateDemandHq
mutation
Member of
DemandHqIdentity
object