Product

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Create	Mutation	`createProduct`	`ProductCreateGLDtoInput`
POST	Update	Mutation	`updateProduct`	`ProductUpdateGLDtoInput`
POST	Delete	Mutation	`deleteProduct`	`ProductDeleteGLDtoInput`
POST	Read	Query	`products filtered by id` Why?
POST	List	Query	`products`

Description

Products, both identified as Product in the API context and in the product interface, serve as the foundational elements for creating and managing sales transactions.

In the scope of sales documents, such as quotes, orders, delivery notes, and invoices, the Products entity plays a pivotal role.
Each product entry can include a comprehensive set of details, from basic identifiers like the product code and name, to more complex attributes like tax codes, discount rates, and stock levels.
This enables seamless generation and manipulation of various sales documents, ensuring both accuracy and consistency across transactions.

Additionally, the Products entity can be associated with various pricing models, such as standard rates, special discounts, promotional offers, and tiered pricing strategies. These associations help in automating the calculation of final costs in sales documents, making the process more efficient and less prone to errors.

To see examples of mutations that include the adding of :
download the Postman collection: Quick start / 5. Test your first query in Postman

Would you like to see an example of how to add a product?

graphQL Mutation

mutation ($values: ProductCreateGLDtoInput!) {  
    createProduct(input: $values) {
    id
  }
}

graphQL Variables

{
  "values":{
      "code": "SILVRING",
      "name": "Silver Ring",
      "lineDescription": "This ring showcases a timeless design that complements any outfit.",
      "comments": "This ring has been a bestseller in previous collections.",
      "salesUnitPrice": 400,
      "taxGroupId":"{taxGroupId}",
  }
} 

Example of Response

{
    "data": {
        "createProduct": {
            "id": "e451aff7-074f-4e72-a6fb-4ea25e9d9c64"
        }
    }
}

Key	Value
`Authorization`	Bearer Current access Token How to find?
`X-TenantId`	Current tenant id How to find?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

products

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	ID
creationDate SSystem field that cannot be assigned	DateTime	Creation Date
modificationDate SSystem field that cannot be assigned	DateTime	Modification Date

category DIn creation, this field can have a default value automatically calculated	PRODUCT SERVICE	Product Category See InfoAdditional information is available in the Info block below
code *The value of the field or object is mandatory	String	Product Code	15
name *The value of the field or object is mandatory	String	Product Name	50
registrationDate RThis field is read-only, its value cannot be assigned	DateTime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Timestamp for tracking and auditing
obsolete DIn creation, this field can have a default value automatically calculated	Boolean	Whether the product is obsolete See InfoAdditional information is available in the Info block below
obsoleteDate RThis field is read-only, its value cannot be assigned	DateTime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date when obsolete was enabled

lineDescription	String	Online Description See InfoAdditional information is available in the Info block below	250
comments	String	Additional comments See InfoAdditional information is available in the Info block below	250

taxes[] DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	Array	List of taxes from the product’s tax group.
taxGroupId DIn creation, this field can have a default value automatically calculated	UUID	Tax Group ID See InfoAdditional information is available in the Info block below
salesAccountingAccount DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	Sales Accounting Account	Fields of Sales Accounting Account
salesAccountingAccountid DIn creation, this field can have a default value automatically calculated	UUID	Sales Accounting Account ID See InfoAdditional information is available in the Info block below

salesUnitPrice DIn creation, this field can have a default value automatically calculated	Decimal	Sales Unit Price
salesVatPercentage RThis field is read-only, its value cannot be assigned	Decimal	Sales VAT Percentage See InfoAdditional information is available in the Info block below
firstSalesDiscount	Decimal	First Sales Discount

salesOrderBlockingEnabled DIn creation, this field can have a default value automatically calculated	Boolean	Is Sales Order Blocking Enabled
salesOrderBlockingDate RThis field is read-only, its value cannot be assigned InvThis field is not visible in the product interface	DateTime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date when Sales Order Blocking was enabled
salesDeliveryNoteBlockingEnabled DIn creation, this field can have a default value automatically calculated	Boolean	Is Sales Delivery Note Blocking Enabled
salesDeliveryNoteBlockingDate RThis field is read-only, its value cannot be assigned InvThis field is not visible in the product interface	DateTime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date when Sales Delivery Note Blocking was enabled
salesInvoiceBlockingEnabled DIn creation, this field can have a default value automatically calculated	Boolean	Is Sales Invoice Blocking Enabled
salesInvoiceBlockingDate RThis field is read-only, its value cannot be assigned InvThis field is not visible in the product interface	DateTime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date when Sales Invoice Blocking was enabled

Info

category: Optional enum value specifying the general type of the item, either PRODUCT or SERVICE.
Default value is PRODUCT.
obsolete: Optional Boolean flag to indicate if the product is obsolete or discontinued.
Default value is false. It can only be set when modifying a product, not during creation.
lineDescription: A text field serving as the product description, containing information that can be visible to the customer.
comments: A text field for defining internal information, for example, a sales argument.

taxGroupId: Optional unique identifier (UUID) specifying the tax group applicable to the product.
Default value is the one defined in Configuration / Company / Sales and Operations / Tax group.

salesAccountingAccountId: Optional unique identifier (UUID) specifying the Sales Accounting Account associated with the product.
Default value is the one defined in Configuration / Company / Accounting / Sales account.

salesVatPercentage: Retrieved from taxes via taxGroupId / percentage, corresponds to the VAT rate of the item.
On the product interface, it is used to calculate Gross Price from Net Price.