Product
Represents a product in the catalog, including its specifications, pricing, inventory, supplier relationships, and composition details. Products can be base items, kits, components, or non-inventory items.
type Product {
attachments: [File!]
brand: Brand!
brandId: ID!
bulletPoints: [String!]
category: ProductCategory
color: Color
components: [Product!]!
compositionLines: [CompositionLine!]
compositionType: CompositionTypeEnum
costs(
supplierId: ID
): [ProductCost!]
createdAt: ISO8601DateTime!
createdBy: Party
createdById: ID
currencyCode: CurrencyCodeEnum
dataQuality: Int!
daysSupply: CalculatedField
description: String
grossMargin: Decimal
height: Decimal
id: ID!
image: ProductImage
images: [ProductImage!]
innerPack: Boolean!
inventoryItem: InventoryItem
inventoryItemId: ID
last90DaysOrders: CalculatedField
length: Decimal
masterCarton: Boolean!
name: String!
packagingUrl: Url
pallet: Boolean!
parent: Product
partNumber: String
price: Decimal @deprecated
priceMap: MonetaryValue
priceMsrp: MonetaryValue
productCustoms: Customs
productEconomics: ProductEconomics
productInnerPack: InnerPack
productMasterCarton: MasterCarton
productPallet: Pallet
productPurchasing: Purchasing @deprecated
productShipping: Shipping
productTags: [ProductTag!]
productType: ProductTypeEnum!
productTypeName: String!
restockThreshold: Int
ship: Boolean!
size: Size
sku: String
sourcingMethod: ProductSourcingMethodEnum
specsUrl: Url
status: ProductStatusEnum!
style: Style
suppliers: [ProductSupplier!]
uom: ProductUomEnum
upc: String
updatedAt: ISO8601DateTime!
updatedBy: Party
updatedById: ID
volume: Decimal
weight: Decimal
width: Decimal
}
Fields
Product.attachments ● [File!] list object
Product.brand ● Brand! non-null object
Product.brandId ● ID! non-null scalar
Product.bulletPoints ● [String!] list scalar
Product.category ● ProductCategory object
Product.color ● Color object
Product.components ● [Product!]! non-null object
The components referenced by the composition lines
Product.compositionLines ● [CompositionLine!] list object
The components that make up this product with their relationship information.
Product.compositionType ● CompositionTypeEnum enum
Product.costs ● [ProductCost!] list object
The costs associated with this product.
Product.costs.supplierId ● ID scalar
Filter costs by a specific supplier ID.
Product.createdAt ● ISO8601DateTime! non-null scalar
Product.createdBy ● Party object
The party that created the product.
Product.createdById ● ID scalar
Product.currencyCode ● CurrencyCodeEnum enum
Product.dataQuality ● Int! non-null scalar
The "Data Quality" field denotes the percentage of fields that have been filled out for a product. This information aids in determining the completeness of a product's information.
Product.daysSupply ● CalculatedField object
Indicates how many days of demand the current inventory can fulfill for the product.
Product.description ● String scalar
Product.grossMargin ● Decimal scalar
Product.height ● Decimal scalar
Product.id ● ID! non-null scalar
Product.image ● ProductImage object
Product.images ● [ProductImage!] list object
Product.innerPack ● Boolean! non-null scalar
Product.inventoryItem ● InventoryItem object
Product.inventoryItemId ● ID scalar
Product.last90DaysOrders ● CalculatedField object
Indicates the number of orders where the item was included for the last 90 days.
Product.length ● Decimal scalar
Product.masterCarton ● Boolean! non-null scalar
Product.name ● String! non-null scalar
Product.packagingUrl ● Url scalar
Product.pallet ● Boolean! non-null scalar
Product.parent ● Product object
Product.partNumber ● String scalar
Product.price ● Decimal deprecated scalar
Will be removed in the future. Use priceMsrp instead
Product.priceMap ● MonetaryValue object
Product.priceMsrp ● MonetaryValue object
Product.productCustoms ● Customs object
Product.productEconomics ● ProductEconomics object
Product.productInnerPack ● InnerPack object
Product.productMasterCarton ● MasterCarton object
Product.productPallet ● Pallet object
Product.productPurchasing ● Purchasing deprecated object
Will be removed in the future. Use productEconomics instead
Product.productShipping ● Shipping object
Product.productTags ● [ProductTag!] list object
Product.productType ● ProductTypeEnum! non-null enum
Product.productTypeName ● String! non-null scalar
Product.restockThreshold ● Int scalar
Product.ship ● Boolean! non-null scalar
Product.size ● Size object
Product.sku ● String scalar
Product.sourcingMethod ● ProductSourcingMethodEnum enum
Product.specsUrl ● Url scalar
Product.status ● ProductStatusEnum! non-null enum
Product.style ● Style object
Product.suppliers ● [ProductSupplier!] list object
The suppliers relationships for this product.
Product.uom ● ProductUomEnum enum
Product.upc ● String scalar
Product.updatedAt ● ISO8601DateTime! non-null scalar
Product.updatedBy ● Party object
The last party that updated the product.
Product.updatedById ● ID scalar
Product.volume ● Decimal scalar
The "Volume" field denotes the amount of space occupied by a product in three dimensions (length, width, height). This information aids in optimizing storage, packaging, and shipping calculations.
Product.weight ● Decimal scalar
Product.width ● Decimal scalar
Returned By
addProduct mutation ● cloneProduct mutation ● product query ● updateProduct mutation
Member Of
ASNItem object ● CompositionLine object ● InventoryItem object ● OrderItem object ● POItem object ● Product object ● ProductCategory object ● ProductConnection object ● ProductCost object ● ProductEdge object ● ProductImage object ● ProductPrice object ● ProductSalesChannel object ● ProductSupplier object ● ProductTag object ● SupplyComponentInventoryDetails object ● SupplyInventoryDetails object ● SupplyOrderItem object ● SupplyShipmentItem object ● SupplySupplier object ● SupplyWarehouseComposition object
Implemented By
Notable union