OBJECT

ProductEntity

link 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
  • currencyExchangeRatesList: CurrencyExchangeRatesListEntity
  • picture: CloudObjectEntity
  • productCategory: ProductCategoryEntity
  • productType: ProductTypeEntity
  • # Field whose values are strictly defined with an enumeration of values.
  • allowedPipelines: AccessPipelinesEnum
  • # Relation to single entity instance.
  • currencyExchangeRatesListId: ID
  • # Multi-line text input field.
  • description: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • name: String!
  • # Relation to single entity instance.
  • pictureId: ID
  • # Relation to single entity instance.
  • productCategoryId: ID
  • # Relation to single entity instance.
  • productTypeId: ID
  • # Simple text input field.
  • sku: String
  • # Simple text input field.
  • unitSymbol: String
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Relations to Pipelines.
  • #
  • # 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
  • formattedName: String!
  • 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
  • }