Required fields
Product code, unique within the company. Send
"Next" on create to generate it from the company’s ÜRÜN serial number definition; "Next" cannot be used on update (2003). The generation works exactly like the customer code, only the serial number definition differs.Main unit code: the universal code (for example
C62) or, when it has none, the name of a unit.Product type
Expense, fixed asset and consumable records are entered from separate screens in the application; they cannot be created through the API and those values are rejected (
2007). Records of these types that already exist in the database are also completely invisible through the API: they never appear in the list, in a get, in any sub-resource (price, parameter, critical stock) or in any reference made by ProductCode (a quote/order/despatch line, a price’s scope, …); trying their ID directly returns 2000 (product not found).
Stock type
Tax fields
VatRate: one of the rates (for example20) from the VAT rate definitions.AdditionalTaxes: additional taxes (such as ÖTV) as a list of{ Code, Rate }, at most 3 entries (2017). EachCodeis required and must be one of the additional tax codes below (2015), and the same code can be used only once on a product (2016). Send an empty list when the product has none.
Export fields
Gtip, DeliveryTerm, PackagingType, TransportMode, OriginCountryCode, Brand and Model are used in the additional information of export invoices.
Groups
Group1 … Group5 hold the selected values of the product groups. The name you send must belong to the matching group in the group details: only a group 2 detail can be sent as Group2 (2011).
Product groups are hierarchical: the parent of a detail (ParentGroup) is always a detail of the previous group.
- Group 1 details have no parent, so all of them are always selectable.
- Once a detail is selected in group 2, only the details whose parent is that detail and the details without a parent can be selected in group 3. The same rule applies for 3 → 4 and 4 → 5.
- A detail without a parent can be selected under every parent. For example a “SUV” body type that is valid for every brand is defined without a parent.
Group3 is a detail whose parent is neither the detail selected in Group2 nor empty, the request is rejected with 2013.
Variants
A product can be a variant of another product (its main product). The product responses (List products, Get product, List changed products) returnMainProductId and MainProductCode: both are empty for a main product and filled for a variant. Variants are defined in Noyax; the API does not create or change this link.
In List changed products, a variant without prices of its own returns its main product’s prices (PricesFromMainProduct: true) and a variant with no product groups selected returns its main product’s groups (GroupsFromMainProduct: true). List products and Get product return only the variant’s own values.
Units
The product’s main unit is written withUnitCode. The second and third units cannot be written through the API; they are defined in Noyax and returned in the product response as AlternativeUnits, with their conversion to the main unit. On prices and on quote, order, despatch and invoice lines, UnitCode can be the main unit or one of these units.
Quantity is 0 the conversion is not defined and lines using this unit are rejected.