Skip to main content

SupplierProduct

This is the main entity of the Supplier domain, and is used to represent a product, which is a group of SKUs. SKUs are represented by SupplierVariants, a child of this entity. This entity is less frequently updated, it is more likely that SupplyVariant will be updated frequently.

type SupplierProduct {
  contentItem(
  contentItemId: ID!
): SupplierProductContentItem
  contentItems(
  after: String
  before: String
  contentType: SupplierProductContentType
  first: Int
  last: Int
): SupplierProductContentItemConnection
  createdAt: Date!
  externalProductId: String!
  featuredImage: SupplierProductContentItem
  locale(
  localeType: ResonanceLocaleType!
): SupplierProductLocale
  locales(
  after: String
  before: String
  first: Int
  last: Int
): SupplierProductLocaleConnection!
  optionLabels: [String!]!
  status: SupplyEntityStatus!
  supplierId: ID!
  supplierProductId: ID!
  supplierVariant(
  supplierVariantId: ID
): SupplierVariant
  supplierVariants(
  after: String
  before: String
  first: Int
  last: Int
): SupplierVariantConnection!
  tags: SupplierProductTags
  title: String!
  updatedAt: Date!
  updatedBy: ID!
  vendor: String!
}

Fields​

SupplierProduct.contentItem ● SupplierProductContentItem object​

Get a supplierProductContentItem for a supplierProduct

Requires supplierproductcontentitem/read permission on the requesting identity

SupplierProduct.contentItem.contentItemId ● ID! non-null scalar​

SupplierProduct.contentItems ● SupplierProductContentItemConnection object​

Get a list of supplierProductContentItems

Requires supplierproductcontentitem/read permission on the supplier for the requesting identity

Sorts by position. This means "featuredImage" can be retrieved by using contentType: IMAGE and first: 1.

SupplierProduct.contentItems.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

SupplierProduct.contentItems.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

SupplierProduct.contentItems.contentType ● SupplierProductContentType enum​
SupplierProduct.contentItems.first ● Int scalar​

Returns the first n elements from the list.

SupplierProduct.contentItems.last ● Int scalar​

Returns the last n elements from the list.

SupplierProduct.createdAt ● Date! non-null scalar​

SupplierProduct.externalProductId ● String! non-null scalar​

Passed along in PurchaseOrders so the Supplier can identify items in their warehouse.

SupplierProduct.featuredImage ● SupplierProductContentItem object​

Get the featured image for a supplierProduct

Requires the supplierproductcontentitem/read permission on the associated Supplier.

This is a convenience field that is equivalent to contentItems(contentType: IMAGE, first: 1)

SupplierProduct.locale ● SupplierProductLocale object​

Get a single supplierProductLocale by ResonanceLocaleType

Requires supplierproductlocale/read permission on the requesting identity

SupplierProduct.locale.localeType ● ResonanceLocaleType! non-null enum​

SupplierProduct.locales ● SupplierProductLocaleConnection! non-null object​

List supplierProductLocales.

Requires supplierproductlocale/read permission on the requesting identity

SupplierProduct.locales.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

SupplierProduct.locales.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

SupplierProduct.locales.first ● Int scalar​

Returns the first n elements from the list.

SupplierProduct.locales.last ● Int scalar​

Returns the last n elements from the list.

SupplierProduct.optionLabels ● [String!]! non-null scalar​

The labels for the options of this product, i.e. ["Color", "Size"] These will match with the order of the optionValues on the SupplierVariants. Must have 1-3, and it should match the number of options in the variants, but there is no validation to do so. Set the first optionLabel to "No Option" if you don't want to use options for this product. See https://docs.buildresonance.com/concepts/products/#no-option-products for more info.

SupplierProduct.status ● SupplyEntityStatus! non-null enum​

Indicates whether a product is live and able to be ordered.

SupplierProduct.supplierId ● ID! non-null scalar​

Reference to the Supplier that owns this product.

SupplierProduct.supplierProductId ● ID! non-null scalar​

SupplierProduct.supplierVariant ● SupplierVariant object​

Get a single supplierVariant by SupplierVariantId

Requires suppliervariant/read permission on the requesting identity

SupplierProduct.supplierVariant.supplierVariantId ● ID scalar​

SupplierProduct.supplierVariants ● SupplierVariantConnection! non-null object​

Get a list of supplierVariants

Requires suppliervariant/read permission on the supplier for the requesting identity

SupplierProduct.supplierVariants.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

SupplierProduct.supplierVariants.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

SupplierProduct.supplierVariants.first ● Int scalar​

Returns the first n elements from the list.

SupplierProduct.supplierVariants.last ● Int scalar​

Returns the last n elements from the list.

SupplierProduct.tags ● SupplierProductTags object​

Get tags for a SupplierProduct.

SupplierProduct.title ● String! non-null scalar​

The title of the product.

SupplierProduct.updatedAt ● Date! non-null scalar​

SupplierProduct.updatedBy ● ID! non-null scalar​

SupplierProduct.vendor ● String! non-null scalar​

The brand or manufacturer of the product.

Returned by​

createSupplierProduct mutation ● createSupplierProductComposite mutation ● supplierProduct query ● updateSupplierProduct mutation ● updateSupplierProducts mutation

Member of​

Supplier object ● SupplierProductConnectionWithSearch object ● SupplierProductEdge object