Skip to main content

SupplierVariant

The main item of the Supplier Domain, represents a single SKU of a product Only the variant level exists, there is no parent product.

type SupplierVariant {
  contentItemIds: [ID]
  contentItems: [SupplierProductContentItem]
  createdAt: String!
  externalVariantId: String!
  featuredImage: SupplierProductContentItem
  inventoryPolicy: SupplierVariantInventoryPolicy!
  inventoryQuantity: Int!
  inventoryStatus: VariantInventoryStatus
  optionValues: [String!]!
  purchaseOrderItems(
  after: String
  before: String
  first: Int
  last: Int
): PurchaseOrderItemConnection!
  supplement: SupplierVariantSupplement
  supplierId: ID!
  supplierProductId: ID!
  supplierVariantId: ID!
  title: String!
  updatedAt: String!
  updatedBy: String!
}

Fields​

SupplierVariant.contentItemIds ● [ID] list scalar​

Associates contentItems with this variant

SupplierVariant.contentItems ● [SupplierProductContentItem] list object​

Get a list of supplierProductContentItems for a supplierVariant.

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

SupplierVariant.createdAt ● String! non-null scalar​

SupplierVariant.externalVariantId ● String! non-null scalar​

SupplierVariant.featuredImage ● SupplierProductContentItem object​

Get the featured image for a supplierVariant

Requires the supplierproductcontentitem/read permission on the associated Supplier.

This is a convenience field that returns the first content item with the type IMAGE, if exists for the associated supplierProduct.

SupplierVariant.inventoryPolicy ● SupplierVariantInventoryPolicy! non-null enum​

SupplierVariant.inventoryQuantity ● Int! non-null scalar​

SupplierVariant.inventoryStatus ● VariantInventoryStatus enum​

Get the inventory status of this variant

SupplierVariant.optionValues ● [String!]! non-null scalar​

An array of the option values that make up this variant. For example, a product with a color and size option would have two option values, one for each of the color and size options, i.e. ["Red", "Small"] Must have 1-3, and it should match the number of options in the product, but there is no validation to do so. Set this to "No Option" if you don't want to use options for this product and this is the only variant. See https://docs.buildresonance.com/concepts/products/#no-option-products for more info.

SupplierVariant.purchaseOrderItems ● PurchaseOrderItemConnection! non-null object​

Get a list of PurchaseOrderItems for a SupplierVariant.

Requires purchaseorderitem/read permissions on the Supplier
SupplierVariant.purchaseOrderItems.after ● String scalar​

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

SupplierVariant.purchaseOrderItems.before ● String scalar​

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

SupplierVariant.purchaseOrderItems.first ● Int scalar​

Returns the first n elements from the list.

SupplierVariant.purchaseOrderItems.last ● Int scalar​

Returns the last n elements from the list.

SupplierVariant.supplement ● SupplierVariantSupplement object​

Get the supplierVariantSupplement for a supplierVariant

Requires suppliervariantsupplement/read permission on the requesting identity

SupplierVariant.supplierId ● ID! non-null scalar​

SupplierVariant.supplierProductId ● ID! non-null scalar​

SupplierVariant.supplierVariantId ● ID! non-null scalar​

SupplierVariant.title ● String! non-null scalar​

Get the title of this variant (combo of optionValues)

SupplierVariant.updatedAt ● String! non-null scalar​

SupplierVariant.updatedBy ● String! non-null scalar​

Returned by​

createSupplierVariant mutation ● supplierVariant query ● updateSupplierVariant mutation ● updateSupplierVariants mutation

Member of​

SupplierProduct object ● SupplierVariantComposite object ● SupplierVariantConnection object ● SupplierVariantEdge object