NatchOS Importer File Documentation

See also General Documentation

This document was generated at 2024-02-15 11:08.

BlanketOrder BlanketOrderLine Category CategoryML CategoryProduct CategoryProperty CategoryVoucher Customer CustomerCategory CustomerPhoneNumber CustomerPrice CustomerProduct CustomerSalesPerson Document DocumentLine EntityExternalData EntityFile EntityStore Person PersonPhoneNumber Product ProductML ProductMeasurement ProductOverpack ProductOverpackML ProductPropertyValue ProductRelation ProductSurcharge Property PropertyML PropertyValue PropertyValueML ShippingAddress ShippingAddressPhoneNumber Voucher VoucherML WarehouseProduct WebRoleCustomerPerson WebRolePerson

BlanketOrder

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesnvarchar150
ShippingAddressCodenvarchar150
BlanketOrderCodeYesYesnvarchar150
BlanketOrderNamenvarchar80
StartDatenvarchar10
EndDateYesnvarchar10
Miscxml4000
StoreIDsmallint
ContactPersonCodenvarchar150
ActionYeschar1
Field

Action

Allowed ValuesI U D



BlanketOrderLine

Field NameKey FieldRequiredObsoleteTypeMax. Length
BlanketOrderCodeYesYesnvarchar150
ProductCodeYesYesnvarchar150
InitialQuantityYesdecimal
RemainingQuantityYesdecimal
DeliveredQuantityYesdecimal
ToBeDeliveredQuantityYesdecimal
InvoicedQuantityYesdecimal
UnbilledQuantityYesdecimal
UnitPriceYesdecimal
OverpackCodenvarchar150
Miscxml4000
Field

OverpackCode

If `OverpackCode` is supplied, all quantities represent the number of overpacks.
Otherwise quantities represent the `SalesUnitOfMeasureCode` of the product.



Category

Field NameKey FieldRequiredObsoleteTypeMax. Length
CategoryTypeCodeYesnvarchar150
CategoryCodeYesYesnvarchar150
ParentCategoryCodeYesnvarchar150
InternalNameYesnvarchar128
InternalDescriptionnvarchar512
Levelint
OrigOrderValuenvarchar150
AutoCompleteWeightint
OnlineYesbit
Miscxml4000
ActionYeschar1
Field

CategoryTypeCode

The type of the category structure, e.g. NAVIGATION or BRAND.
Predefined by Natch as a readonly category at the root (level 0).

Field

ParentCategoryCode

The code of the parent category.
Will contain the `CategoryTypeCode` for categories at highest level or non hierarchical structure.

Field

Level

The level of the category in the tree, starting at value `1`.
If the structure is not hierarchical, use value `1`.

Field

OrigOrderValue

Defines the order in which the categories under a node are placed.
This is a text field, sorting is alphabetical.

Field

AutoCompleteWeight

The optional weight of the category to calculate the score in search results of the generic autocomplete.

Field

Action

Allowed ValuesI U D



CategoryML

Field NameKey FieldRequiredObsoleteTypeMax. Length
CategoryTypeCodeYesnvarchar150
CategoryCodeYesYesnvarchar150
CategoryNameYesnvarchar128
CategoryDescriptionnvarchar512
LCIDYesYesint
MiscMLxml4000
Synonymlistnvarchar1000
Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

Synonymlist

A list of semicolon-separated synonyms for this category, for this language.

Alternate Names
Synonyms



CategoryProduct

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesYesnvarchar150
CategoryTypeCodeYesnvarchar150
CategoryCodeYesYesnvarchar150
MiscYesxml10000
Miscellaneousjson4000
ActionYeschar1
Field

CategoryTypeCode

The type of the category structure, e.g. NAVIGATION or BRAND.

Field

Misc

Use JSON in `Miscellaneous` instead. JSON support was added in November 2022.

If you are currently not sending any data in this field, you can safely remove it.
Contact us for more information regarding this change because it might have impact on your implementation.

Field

Action

Allowed ValuesI U D



CategoryProperty

Field NameKey FieldRequiredObsoleteTypeMax. Length
CategoryCodeYesYesnvarchar150
PropertyCodeYesYesnvarchar150
IsVisibleYesbit
IsFilterYesbit
IsSearchableYesbool
OrderValueint
PropertyFilterTypeIDtinyint
Miscxml10000
ActionYeschar1
Field

IsVisible

If true, property is visible in listed properties of product for this category.

Field

IsFilter

If true, property can be used in the asset-filter when this category is selected.

Field

IsSearchable

If true, this field should be included in the search index (e.g. Full-Text Search in SQL or Azure Search).

Field

OrderValue

Sort-order of the property for a product under this category.

Field

PropertyFilterTypeID

Filter type of the property:
- `1`: Intersect --> evaluated as an `AND` operator within the property values; selecting more options within the property may reduce results
- `2`: Union --> evaluated as an `OR` operator within the property values; selecting more options within the property may increase results
- `3`: Range --> property can be filtered as a range of numerical values, defining minimum and/or maximum

Allowed Values1 2 3

Default
1

Field

Action

Allowed ValuesI U D



CategoryVoucher

Field NameKey FieldRequiredObsoleteTypeMax. Length
CategoryTypeCodeYesnvarchar150
CategoryCodeYesYesnvarchar150
VoucherCodeYesYesnvarchar150
ActionYeschar1
Field

Action

Allowed ValuesI U D



Customer

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesYesnvarchar150
NameYesnvarchar80
SearchNamenvarchar80
Name2nvarchar80
AddressLine1Yesnvarchar80
AddressLine2nvarchar80
ZipCodeYesnvarchar20
CityYesnvarchar80
TerritoryCodenvarchar150
CountyCodenvarchar150
Country_ISOYesnvarchar2
SpatialLocationnvarchar40
PhoneNoYesnvarchar50
FaxNoYesnvarchar50
OurAccountNonvarchar150
CreditLimitdecimal
CustomerPriceGroupCodenvarchar150
PaymentTermCodenvarchar150
Currency_ISOnvarchar3
CustomerDiscountCodenvarchar150
BlockedYesbit
NbrOfInvoiceCopiestinyint
BillToCustomerCodenvarchar150
PriorityLevelsmallint
PaymentMethodCodenvarchar150
ShowPricesIncVATYesbit
DepartmentCodeYesnvarchar150
VATRegistrationNonvarchar50
RequestedVATRegistrationNoYesbit
VATRegimeCodenvarchar150
LegalFormCodenvarchar150
CombineInvoicesYesbit
Emailnvarchar320
Homepagenvarchar255
PrimaryContactPersonCodenvarchar150
ResponsibilityCenterCodenvarchar150
AllowLineDiscountYesbit
PreferredBankAccountCodenvarchar150
DomiciliationNonvarchar20
SectorCodenvarchar150
VisitFrequencyCodenvarchar150
CustomerShopStatusYesnvarchar150
LCIDYesint
TemporaryCustomerCodenvarchar150
CustomerTypeIDYestinyint
Creditjson4000
MiscYesxml4000
Miscellaneousjson4000
ActionYeschar1
Field

Country_ISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.
More info at [www.iso.org](https://www.iso.org/iso-3166-country-codes.html).

Field

SpatialLocation

Coordinates in `latitude,longitude` format with `.` as decimal point, e.g. `51.09644,3.83194`
for Lochristi, Belgium.

Field

PhoneNo

Telephone numbers must be sent in a separate file.

If you are currently not sending any data in this field or are already sending a separate file, you can safely remove this field.

Field

FaxNo

Telephone numbers must be sent in a separate file.

If you are currently not sending any data in this field or are already sending a separate file, you can safely remove this field.

Field

Currency_ISO

Alphabetic ISO 4217 three-letter code, e.g. `EUR` for Euro and `GBP` for Pound Sterling.
More info at [www.iso.org](https://www.iso.org/iso-4217-currency-codes.html).

Field

ShowPricesIncVAT

Alternate Names
PricesIncVat

Field

CustomerShopStatus

Alternate Names
CustomerShopStatusCode

Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

TemporaryCustomerCode

The temporary code of the record as created by NatchOS before sending to master data.
This code must be sent back to update data accordingly.

Alternate Names
TemporaryCode

Field

CustomerTypeID

Default: `1` = Owner of the site, `2` = Normal Customer.

Field

Credit

JSON representation of the credit information.

Contains a list of `creditLimits` defined as time-based total amount and/or single basket amount:

- `limitAction` [values: `Approval` or `Block`] (required)
- `periodUnit` [`D`, `W`, `M` or `Y`], `periodCount`, `periodMaximumAmount` (optional as a set, all required if any field specified)
- `basketMaximumAmount` (optional)
- `personCode` (optional)

Optional custom data can be added as `customData` to the root or in the individual items. Example of the value:
```
{"creditLimits":[{"periodUnit": "D","periodCount": 9,"limitAction":"Approval","periodMaximumAmount": 15000.0,"basketMaximumAmount": 1000.0,"personCode": "KHIUH569","customData": null}],"customData": null}
```

Make sure the field uses the recommended text qualifier around the value and characters are escaped (i.e. double quotes must be escaped if using the default text qualifier).

Field

Misc

Use JSON in `Miscellaneous` instead. JSON support was added in March 2023.

If you are currently not sending any data in this field, you can safely remove it. Contact us for more information regarding this change because it might have impact on your implementation.

Field

Action

Allowed ValuesI U D



CustomerCategory

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesnvarchar150
CategoryCodeYesnvarchar150
Miscxml4000
ActionYeschar1
Field

Action

Allowed ValuesI U D



CustomerPhoneNumber

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesYesnvarchar150
PhoneNumberTypeIDYesYestinyint
PhoneNumberYesnvarchar50
Field

PhoneNumberTypeID

Values: `1` = phone; `2` = fax; `3` = mobile.

Allowed Values1 2 3



CustomerPrice

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesYesnvarchar150
ProductCodeYesYesnvarchar150
UnitPricedecimal
MinimumUnitsYesYesdecimal
Miscxml10000
ActionYeschar1
Field

Action

Allowed ValuesI U D



CustomerProduct

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesYesnvarchar150
ProductCodeYesYesnvarchar150
CustomerProductCodenvarchar150
OrderedYesbit
AvailableYesbit
FavoriteYesbit
AvailableTypeIDbyte
Miscxml4000
ActionYeschar1
Field

CustomerProductCode

Alternate product number by which the customer knows the product.

Field

Ordered

*Replaced by data in `DocumentLine`. NatchOS can now automatically infer this from document data. Field has been marked obsolete in November 2023.*

If you are currently not sending any data in this field, you can safely remove it.

Indicates whether the product was previously bought by the customer. Documents can also be used for this.

Field

Available

*Replaced by `AvailableTypeID`. Field has been marked obsolete in April 2020.*

If you are currently not sending any data in this field, you can safely remove it.

Indicates whether the product can be viewed/purchased by the customer.

Default
0

Field

Favorite

*Master data should not control the favorites per customer. Field has been marked obsolete in November 2023. *

The implementation takes care of storing favorites per person.

If you are currently not sending any data in this field, you can safely remove it.

Default
0

Field

AvailableTypeID

Indicates the availability of a product for the given customer.
- `0`: Not available.
- `1`: Is available.
- `3`: Exclusively available for customers with this value; implicitly not available for other customers.

Field

Action

Allowed ValuesI U D



CustomerSalesPerson

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesYesnvarchar150
PersonCodeYesYesnvarchar150
OfficeStaffYesbit
MainSalesPersonYesbit
Miscxml4000
StoreIDsmallint
ActionYeschar1
Field

OfficeStaff

Use 1 for internal/backoffice, 0 for external.

Field

MainSalesPerson

Only one person can be set as main salesperson per customer.

Field

StoreID

Required for multi-store environments.

Default
1

Field

Action

Allowed ValuesI U D



Document

Field NameKey FieldRequiredObsoleteTypeMax. Length
DocumentHeaderCodeYesYesnvarchar150
DocumentTypeIDYestinyint
AmountExcVATdecimal
AmountIncVATdecimal
SellToCustomerCodeYesnvarchar150
SellToCustomerNameYesnvarchar80
SellToCustomerName2nvarchar80
SellToCustomerEmailnvarchar320
SellToCustomerLCIDYesint
SellToCustomerAddressLine1Yesnvarchar80
SellToCustomerAddressLine2nvarchar80
SellToCustomerZipCodeYesnvarchar20
SellToCustomerCityYesnvarchar80
SellToCustomerTerritoryCodenvarchar150
SellToCustomerCountyCodenvarchar150
SellToCustomerCountryISOYesnvarchar2
SellToCustomerSpatialLocationnvarchar40
SellToCustomerContactNamenvarchar80
VATRegistrationNonvarchar50
BillToCustomerCodenvarchar150
BillToCustomerNameYesnvarchar80
BillToCustomerName2nvarchar80
BillToCustomerEmailnvarchar320
BillToCustomerLCIDYesint
BillToCustomerAddressLine1Yesnvarchar80
BillToCustomerAddressLine2nvarchar80
BillToCustomerZipCodeYesnvarchar20
BillToCustomerCityYesnvarchar80
BillToCustomerTerritoryCodenvarchar150
BillToCustomerCountyCodenvarchar150
BillToCustomerCountryISOYesnvarchar2
BillToCustomerSpatialLocationnvarchar40
BillToCustomerContactNamenvarchar80
ShippingAddressCodenvarchar150
ShippingAddressNamenvarchar80
ShippingAddressName2nvarchar80
ShippingAddressEmailnvarchar320
ShippingAddressLCIDYesint
ShippingAddressAddressLine1nvarchar80
ShippingAddressAddressLine2nvarchar80
ShippingAddressZipCodenvarchar20
ShippingAddressCitynvarchar80
ShippingAddressTerritoryCodenvarchar150
ShippingAddressCountyCodenvarchar150
ShippingAddressCountryISOnvarchar2
ShippingAddressSpatialLocationnvarchar40
ShippingAddressContactNamenvarchar80
ShippingMethodCodenvarchar150
ShippingAdviceCodenvarchar150
ExternalReferencenvarchar150
InternalCommentnvarchar500
ExternalCommentnvarchar500
DocumentDateYesnvarchar10
DocumentTimenvarchar8
PaymentTermCodenvarchar150
PaymentMethodCodenvarchar150
IncoTermnvarchar150
CurrencyFactordecimal
CurrencyISOYesnvarchar3
CreatorPersonCodenvarchar150
SalesPersonCodenvarchar150
ContactMethodCodenvarchar150
ContactMethodDocumentNonvarchar40
RequestedDeliveryDatenvarchar10
PromisedDeliveryDatenvarchar10
DepartmentCodenvarchar150
SeparateInvoiceYesbit
DocumentStatusCodenvarchar150
OpenYesbit
Miscxml4000
QuoteEndDatenvarchar10
OrderTypeIDtinyint
OrderDatenvarchar10
OrderTimenvarchar8
ShipmentDatenvarchar10
ShipmentTimenvarchar8
PaymentDiscountPercentdecimal
DueDatenvarchar10
InvoiceTypeIDtinyint
StoreIDsmallint
TrackTracejson4000
TransferTypeCodenvarchar150
TransferSubTypeCodenvarchar150
ActionYeschar1
Field

DocumentTypeID

Supported values:
- `1` = Quote
- `2` = Order
- `3` = Shipment
- `4` = Invoice

Allowed Values1 2 3 4

Field

SellToCustomerCode

Field has been marked required in January 2024.

Field

SellToCustomerLCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

SellToCustomerCountryISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.
More info at [www.iso.org](https://www.iso.org/iso-3166-country-codes.html).

Alternate Names
SellToCustomerCountryIso

Field

SellToCustomerSpatialLocation

Coordinates in `latitude,longitude` format with `.` as decimal point, e.g. `51.09644,3.83194` for Lochristi, Belgium.

Field

BillToCustomerLCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

BillToCustomerAddressLine1

Alternate Names
BillToAddressLine1

Field

BillToCustomerAddressLine2

Alternate Names
BillToAddressLine2

Field

BillToCustomerCountryISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.

Alternate Names
BillToCustomerCountryIso

Field

BillToCustomerSpatialLocation

Coordinates in `latitude,longitude` format with `.` as decimal point, e.g. `51.09644,3.83194` for Lochristi, Belgium.

Field

ShippingAddressLCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

ShippingAddressCountryISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.

Alternate Names
ShippingAddressCountryIso

Field

ShippingAddressSpatialLocation

Coordinates in `latitude,longitude` format with `.` as decimal point, e.g. `51.09644,3.83194` for Lochristi, Belgium.

Field

ShippingAdviceCode

Supported values:
- `complete` = complete order
- `completeorderlines` = complete per orderline
- `partial` = partial orderlines allowed

Field

IncoTerm

A series of three-letter trade terms Incoterms rules.
International Commercial terms are a series of pre-defined commercial terms published by the
International Chamber of Commerce widely used in international commercial transactions.

Field

CurrencyISO

Alphabetic ISO 4217 three-letter code, e.g. `EUR` for Euro and `GBP` for Pound Sterling.
More info at [www.iso.org](https://www.iso.org/iso-4217-currency-codes.html).

Field

SeparateInvoice

Alternate Names
SeperateInvoice

Field

QuoteEndDate

Required for document type quote.

Field

OrderTypeID

Required for document type order.
Supported values:
- `1` = Normal
- `2` = Return

Field

OrderDate

Required for document type order.

Field

ShipmentDate

Required for document type shipment.

Field

DueDate

Required for document type invoice.

Field

InvoiceTypeID

Required for document type invoice.
Supported values:
- `1` = Invoice
- `2` = Credit note

Allowed Values1 2

Field

StoreID

Required for multi-store environments.

Default
1

Field

TrackTrace

JSON representation of the track and trace information. Contains a list of `tracking` defined as
`trackingNumber` (required) and either `shippingAgent` or `url` for direct link. Optional custom data can be
added as `customData` to the root or in the individual tracking items. Example of the value:
```
{"tracking":[{"trackingNumber":"123456","shippingAgent":"UPS","url":"https://www.ups.com/?12345789","customData":null}],"customData":null}
```
Make sure the field uses the recommended text qualifier around the value and characters are escaped (i.e. double quotes must be escaped if using the default text qualifier).

Field

Action

Allowed ValuesI U D



DocumentLine

Field NameKey FieldRequiredObsoleteTypeMax. Length
DocumentHeaderCodeYesYesnvarchar150
DocumentTypeIDYestinyint
LineNoYesYesint
AttachedToLineNoint
LineTypeYestinyint
ProductNonvarchar80
ProductCodenvarchar150
VariantProductCodenvarchar150
CustomerProductCodenvarchar150
EANnvarchar20
MainVendorProductNonvarchar80
ProducerProductNonvarchar80
ShipmentDatenvarchar10
ShipmentTimenvarchar8
ProductNamenvarchar80
Commentnvarchar1000
UnitOfMeasureCodenvarchar150
QuantityPerUnitOfMeasuredecimal
Quantitydecimal
OutstandingQuantitydecimal
QuantityToInvoicedecimal
QuantityToShipdecimal
UnitPriceIncVATdecimal
UnitPriceExcVATdecimal
VATPercentdecimal
LineDiscountPercentdecimal
LineDiscountAmountdecimal
LineAmountExcVATdecimal
LineAmountIncVATdecimal
GrossWeightdecimal
NetWeightdecimal
WeightUnitOfMeasureCodenvarchar150
Volumedecimal
VolumeUnitOfMeasureCodenvarchar150
RequestedDeliveryDatenvarchar10
PromisedDeliveryDatenvarchar10
PlannedDeliveryDatenvarchar10
PlannedShipmentDatenvarchar10
DepartmentCodenvarchar150
Miscxml4000
DocumentStatusCodenvarchar150
TrackTracejson4000
Field

DocumentTypeID

Supported values:
- `1` = Quote
- `2` = Order
- `3` = Shipment
- `4` = Invoice

Allowed Values1 2 3 4

Field

DocumentStatusCode

Alternate Names
DocumentLineStatusCode

Field

TrackTrace

JSON representation of the track and trace information. Contains a list of `tracking` defined as
`trackingNumber` (required) and either `shippingAgent` or `url` for direct link. Optional custom data can be
added as `customData` to the root or in the individual tracking items. Example of the value:
```
{"tracking":[{"trackingNumber":"123456","shippingAgent":"UPS","url":"https://www.ups.com/?12345789","customData":null}],"customData":null}
```
Make sure the field uses the recommended text qualifier around the value and characters are escaped (i.e. double quotes must be escaped if using the default text qualifier).



EntityExternalData

Field NameKey FieldRequiredObsoleteTypeMax. Length
EntityCodeYesYesnvarchar150
ExternalSourceIDYesYesint
LCIDYesint
MiscYesxml
ActionYeschar1
Field

EntityCode

Alternate Names
CategoryCode CustomerCode DocumentHeaderCode PersonCode ProductCode WarehouseCode

Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].
Can be used to specify both a local specific record or a neutral record without LCID.
If there is no record for a specific LCID, NatchOS will fall back to the record without LCID.

Field

Action

Allowed ValuesI U D



EntityFile

Field NameKey FieldRequiredObsoleteTypeMax. Length
EntityCodeYesYesnvarchar150
FilePathYesYesnvarchar128
FileNameYesYesnvarchar1024
LCIDYesint
Miscxml4000
ActionYeschar1
Field

EntityCode

Alternate Names
CategoryCode CustomerCode DocumentHeaderCode PersonCode ProductCode WarehouseCode

Field

FilePath

This determines the file type and must be a known value within NatchOS, configured by Natch.

_Value as Path_
Must start with `\`.
The value is used to create the absolute URL from the relative URL.
Can match a container name in Azure Blob Storage or a bucket name in Amazon S3.
E.g. `\categoryimage`, `\productimage`, `\product-high-resolution`

_Value as Type_
Value does not start with `\`.
The value is only used to indicate/match a type in NathOS.
Will not be used to create the absolute URL - the `URL` field must contain absolute URL.
E.g. `ProductManualLink`.

Alternate Names
FileType

Field

FileName

**A relative or absolute `URL` to the file.**

_Relative_
A path relative to the `FilePath\FileType`.
The value will be prefixed with `Origin` and `FilePath` to construct the absolute URL.
The `Origin` itself is configured in the application.

Examples (using `\categoryimage` as `FilePath\FileType`):
- `/segment-a/x123987.jpg` > `https://natchcloud.com/categoryimage/segment-a/x123987.jpg`
- `/x123987.jpg` > `https://natchcloud.com/categoryimage/x123987.jpg`

_Absolute_
A complete URL, including the origin. The value will be used as-is.
E.g. `https://pim.natch.be/products/thumbnails/x123987.jpg`

Alternate Names
URL

Field

LCID

The optional locale identifier for the file, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

Misc

Can be used to specify the order in which images or files must be displayed.

Field

Action

Allowed ValuesI U D



EntityStore

Field NameKey FieldRequiredObsoleteTypeMax. Length
EntityCodeYesYesnvarchar150
StoreIDYesYessmallint
Product_TransportCostdecimal
Product_MinimumAmountFreeShippingdecimal
Product_TransferLeadTimeInDayssmallint
Product_PromoTypeIDtinyint
Miscellaneousjson4000
ActionYeschar1
Field

EntityCode

Alternate Names
ProductCode

Field

Product_TransportCost

The transport cost for this product.

Field

Product_PromoTypeID

Specify the ID of a promotion type as defined in the metadata.

Values supported by NatchOS:
- `1` = promotion
- `2` = liquidation
- `3` = spotlight
- `4` = bestseller

Custom types should have a value greater than 100.

Field

Action

Allowed ValuesI U D



Person

Field NameKey FieldRequiredObsoleteTypeMax. Length
CustomerCodeYesnvarchar150
ShippingAddressCodenvarchar150
PersonCodeYesYesnvarchar150
FirstNamenvarchar80
MiddleNamenvarchar80
SurNameYesnvarchar80
SearchNamenvarchar80
NickNamenvarchar80
AddressLine1nvarchar80
AddressLine2nvarchar80
ZipCodenvarchar20
Citynvarchar80
TerritoryCodenvarchar150
CountyCodenvarchar150
Country_ISOnvarchar2
SpatialLocationnvarchar40
EmailYesnvarchar320
Email2nvarchar320
Homepagenvarchar255
SalesPersonCodenvarchar150
Commentnvarchar1000
JobTitlenvarchar150
OrganizationLevelCodenvarchar150
SalutationCodenvarchar150
Initialsnvarchar50
Gendernvarchar10
Loginnvarchar320
WebRoleCodenvarchar150
LCIDYesint
TemporaryPersonCodenvarchar150
Miscxml4000
ActionYeschar1
Field

CustomerCode

The customer that the person is attached to.

This field was marked optional in December 2023.
Consider the entity `WebRoleCustomerPerson` for linking a person to a customer (which support a multi-customer setup).
If you are currently not sending any data in this field and using a separate file, you can safely remove it.

Field

AddressLine1

**Part of address field set. Required if another field in the set is supplied.**

Field

AddressLine2

**Part of address field set. Optional.**

Field

ZipCode

**Part of address field set. Required if another field in the set is supplied.**

Field

City

**Part of address field set. Required if another field in the set is supplied.**

Field

TerritoryCode

**Part of address field set. Optional.**

Field

CountyCode

**Part of address field set. Optional.**
Code for a geographical region of a country.
Not to be confused with country.

Field

Country_ISO

**Part of address field set. Required if another field in the set is supplied.**
The two-letter ALPHA-2 ISO 3166 notation of the country code.
More info at [www.iso.org](https://www.iso.org/iso-3166-country-codes.html).

Alternate Names
CountryISO

Field

SpatialLocation

Coordinates in `latitude,longitude` format with `.` as decimal point, e.g. `51.09644,3.83194` for Lochristi, Belgium.

Field

Gender

Allowed ValuesF Female M Male

Field

WebRoleCode

A single web role code.

This field was marked optional in December 2023.
Instead of a single code, we recommend the `WebRoleCustomerPerson.txt` file (previously `WebRolePerson.txt`) with support for many-to-many combinations.
If you are currently not sending any data in this field and using a separate file, you can safely remove it.

Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

TemporaryPersonCode

The temporary code of the record as created by NatchOS before sending to master data.
This code must be sent back to update data accordingly.

Alternate Names
TemporaryCode

Field

Action

Allowed ValuesI U D



PersonPhoneNumber

Field NameKey FieldRequiredObsoleteTypeMax. Length
PersonCodeYesYesnvarchar150
PhoneNumberTypeIDYesYestinyint
PhoneNumberYesnvarchar50
Field

PhoneNumberTypeID

Values: `1` = phone; `2` = fax; `3` = mobile.

Allowed Values1 2 3



Product

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesYesnvarchar150
ProductNonvarchar80
InternalNamenvarchar128
IsModelProductYesbit
BaseUnitOfMeasureCodeYesnvarchar150
ProductDiscountGroupCodenvarchar150
AllowInvoiceDiscountYesbit
UnitPricedecimal
UnitCostdecimal
SizeCodenvarchar150
SizeYesdecimal
SizeUnitOfMeasureCodeYesnvarchar150
ColorCodenvarchar150
MainVendorCodenvarchar150
MainVendorProductNonvarchar80
EANnvarchar20
ProducerProductNonvarchar80
LeadTimeCalculationsmallint
MOQdecimal
IOQdecimal
UnitListPricedecimal
GrossWeightYesdecimal
GrossWeightUnitOfMeasureCodeYesnvarchar150
NetWeightYesdecimal
NetWeightUnitOfMeasureCodeYesnvarchar150
UnitVolumeYesdecimal
UnitVolumeUnitOfMeasureCodeYesnvarchar150
Durabilitynvarchar15
TariffNonvarchar80
CountryPurchased_ISOnvarchar2
CountryOrigine_ISOnvarchar2
OnlineYesbit
VATBusinessPostingGroupCodenvarchar150
SalesUnitofMeasureCodeYesnvarchar150
PriceOnRequestYesbit
PromoTypeIDbyte
Product_TransportCostdecimal
Product_MinimumAmountFreeShippingdecimal
Product_TransferLeadTimeInDayssmallint
IsConfigurablebit
Miscxml10000
ActionYeschar1
Field

BaseUnitOfMeasureCode

Specify the code of a unit of measure as defined in the metadata.

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

SizeCode

Specify the code of a size as defined in the metadata.
I.e. sizes of a t-shirt: `XS`, `S`, `M`, `L`, `XL`.

Alternatively, a size can be specified as a measurement with a decimal value and a unit of measure.

Field

Size

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

SizeUnitOfMeasureCode

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

ColorCode

Specify the code of a color as defined in the metadata.

Field

EAN

The EAN-13 barcode digits. An EAN-13 barcode (originally European Article Number, but now
renamed International Article Number even though the abbreviation EAN has been retained) is a 13 digit
(12 data and 1 check) barcoding standard.

Field

LeadTimeCalculation

The average delivery time in days for the main vendor for this product.

Field

GrossWeight

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

GrossWeightUnitOfMeasureCode

Specify the code of a unit of measure as defined in the metadata.

Field

NetWeight

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

NetWeightUnitOfMeasureCode

Specify the code of a unit of measure as defined in the metadata.

Field

UnitVolume

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

UnitVolumeUnitOfMeasureCode

Specify the code of a unit of measure as defined in the metadata.

Field

Durability

Contains the format of an xsd duration type without the time part (max = 100 years). Fex 'P0Y3M20D' = 3 months, 20 days.

Field

TariffNo

Intrastat code of the product. Intrastat is the system for collecting information and producing statistics on the trade in goods between countries of the European Union (EU).

Field

CountryPurchased_ISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.
More info at [www.iso.org](https://www.iso.org/iso-3166-country-codes.html).

Field

CountryOrigine_ISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.
More info at [www.iso.org](https://www.iso.org/iso-3166-country-codes.html).

Field

SalesUnitofMeasureCode

This data should be sent in the `ProductMeasurement` file instead.
Contact us for more information regarding this change.

If you are currently not sending any data in this field, you can safely remove it.

Field

PromoTypeID

Specify the ID of a promotion type as defined in the metadata.

Values supported by NatchOS:
- `1` = promotion
- `2` = liquidation
- `3` = spotlight
- `4` = bestseller

Custom types should have a value greater than 100.

Field

Product_TransportCost

The transport cost for this product.

Field

Action

Allowed ValuesI U D



ProductML

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesYesnvarchar150
ProductNamenvarchar128
ProductSearchNamenvarchar128
FreightTypenvarchar1000
ProductDescriptionnvarchar4000
Commentnvarchar1000
Synonymsnvarchar1000
LCIDYesYesint
MiscMLxml10000
Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].



ProductMeasurement

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesYesnvarchar150
MeasurementTypeIDYesYestinyint
UnitOfMeasureCodeYesnvarchar150
Amountdecimal
ActionYeschar1
Field

MeasurementTypeID

Values supported by NatchOS:

- `1`: Base Unit - Unit in which the product is stored (inventory). Requires only the unit of measure.
- `2`: Size - Measurement for a generic size/dimension of the product. Requires both the unit of measure and a value.
- `3`: Gross Weight - Measurement for the gross weight of the product. Requires both the unit of measure and a value.
- `4`: Net Weight - Measurement for the net weight of the product. Requires both the unit of measure and a value.
- `5`: Sales Unit - Unit in which the product is sold. Requires only the unit of measure.
- `6`: Volume - Measurement for the volume of the product. Requires both the unit of measure and a value.
- `7`: Overpack Volume - Measurement for the volume of an overpack of the product. Requires both the unit of measure and a value.
- `8`: Overpack Weight - Measurement for the weight of an overpack of the product. Requires both the unit of measure and a value.
- `9`: Size Length - Measurement for the length of the product. Requires both the unit of measure and a value.
- `10`: Size Width - Measurement for the width of the product. Requires both the unit of measure and a value.
- `11`: Size Height - Measurement for the height of the product. Requires both the unit of measure and a value.
- `12`: Overpack Unit - Unit of one overpack. Requires only the unit of measure.
- `13`: Items per Sales Unit - Describes how many items are contained in a single sales unit. Requires both the unit of measure and a value. (I.e. Number of blisters in one package. Product is sold per package.)

Allowed Values1 2 3 4 5 6 7 8 9 10 11 12 13

Field

UnitOfMeasureCode

The code of the unit of measure.

Field

Amount

The value for the measurement. This is required for some measurement types.

Alternate Names
Value

Field

Action

Allowed ValuesI U D



ProductOverpack

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesnvarchar150
OverpackCodeYesYesnvarchar150
InternalNamenvarchar80
OverpackWeightdecimal
OverpackWeightUnitOfMeasureCodenvarchar150
OverpackVolumedecimal
OverpackVolumeUnitOfMeasureCodenvarchar150
UnitsPerPackYesdecimal
OverpackUnitUnitOfMeasureCodenvarchar150
MiscYesxml4000
Miscellaneousjson4000
ActionYeschar1
Field

UnitsPerPack

The number of unit in the overpack.

Field

OverpackUnitUnitOfMeasureCode

The unit for the `UnitsPerPack` value.

Field

Misc

Use JSON in `Miscellaneous` instead. JSON support was added in September 2023.

If you are currently not sending any data in this field, you can safely remove it. Contact us for more information regarding this change because it might have impact on your implementation.

Field

Action

Allowed ValuesI U D



ProductOverpackML

Field NameKey FieldRequiredObsoleteTypeMax. Length
OverpackCodeYesYesnvarchar150
OverpackNameYesnvarchar80
OverpackDescriptionnvarchar150
LCIDYesYesint
MiscMLYesxml4000
MiscellaneousMLjson4000
Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

MiscML

Use JSON in `MiscellaneousML` instead. JSON support was added in September 2023.

If you are currently not sending any data in this field, you can safely remove it. Contact us for more information regarding this change because it might have impact on your implementation.



ProductPropertyValue

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesYesnvarchar150
PropertyCodeYesYesnvarchar150
PropertyValueCodenvarchar150
ActionYeschar1
Field

PropertyValueCode

Alternate Names
Value1

Field

Action

Allowed ValuesI U D



ProductRelation

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCode1YesYesnvarchar150
ProductRelationTypeYesYesnvarchar50
ProductCode2YesYesnvarchar150
StartDatenvarchar10
StopDatenvarchar10
Ratiodecimal
Miscxml4000
ActionYeschar1
Field

ProductCode1

The origin product.

Field

ProductRelationType


Field

ProductCode2

The related product.

Field

StartDate

Required for time-bound relations (`TemporaryHasAlternative`). Must be empty for other relations.

Field

StopDate

Required for time-bound relations (`TemporaryHasAlternative`). Must be empty for other relations.

Field

Ratio

The optional count of related product for every origin product.
I.e. A value of `2` for a `MandatoryIncludes` relation specifies that the related product must be bought 2x for every origin product.

Field

Action

Allowed ValuesI U D



ProductSurcharge

Field NameKey FieldRequiredObsoleteTypeMax. Length
ProductCodeYesnvarchar150
ProductSurchargeTypeIDYesYessmallint
ProductSurchargeQuantitysmallint
ProductSurchargePricedecimal
Miscellaneousjson1000
ActionYeschar1
Field

ProductSurchargeTypeID

Type of surcharge. e.g. 1 is Bebat, 2 is Recupel.

Field

ProductSurchargeQuantity

Multiplier for the `ProductSurchargePrice`, e.g. four batteries per product.

Field

ProductSurchargePrice

Price for a single surcharge, e.g. for one battery.

Field

Action

Allowed ValuesI U D



Property

Field NameKey FieldRequiredObsoleteTypeMax. Length
PropertyCodeYesYesnvarchar150
InternalNameYesnvarchar128
PropertyValueTypeIDYestinyint
PropertyFilterTypeIDYestinyint
IsVisibleYesbit
IsFilterYesbit
IsSearchableYesbool
OrderValueint
PropertyClassCodenvarchar150
Miscxml10000
ActionYeschar1
Field

InternalName

Internal name of the property. Is used as display text if no translations are provided.

Field

PropertyValueTypeID

Data type of the value of the property:

- `1`: Textual value
- `2`: Numerical value, integer or decimal
- `4`: Boolean value, simple true/false

Allowed Values1 2 4

Field

PropertyFilterTypeID

Filter type of the property:

- `1`: Intersect --> evaluated as an `AND` operator within the property values; selecting more options
within the property may reduce results.
- `2`: Union --> evaluated as an `OR` operator within the property values; selecting more options within
the property may increase results.
- `3`: Range --> property can be filtered as a range of numerical values, defining minimum and/or
maximum.

Supported in our latest search engine.

Allowed Values1 2 3

Field

IsVisible

If true, property is visible in listed properties of product.

Alternate Names
ShowAsProductSpecification

Field

IsFilter

If true, property will be available as facet filter for product search.

Alternate Names
UseAsFilter

Field

IsSearchable

If true, the `TextValueML` or `TextValue` of the `PropertyValue` will be included in the search
index.

Field

OrderValue

Sort order of the property for a product.

Alternate Names
IncludeInSearchIndex

Field

PropertyClassCode

Code of the class to which the property belongs.

Example: 'Measurements'.

Field

Action

Allowed ValuesI U D



PropertyML

Field NameKey FieldRequiredObsoleteTypeMax. Length
PropertyCodeYesnvarchar150
PropertyNameYesnvarchar128
PropertyDescriptionnvarchar512
LCIDYesint
MiscMLxml10000
Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].



PropertyValue

Field NameKey FieldRequiredObsoleteTypeMax. Length
PropertyCodeYesYesnvarchar150
PropertyValueCodeYesYesnvarchar150
TextValueYesnvarchar1000
NumericValuedecimal
Miscxml10000
ActionYeschar1
Field

PropertyValueCode

Code of the property value. This should be unique across all property value records.

Field

TextValue

Display text of the property value.

For properties defined as text: This value is used if no translations are provided via `PropertyValueML`
entity.

For properties defined as numeric: This is used for display and optionally for inclusion in search index
(see property definition), e.g. '10 cm' as text value and '10' as numeric value.

For properties defined as boolean: This must contains one of the follow values: `1`, `true`, `0`,
`false`.

Field

NumericValue

Numerical value for the property.

Required if the value type of the property is numeric.

Field

Action

Allowed ValuesI U D



PropertyValueML

Field NameKey FieldRequiredObsoleteTypeMax. Length
PropertyCodeYesYesnvarchar150
PropertyValueCodeYesYesnvarchar150
LCIDYesYesint
TextValueMLnvarchar1000
MiscMLxml10000
Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].



ShippingAddress

Field NameKey FieldRequiredObsoleteTypeMax. Length
ShippingAddressCodeYesYesnvarchar150
CustomerCodeYesnvarchar150
MainShippingAddressYesbit
Namenvarchar80
SearchNamenvarchar80
Name2nvarchar80
AddressLine1Yesnvarchar80
AddressLine2nvarchar80
ZipCodeYesnvarchar20
CityYesnvarchar80
TerritoryCodenvarchar150
CountyCodenvarchar150
Country_ISOYesnvarchar2
SpatialLocationnvarchar40
PrimaryContactPersonCodenvarchar150
ShippingMethodCodenvarchar150
ShippingAgentCodenvarchar150
ShippingAgentServiceCodenvarchar150
ShippingAdviceCodenvarchar150
ShippingTimeInDaystinyint
PrintPriceOnShippingDocumentYesbit
DepartmentCodenvarchar150
PlaceOfExportnvarchar150
Emailnvarchar320
Homepagenvarchar255
CombineShippingsYesbit
LCIDYesint
TemporaryShippingAddressCodenvarchar150
Miscxml4000
ActionYeschar1
Field

Country_ISO

The two-letter ALPHA-2 ISO 3166 notation of the country code.
More info at [www.iso.org](https://www.iso.org/iso-3166-country-codes.html).

Field

SpatialLocation

Coordinates in `latitude,longitude` format with `.` as decimal point, e.g. `51.09644,3.83194` for Lochristi, Belgium.

Field

ShippingAdviceCode

Values supported by NatchOS:

- `complete` = complete order
- `completeorderlines` = complete per orderline
- `partial` = partial orderlines allowed

Field

Homepage

Alternate Names
HomePage

Field

CombineShippings

Alternate Names
CombineShipments

Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].

Field

TemporaryShippingAddressCode

The temporary code of the record as created by NatchOS before sending to master data.
This code must be sent back to update data accordingly.

Alternate Names
TemporaryCode

Field

Action

Allowed ValuesI U D



ShippingAddressPhoneNumber

Field NameKey FieldRequiredObsoleteTypeMax. Length
ShippingAddressCodeYesYesnvarchar150
PhoneNumberTypeIDYesYestinyint
PhoneNumberYesnvarchar50
Field

PhoneNumberTypeID

Values: `1` = phone; `2` = fax; `3` = mobile.

Allowed Values1 2 3



Voucher

Field NameKey FieldRequiredObsoleteTypeMax. Length
VoucherCodeYesYesnvarchar150
InternalNamenvarchar80
Descriptionnvarchar150
IdentificationYesnvarchar80
ValidFromYesnvarchar10
ValidUntilYesnvarchar10
DiscountPercentdecimal
DiscountAmountdecimal
MaxDiscountValuedecimal
MinimumValuedecimal
VoucherLimitTypeIDYestinyint
MaxAmountYesint
CombinableYesbit
Miscellaneousnvarchar4000
ActionYeschar1
Field

ValidUntil

Alternate Names
ValidUntill

Field

VoucherLimitTypeID

Defines how `MaxAmount` is applied.

- `1` = Global limit
- `2` = Per user limit

Allowed Values1 2

Field

MaxAmount

Maximum number of times a voucher can be used.

Field

Action

Allowed ValuesI U D



VoucherML

Field NameKey FieldRequiredObsoleteTypeMax. Length
VoucherCodeYesYesnvarchar150
VoucherNameYesnvarchar80
VoucherDescriptionnvarchar150
LCIDYesYesint
MiscellaneousMLnvarchar4000
Field

LCID

The locale identifier, e.g. `2067` for Dutch (Belgium) [nl-BE].



WarehouseProduct

Field NameKey FieldRequiredObsoleteTypeMax. Length
WarehouseCodeYesYesnvarchar150
ProductCodeYesYesnvarchar150
StockDateYesnvarchar10
Stockdecimal
StockIndicationnvarchar
ActionYeschar1
Field

StockDate

Can be used for expected / forecasted stock.

Field

Stock

Actual stock count; see `StockIndication` for an alternative.

Field

StockIndication

A relative stock indication, e.g. BACKORDER, LOW, MEDIUM, HIGH; see `Stock` for an alternative.

Field

Action

Allowed ValuesI U D



WebRoleCustomerPerson

Field NameKey FieldRequiredObsoleteTypeMax. Length
WebRoleCodeYesYesnvarchar150
CustomerCodeYesYesnvarchar150
PersonCodeYesYesnvarchar150
ActionYeschar1
Field

Action

Allowed ValuesI U D



WebRolePerson

Field NameKey FieldRequiredObsoleteTypeMax. Length
WebRoleCodeYesYesnvarchar150
PersonCodeYesYesnvarchar150
ActionYeschar1
Field

Action

Allowed ValuesI U D