OBJECT
ProductEntity

GraphQL Schema definition

type ProductEntity {
# Arguments
#   apiNames: Api names of custom fields to retrieve. All are 
#   returned if not set.
customFields(apiNames: [String!]): JSONString! 
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
isDeleteProtected: Boolean! 
#   Unique identifier of entity.
id: ID! 
#   Specifies if the entity is considered deleted.
isDeleted: Boolean 
#   Last modification time.
modified: DateTime 
#   Creation time.
created: DateTime 
#   Currency exchange rate list used to convert monetary fields linked to this 
#   product. Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
#   Product picture.
picture: CloudObjectEntity 
#   Product category this product belongs to. Categories form a hierarchy used in 
#   the catalog browser.
productCategory: ProductCategoryEntity 
#   Product type that classifies this product. Product types are configurable per 
#   team space and drive which form, fields and product-line behavior apply.
productType: ProductTypeEntity 
#   Whether this product can be added to all pipelines or only the explicitly linked 
#   subset (see product_pipeline_relations).
allowedPipelines: AccessPipelinesEnum 
#   Id of the currency exchange rate list applied to this product.
currencyExchangeRatesListId: ID 
#   Free-form description of the product.
description: String 
#   Name of the product, shown in catalogues and pickers.
name: String! 
#   Id of the product picture document.
pictureId: ID 
#   Id of the product category.
productCategoryId: ID 
#   Id of the product type.
productTypeId: ID 
#   Stock-keeping unit (SKU) identifier of the product. Must be unique across 
#   products.
sku: String 
#   Unit of measure shown next to product quantities (e.g. pcs, kg, hours).
unitSymbol: String 
#   Revision when entity was lastly changed.
revision: 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.
productPipelineRelations(
filter: PipelineFilterInput,
filterEdge: ProductPipelineRelationFilterInput,
orderBy: [PipelineOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProductPipelineRelationEntityConnection 
#   Configuration of Pipelines where the Product can be used.
productPipelines: ProductPipelinesObject 
#   Display version of the product name, used in lists and references.
formattedName: String! 
#   Id of the product line-item type derived from product_type. Used as a filter 
#   when listing relations on opportunities and quotes. Read-only.
opptyProductRelationTypeId: UUID! 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
#   Returns price of product for specific price list. If price_list == null then 
#   returns 0
# 
# Arguments
#   priceListId: [Not documented]
#   currencyId: [Not documented]
priceListPrice(priceListId: ID, currencyId: ID): Float 
}
ProductEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
