OBJECT
ProductEntity
Product or service in the catalog that can be added as a line item to opportunities and quotes.
link GraphQL Schema definition
- type ProductEntity {
- # Values of the record's custom fields as a JSON object keyed by custom field
- # apiName (camelCase).
- #
- # Arguments
- # apiNames: Api names of custom fields to retrieve. All are
- # returned if not set.
- (: [String!]): JSONString!
- # True when the record is protected against deletion because it must always exist
- # in the space. Deleting a record that is not protected can still fail on other
- # checks. Read-only.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Currency exchange rate list used to convert monetary fields linked to this
- # product. Empty to inherit the team space default.
- : CurrencyExchangeRatesListEntity
- # Product picture.
- : CloudObjectEntity
- # Product category this product belongs to. Categories form a hierarchy used in
- # the catalog browser.
- : ProductCategoryEntity
- # Product type that classifies this product. Product types are configurable per
- # team space and drive which form, fields and product-line behavior apply.
- : ProductTypeEntity
- # Whether this product can be added to all pipelines or only the explicitly linked
- # subset (see productPipelineRelations).
- : AccessPipelinesEnum
- # Id of the currency exchange rate list applied to this product.
- : ID
- # Free-form description of the product.
- : String
- # Name of the product, shown in catalogues and pickers.
- : String!
- # Id of the product picture document.
- : ID
- # Id of the product category this product belongs to, or empty when it is not
- # categorized.
- : ID
- # Id of the product type that classifies this product.
- : ID
- # Stock-keeping unit (SKU) identifier of the product. Must be unique across
- # products.
- : String
- # Unit of measure shown next to product quantities (e.g. pcs, kg, hours).
- : String
- # Revision when entity was lastly changed.
- : Int
- # Deprecated pipeline connection.
- #
- # Arguments
- # filter: Filter Pipeline relations by target Pipeline
- # attributes.
- # filterEdge: Filter ProductPipelineRelation relations by edge
- # (relation) ProductPipelineRelation attributes.
- # orderBy: Order Pipeline relations by target Pipeline
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : PipelineFilterInput,
- : ProductPipelineRelationFilterInput,
- : [PipelineOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ProductPipelineRelationEntityConnection
- # Configuration of Pipelines where the Product can be used.
- : ProductPipelinesObject
- # Display version of the product name, used in lists and references.
- : String!
- # Id of the product line-item type derived from productType. Used as a filter when
- # listing relations on opportunities and quotes. Read-only.
- : UUID!
- # Active price lists this product is priced in, ordered by name. Read-only;
- # computed by Coevera.
- : [ProductPriceListReference!]
- # Active price schedules this product is priced in, ordered by name. Read-only;
- # computed by Coevera.
- : [ProductPriceListReference!]
- # Permissions the current user has on this record, out of the requested ones.
- #
- # Arguments
- # permissions: Permissions to check; the result lists those the
- # current user has.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- # Price of the product in the given price list and currency. Returns 0 when either
- # is not given or the product has no price for that combination.
- #
- # Arguments
- # priceListId: Price list to read the price from.
- # currencyId: Currency of the price.
- (: ID, : ID): Float
- }
link Require by
- AccountProductPricingEntitySpecial price of a product for one account, used instead of the regular price when the product is sold to that account.
- CallEntityPhone call logged in the space, linked to the user who made it and to the contact, account, lead or opportunity it concerns.
- CreateProductPayloadResult of the createProduct mutation.
- CustomEntityRelationDataEntityLink between two records made through a custom relation, such as an account linked to a custom entity record.
- DeleteProductPayloadResult of the deleteProduct mutation.
- OpptyProductRelationEntityProduct line item on an opportunity or quote, with its quantity, price and discount.
- ProductDataExRelationEntityOption selected in a multi-select checkbox field of a product.
- ProductEntityEdgeA Relay edge containing a `ProductEntity` and its cursor.
- ProductPipelineRelationEntityPipeline in which a product can be added as a line item.
- ProductPriceListPriceEntityPrice of a product in one currency within a price list.
- ProductRepositoryRead operations for Product records.
- UpdateProductPayloadResult of the updateProduct mutation.