Product
Zynk will import product data into Mintsoft based on the settings provided at the task level and the data provided in your input file.
To configure the import data to meet your specific requirements, you can use the step-by-step guide for the available fields below.
Tasks
Example
<?xml version="1.0" encoding="utf-8"?>
<Products
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Product>
<ExternalID>TEST0001</ExternalID>
<ID>1</ID>
<SKU>TEST0001</SKU>
<Name>Test Product</Name>
<PalletSizes>Standard</PalletSizes>
<PackingInstructions>Do not stack</PackingInstructions>
<Description>A test product</Description>
<CustomsDescription>A test product</CustomsDescription>
<CountryOfManufactureId>12</CountryOfManufactureId>
<CountryOfManufacture>
<Name>Great Britain</Name>
<Code>GB</Code>
<Code3>GBR</Code3>
</CountryOfManufacture>
<EAN>19012315532</EAN>
<UPC>19012315532</UPC>
<LowStockAlertLevel>10</LowStockAlertLevel>
<Weight>2.5</Weight>
<Height>2.5</Height>
<Width>2.5</Width>
<Depth>2.5</Depth>
<Volume>15.6</Volume>
<BackOrder>false</BackOrder>
<Bundle>false</Bundle>
<DisCont>false</DisCont>
<Price>10.99</Price>
<CostPrice>5.75</CostPrice>
<VatExempt>false</VatExempt>
<AdditionalParcelsRequired>0</AdditionalParcelsRequired>
<UnitsPerParcel>1</UnitsPerParcel>
<HasBatchNumber>false</HasBatchNumber>
<LogBatchInbound>false</LogBatchInbound>
<LogBatchOutbound>false</LogBatchOutbound>
<HasSerialNumber>false</HasSerialNumber>
<LogSerialInbound>false</LogSerialInbound>
<LogSerialOutbound>false</LogSerialOutbound>
<HasExpiryDate>false</HasExpiryDate>
<LogExpiryDateInbound>false</LogExpiryDateInbound>
<LogExpiryDateOutbound>false</LogExpiryDateOutbound>
<BestBeforeDateWarningPeriodDays>14</BestBeforeDateWarningPeriodDays>
<CommodityCode>
<Code>C00102315</Code>
</CommodityCode>
<HandlingTime>5</HandlingTime>
<UnNumber>TEST0001</UnNumber>
<ImageURL>example.com/test0001.jpg</ImageURL>
<Subscription>false</Subscription>
<SubscriptionLength>12</SubscriptionLength>
<SubscriptionFrequency>Annual</SubscriptionFrequency>
<MatchClientOn>Name</MatchClientOn>
<Client>
<Name>Hikari</Name>
</Client>
<ProductHazardousGoods>
<HazardousUnNumber>00102315</HazardousUnNumber>
<HazardousUnNumberPrefixed>H00102315</HazardousUnNumberPrefixed>
<HazardousClass>Corrosive</HazardousClass>
<HazardousProperShippingName>Hydrochloric Acid</HazardousProperShippingName>
<HazardousPackingCode>HCA</HazardousPackingCode>
<HazardousTunnelCode>HCA</HazardousTunnelCode>
<HazardousLimitedQuantity>5</HazardousLimitedQuantity>
<HazardousFullProperShippingCode>H00102315</HazardousFullProperShippingCode>
<HazardousContentId>HCA</HazardousContentId>
<HazardousNotes>Acidic substance</HazardousNotes>
</ProductHazardousGoods>
<ProductPurchasingSettings>
<DefaultMinOrderQty>10</DefaultMinOrderQty>
<DefaultMaxOrderQty>100</DefaultMaxOrderQty>
<DefaultOrderQty>50</DefaultOrderQty>
<IncludeLinkedItems>false</IncludeLinkedItems>
<ExcludeFromForecast>false</ExcludeFromForecast>
<ForecastPeriodDays>14</ForecastPeriodDays>
<LeadTimeDays>7</LeadTimeDays>
<AvgDailyConsumption>3</AvgDailyConsumption>
</ProductPurchasingSettings>
<ExternalFulFilmentProduct>
<ExternalFulfiler>SUP001</ExternalFulfiler>
<Identifier>TEST0001</Identifier>
<AltIdentifier>TEST0001</AltIdentifier>
<CartonLabelQuantity>1</CartonLabelQuantity>
<TotalQuantity>1</TotalQuantity>
<QuantityLastUpdated>2024-09-01T00:00:00</QuantityLastUpdated>
<LastUpdated>2024-09-01T00:00:00</LastUpdated>
<LastUpdatedByUser>john.smith</LastUpdatedByUser>
</ExternalFulFilmentProduct>
<ExternalFulFilmentProductInventories>
<ExternalFulFilmentProductInventory>
<ExternalFulfilerAccountId>214</ExternalFulfilerAccountId>
<ExternalFulfiler>SUP001</ExternalFulfiler>
<TotalStock>45</TotalStock>
<OnHandStock>42</OnHandStock>
<LastUpdated>2024-09-01T00:00:00</LastUpdated>
<LastUpdatedByUser>john.smith</LastUpdatedByUser>
</ExternalFulFilmentProductInventory>
</ExternalFulFilmentProductInventories>
<ProductInCategories>
<ProductInCategory>
<ProductCategoryId>462</ProductCategoryId>
<ProductCategory>
<Name>Test Products</Name>
</ProductCategory>
</ProductInCategory>
</ProductInCategories>
<ProductPrices>
<ProductPrice>
<Price>10.99</Price>
<ProductPriceTypeId>1</ProductPriceTypeId>
<ProductPriceType>
<Name>Standard</Name>
</ProductPriceType>
<CurrencyID>1</CurrencyID>
<Currency>
<Name>Sterling</Name>
<Code>GBP</Code>
<Symbol>£</Symbol>
</Currency>
</ProductPrice>
</ProductPrices>
<ProductSuppliers>
<ProductSupplier>
<Code>ZYNK0001</Code>
<Name>Zynk Software</Name>
</ProductSupplier>
</ProductSuppliers>
</Product>
</Products>
Field List
ExternalID
Optional
This field is applied in order to uniquely identify records using the identifier from the source system.
When the record is imported successfully, Zynk will store the record in the truth table. The truth table record contains an 'Internal' and 'External' ID. The 'Internal' ID refers to the identifier assigned automatically by Mintsoft.
This field is also used in conjunction with the 'Prevent Reprocessing' task setting. If this setting is set to true and a record with the same ExternalID has been previously imported, the record will be skipped and logged to the fail file.
Type | Example | XML |
---|---|---|
string(255) | 1 | <ExternalID>1</ExternalID> |
ID
Optional
When updating an existing product, you can optionally provide the product ID.
Please note, that for each product either a ID
or SKU
value must be provided.
Type | Example | XML |
---|---|---|
long | 1 | <ID>1</ID> |
The given value must match a product ID from Mintsoft.
SKU
Optional
You can optionally provide the product SKU. If the SKU doesn't already exist in Mintsoft, a new product will be created.
Please note, that for each product either a ID
or SKU
value must be provided.
Type | Example | XML |
---|---|---|
string | TEST0001 | <SKU>TEST0001</SKU> |
Name
Optional
The name of the product.
Type | Example | XML |
---|---|---|
string | Name | <Name>Test Product</Name> |
PalletSizes
Optional
The pallet sizes of the product.
Type | Example | XML |
---|---|---|
string | Standard | <PalletSizes>Standard</PalletSizes> |
PackingInstructions
Optional
The packing instructions of the product.
Type | Example | XML |
---|---|---|
string | Do not stack | <PackingInstructions>Do not stack</PackingInstructions> |
Description
Optional
The description of the product.
Type | Example | XML |
---|---|---|
string | A test product | <Description>A test product</Description> |
CustomsDescription
Optional
The customs description of the product.
Type | Example | XML |
---|---|---|
string | A test product | <CustomsDescription>A test product</CustomsDescription> |
CountryOfManufactureId
Optional
The ID of the country of manufacture of the product.
Type | Example | XML |
---|---|---|
int | 12 | <CountryOfManufactureId>12</CountryOfManufactureId> |
CountryOfManufacture → Name
Optional
The name of the country of manufacture of the product.
Type | Example | XML |
---|---|---|
string | Great Britain | <Name>Great Britain<Name> |
CountryOfManufacture → Code
Optional
The 2 letter ISO code of the country of manufacture of the product.
Type | Example | XML |
---|---|---|
string | GB | <Code>GB</Code> |
CountryOfManufacture → Code3
Optional
The 3 letter ISO code of the country of manufacture of the product.
Type | Example | XML |
---|---|---|
string | GBR | <Code3>GBR</Code3> |
EAN
Optional
The EAN of the product.
Type | Example | XML |
---|---|---|
string | 19012315532 | <EAN>19012315532</EAN> |
UPC
Optional
The UPC of the product.
Type | Example | XML |
---|---|---|
string | 19012315532 | <UPC>19012315532</UPC> |
LowStockAlertLevel
Optional
The low stock alert level of the product.
Type | Example | XML |
---|---|---|
int | 10 | <LowStockAlertLevel>10</LowStockAlertLevel> |
Weight
Optional
The weight of the product.
Type | Example | XML |
---|---|---|
double | 2.5 | <Weight>2.5</Weight> |
Height
Optional
The height of the product.
Type | Example | XML |
---|---|---|
double | 2.5 | <Height>2.5</Height> |
Width
Optional
The width of the product.
Type | Example | XML |
---|---|---|
double | 2.5 | <Width>2.5</Width> |
Depth
Optional
The depth of the product.
Type | Example | XML |
---|---|---|
double | 2.5 | <Depth>2.5</Depth> |
Volume
Optional
The volume of the product.
Type | Example | XML |
---|---|---|
double | 15.6 | <Volume>15.6</Volume> |
BackOrder
Optional
Whether back orders are allowed for the product.
Type | Example | XML |
---|---|---|
bool | false | <BackOrder>false</BackOrder> |
Bundle
Optional
Whether the product represents a bundle.
Type | Example | XML |
---|---|---|
bool | false | <Bundle>false</Bundle> |
DisCont
Optional
Whether the product is discontinued.
Type | Example | XML |
---|---|---|
bool | false | <DisCont>false</DisCont> |
Price
Optional
The price of the product.
Type | Example | XML |
---|---|---|
decimal | 10.99 | <Price>10.99</Price> |
CostPrice
Optional
The cost price of the product.
Type | Example | XML |
---|---|---|
decimal | 5.75 | <CostPrice>5.75</CostPrice> |
VatExempt
Optional
Whether the product is VAT exempt.
Type | Example | XML |
---|---|---|
bool | false | <VatExempt>false</VatExempt> |
AdditionalParcelsRequired
Optional
The number of additional parcels required for the product.
Type | Example | XML |
---|---|---|
int | 0 | <AdditionalParcelsRequired>0</AdditionalParcelsRequired> |
UnitsPerParcel
Optional
The number of units per parcel of the product.
Type | Example | XML |
---|---|---|
int | 1 | <UnitsPerParcel>1</UnitsPerParcel> |
HasBatchNumber
Optional
Whether the product has batch numbers enabled.
Type | Example | XML |
---|---|---|
bool | false | <HasBatchNumber>false</HasBatchNumber> |
LogBatchInbound
Optional
Whether batch numbers should be logged when stock arrives.
Type | Example | XML |
---|---|---|
bool | false | <LogBatchInbound>false</LogBatchInbound> |
LogBatchOutbound
Optional
Whether batch numbers should be logged when stock leaves.
Type | Example | XML |
---|---|---|
bool | false | <LogBatchOutbound>false</LogBatchOutbound> |
HasSerialNumber
Optional
Whether the product has serial numbers enabled.
Type | Example | XML |
---|---|---|
bool | false | <HasSerialNumber>false</HasSerialNumber> |
LogSerialInbound
Optional
Whether serial numbers should be logged when stock arrives.
Type | Example | XML |
---|---|---|
bool | false | <LogSerialInbound>false</LogSerialInbound> |
LogSerialOutbound
Optional
Whether serial numbers should be logged when stock leaves.
Type | Example | XML |
---|---|---|
bool | false | <LogSerialOutbound>false</LogSerialOutbound> |
HasExpiryDate
Optional
Whether the product has expiry dates.
Type | Example | XML |
---|---|---|
bool | false | <HasExpiryDate>false</HasExpiryDate> |
LogExpiryDateInbound
Optional
Whether expiry dates should be logged when stock arrives.
Type | Example | XML |
---|---|---|
bool | false | <LogExpiryDateInbound>false</LogExpiryDateInbound> |
LogExpiryDateOutbound
Optional
Whether expiry dates should be logged when stock leaves.
Type | Example | XML |
---|---|---|
bool | false | <LogExpiryDateOutbound>false</LogExpiryDateOutbound> |
BestBeforeDateWarningPeriodDays
Optional
The number of days before the best before date that a warning should be generated.
Type | Example | XML |
---|---|---|
int | 14 | <BestBeforeDateWarningPeriodDays>14</BestBeforeDateWarningPeriodDays> |
CommodityCode → Code
Optional
The of the product.
Type | Example | XML |
---|---|---|
string | C00102315 | <Code>C00102315</Code> |
HandlingTime
Optional
The handling time of the product.
Type | Example | XML |
---|---|---|
int | 5 | <HandlingTime>5</HandlingTime> |
UnNumber
Optional
The UN number of the product.
Type | Example | XML |
---|---|---|
string | TEST0001 | <UnNumber>TEST0001</UnNumber> |
ImageURL
Optional
The image URL of the product.
Type | Example | XML |
---|---|---|
string | example.com/test0001.jpg | <ImageURL>example.com/test0001.jpg</ImageURL> |
Subscription
Optional
Whether the product represents a subscription.
Type | Example | XML |
---|---|---|
bool | false | <Subscription>false</Subscription> |
SubscriptionLength
Optional
The subscription length of the product.
Type | Example | XML |
---|---|---|
int | 12 | <SubscriptionLength>12</SubscriptionLength> |
SubscriptionFrequency
Optional
The subscription frequency of the product.
Type | Example | XML |
---|---|---|
string | Annual | <SubscriptionFrequency>Annual</SubscriptionFrequency> |
Client
MatchClientOn
Optional
You can match the client to the record using one of the following options:
- ID Default When this option is given, you must provide the client ID value at the header level.
- Code When this option is given, you must provide the code value at the
<Client>
level. - Name When this option is given, you must provide the name value at the
<Client>
level. - ShortName When this option is given, you must provide th short name value at the
<Client>
level.
Please note, when a value is not provided, the matching logic defaults to ID and the task will expect a ClientID
to be provided at the header level.
ClientID
Optional
When the MatchClientOn is set to ID
or is not provided, use this field to set the client ID.
This must match a client ID from Mintsoft.
Client → Code
Optional
When the MatchClientOn is set to Code
, use this field to set the supplier code.
This must match a client code from Mintsoft.
Client → Name
Optional
When the MatchClientOn is set to Name
, use this field to set the client name.
This must match a client name from Mintsoft.
Client → ShortName
Optional
When the MatchClientOn is set to ShortName
, use this field to set the client short name.
This must match a client short name from Mintsoft.
ProductHazardousGoods
HazardousUnNumber
Optional
The UN number of the hazardous goods.
Type | Example | XML |
---|---|---|
string | 00102315 | <HazardousUnNumber>00102315</HazardousUnNumber> |
HazardousUnNumberPrefixed
Optional
The prefixed UN number of the hazardous goods.
Type | Example | XML |
---|---|---|
string | H00102315 | <HazardousUnNumberPrefixed>H00102315</HazardousUnNumberPrefixed> |
HazardousClass
Optional
The class of the hazardous goods.
Type | Example | XML |
---|---|---|
string | Corrosive | <HazardousClass>Corrosive</HazardousClass> |
HazardousProperShippingName
Optional
The proper shipping name of the hazardous goods.
Type | Example | XML |
---|---|---|
string | Hydrochloric Acid | <HazardousProperShippingName>Hydrochloric Acid</HazardousProperShippingName> |
HazardousPackingCode
Optional
The packing code of the hazardous goods.
Type | Example | XML |
---|---|---|
string | HCA | <HazardousPackingCode>HCA</HazardousPackingCode> |
HazardousTunnelCode
Optional
The tunnel code of the hazardous goods.
Type | Example | XML |
---|---|---|
string | HCA | <HazardousTunnelCode>HCA</HazardousTunnelCode> |
HazardousLimitedQuantity
Optional
The limited quantity of the hazardous goods.
Type | Example | XML |
---|---|---|
string | 5 | <HazardousLimitedQuantity>5</HazardousLimitedQuantity> |
HazardousFullProperShippingCode
Optional
The full proper shipping code of the hazardous goods.
Type | Example | XML |
---|---|---|
string | H00102315 | <HazardousFullProperShippingCode>H00102315</HazardousFullProperShippingCode> |
HazardousContentId
Optional
The content ID of the hazardous goods.
Type | Example | XML |
---|---|---|
string | HCA | <HazardousContentId>HCA</HazardousContentId> |
HazardousNotes
Optional
The notes of the hazardous goods.
Type | Example | XML |
---|---|---|
string | HazardousNotes | <HazardousNotes>HazardousNotes</HazardousNotes> |
ProductPurchasingSettings
DefaultMinOrderQty
Optional
The default minimum order quantity of the product.
Type | Example | XML |
---|---|---|
int | 10 | <DefaultMinOrderQty>10</DefaultMinOrderQty> |
DefaultMaxOrderQty
Optional
The default maximum order quantity of the product.
Type | Example | XML |
---|---|---|
int | 100 | <DefaultMaxOrderQty>100</DefaultMaxOrderQty> |
DefaultOrderQty
Optional
The default order quantity of the product.
Type | Example | XML |
---|---|---|
int | 50 | <DefaultOrderQty>50</DefaultOrderQty> |
IncludeLinkedItems
Optional
Whether linked items should be included.
Type | Example | XML |
---|---|---|
bool | false | <IncludeLinkedItems>false</IncludeLinkedItems> |
ExcludeFromForecast
Optional
Whether the product should be excluded from forecasts.
Type | Example | XML |
---|---|---|
bool | false | <ExcludeFromForecast>false</ExcludeFromForecast> |
ForecastPeriodDays
Optional
The forecast period in days of the product.
Type | Example | XML |
---|---|---|
int | 14 | <ForecastPeriodDays>14</ForecastPeriodDays> |
LeadTimeDays
Optional
The lead time in days of the product.
Type | Example | XML |
---|---|---|
int | 7 | <LeadTimeDays>7</LeadTimeDays> |
AvgDailyConsumption
Optional
The average daily consumption of the product.
Type | Example | XML |
---|---|---|
int | 3 | <AvgDailyConsumption>3</AvgDailyConsumption> |
ExternalFulFilmentProduct
ExternalFulfiler
Optional
The fulfiler of the external fulfilment product.
Type | Example | XML |
---|---|---|
string | SUP001 | <ExternalFulfiler>SUP001</ExternalFulfiler> |
Identifier
Optional
The identifier of the external fulfilment product.
Type | Example | XML |
---|---|---|
string | TEST0001 | <Identifier>TEST0001</Identifier> |
AltIdentifier
Optional
The alternative identifier of the external fulfilment product.
Type | Example | XML |
---|---|---|
string | TEST0001 | <AltIdentifier>TEST0001</AltIdentifier> |
CartonLabelQuantity
Optional
The carton label quantity of the external fulfilment product.
Type | Example | XML |
---|---|---|
int | 1 | <CartonLabelQuantity>1</CartonLabelQuantity> |
TotalQuantity
Optional
The total quantity of the external fulfilment product.
Type | Example | XML |
---|---|---|
int | 1 | <TotalQuantity>1</TotalQuantity> |
QuantityLastUpdated
Optional
When the quantity was last updated for the external fulfilment product.
Type | Example | XML |
---|---|---|
datetime | 2024-09-01T00:00:00 | <QuantityLastUpdated>2024-09-01T00:00:00</QuantityLastUpdated> |
LastUpdated
Optional
When the external fulfilment product was last updated.
Type | Example | XML |
---|---|---|
datetime | 2024-09-01T00:00:00 | <LastUpdated>2024-09-01T00:00:00</LastUpdated> |
LastUpdatedByUser
Optional
The user who last updated the external fulfilment product.
Type | Example | XML |
---|---|---|
string | john.smith | <LastUpdatedByUser>john.smith</LastUpdatedByUser> |
ExternalFulFilmentProductInventory
ExternalFulfilerAccountId
Optional
The fulfiler account ID of the external fulfilment product inventory.
Type | Example | XML |
---|---|---|
int | 214 | <ExternalFulfilerAccountId>214</ExternalFulfilerAccountId> |
ExternalFulfiler
Optional
The fulfiler of the external fulfilment product inventory.
Type | Example | XML |
---|---|---|
string | SUP001 | <ExternalFulfiler>SUP001</ExternalFulfiler> |
TotalStock
Optional
The total stock of the external fulfilment product inventory.
Type | Example | XML |
---|---|---|
int | 45 | <TotalStock>45</TotalStock> |
OnHandStock
Optional
The on hand stock of the external fulfilment product inventory.
Type | Example | XML |
---|---|---|
int | 42 | <OnHandStock>42</OnHandStock> |
LastUpdated
Optional
When the external fulfilment product inventory was last updated.
Type | Example | XML |
---|---|---|
datetime | 2024-09-01T00:00:00 | <LastUpdated>2024-09-01T00:00:00</LastUpdated> |
LastUpdatedByUser
Optional
The user who last updated the external fulfilment product inventory.
Type | Example | XML |
---|---|---|
string | john.smith | <LastUpdatedByUser>john.smith</LastUpdatedByUser> |
ProductInCategory
ProductCategoryId
Optional
The ID of the category the product is in.
Type | Example | XML |
---|---|---|
int | 462 | <ProductCategoryId>462</ProductCategoryId> |
ProductCategory → Name
Optional
The name of the category the product is in.
Type | Example | XML |
---|---|---|
string | Test Products | <Name>Test Products</Name> |
ProductPrice
Price
Optional
The price of the product.
Type | Example | XML |
---|---|---|
double | 10.99 | <Price>10.99</Price> |
ProductPriceTypeId
Optional
The ID of the product price type.
Type | Example | XML |
---|---|---|
int | 1 | <ProductPriceTypeId>1</ProductPriceTypeId> |
ProductPriceType → Name
Optional
The name of the product price type.
Type | Example | XML |
---|---|---|
string | Standard | <Name>Standard</Name> |
CurrencyID
Optional
The ID of the currency of the product price.
Type | Example | XML |
---|---|---|
int | 1 | <CurrencyID>1</CurrencyID> |
Currency → Name
Optional
The name of the currency of the product price.
Type | Example | XML |
---|---|---|
string | Sterling | <Name>Sterling</Name> |
Currency → Code
Optional
The code of the currency of the product price.
Type | Example | XML |
---|---|---|
string | GBP | <Code>GBP</Code> |
Currency → Symbol
Optional
The symbol of the currency of the product price.
Type | Example | XML |
---|---|---|
string | £ | <Symbol>£</Symbol> |
ProductSupplier
Code
Optional
The code of the product supplier.
Type | Example | XML |
---|---|---|
string | ZYNK0001 | <Code>ZYNK0001</Code> |
Name
Optional
The name of the product supplier.
Type | Example | XML |
---|---|---|
string | Zynk Software | <Name>Zynk Software</Name> |