Skip to main content
The product card is the main definition used by stock, invoice, order and quote records.

​
Required fields

​
string
required
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.
​
string
required
Product name. At most 255 characters.
​
string
required
Main unit; must be an ID from the unit definitions.
All other fields are optional.

​
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).

​
Stock type

​
Tax fields

  • VatRateId: an ID from the VAT rate definitions.
  • AdditionalTaxCode1-3 and AdditionalTaxRate1-3: code and rate of an additional tax.

​
Export fields

Gtip, DeliveryTerm, PackagingType, TransportMode, OriginCountryCode, Brand and Model are used in the additional information of export invoices.
The TransportMode of a product is the export code list; it is not the same list as the TransportMode of shipment definitions (1 road, 2 rail, 3 maritime, 4 air).

​
Groups

GroupDetailId1 … GroupDetailId5 hold the selected values of the product groups. The ID you send must belong to the matching group in the group details: only a group 2 detail can be sent as GroupDetailId2 (2011). Product groups are hierarchical: the parent of a detail (ParentGroupDetailId) 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.
The rule is validated when a product is saved: if GroupDetailId3 is a detail whose parent is neither the detail selected in GroupDetailId2 nor empty, the request is rejected with 2013.

​
Fields outside the API

The marketplace columns (Trendyol, Hepsiburada, N11, …), images, variant fields, deposit information and the second and third unit fields of the product table are not managed through the API; they keep their database defaults.