Order

Zynk will import order 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

• Import Orders

Example

<?xml version="1.0" encoding="utf-8"?>
<Orders
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Order>
        <ExternalID>5</ExternalID>
        <OrderNumber>1000000005</OrderNumber>
        <ExternalOrderReference>5</ExternalOrderReference>
        <CompanyName>Zynk Software Ltd</CompanyName>
        <FirstName>Joseph</FirstName>
        <LastName>Harrison</LastName>
        <Address1>6 Charlotte Square</Address1>
        <Town>Newcastle</Town>
        <County>Tyne and Wear</County>
        <Postcode>NE1 4XF</Postcode>
        <Country>GB</Country>
        <Email>[email protected]</Email>
        <Phone>0191 820 1484</Phone>
        <CourierService>Customer Collection</CourierService>
        <Channel>Magento</Channel>
        <Currency>GBP</Currency>
        <DeliveryDate>2023-01-20</DeliveryDate>
        <RequiredDeliveryDate>2023-01-20</RequiredDeliveryDate>
        <Comments>This is an example order for Zynk Software Ltd.</Comments>
        <DeliveryNotes>Leave by the back door.</DeliveryNotes>
        <GiftMessages>Merry Christmas!</GiftMessages>
        <OrderValue>200</OrderValue>
        <TotalVAT>40</TotalVAT>
        <ShippingTotalExcludingVAT>16.66</ShippingTotalExcludingVAT>
        <ShippingTotalVAT>3.32</ShippingTotalVAT>
        <MatchClientOn>Name</MatchClientOn>
        <Client>
            <Name>Hikari</Name>
        </Client>
        <MatchWarehouseOn>Name</MatchWarehouseOn>
        <Warehouse>
            <Name>Site 1</Name>
        </Warehouse>
        <Items>
            <Item>
                <SKU>10006 00 06 00060</SKU>
                <QuantityOrdered>1</QuantityOrdered>
                <Details>An example item.</Details>
                <UnitPrice>100</UnitPrice>
                <UnitPriceVAT>20</UnitPriceVAT>
                <MatchWarehouseOn>Name</MatchWarehouseOn>
                <Warehouse>
                    <Name>Site 2</Name>
                </Warehouse>
            </Item>
            <Item>
                <SKU>10006 00 06 00060</SKU>
                <QuantityOrdered>1</QuantityOrdered>
                <Details>An example item.</Details>
                <UnitPrice>100</UnitPrice>
                <UnitPriceVAT>20</UnitPriceVAT>
                <MatchWarehouseOn>Name</MatchWarehouseOn>
                <Warehouse>
                    <Name>Site 2</Name>
                </Warehouse>
            </Item>
        </Items>
    </Order>
</Orders>

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>

OrderNumber

Required
The number to represent the Mintsoft order.

Type	Example	XML
string	5	<OrderNumber>1000000005</OrderNumber>

ExternalOrderReference

Optional
The identifier to represent the order from the external. It's likely this will be the same value as your , if provided.

Type	Example	XML
string	1000000005	<ExternalOrderReference>5</ExternalOrderReference>

Title

Optional
The title of the contact on the delivery address.

Type	Example	XML
string	Mr	<Title>Mr</Title>

FirstName

Optional The forename of the contact on the delivery address.

Type	Example	XML
string	Joseph	<FirstName>Joseph</FirstName>

LastName

Optional
The surname of the contact on the delivery address.

Type	Example	XML
string	Harrison	<LastName>Harrison</LastName>

Address1

Optional
The first line of the contact's delivery address.

Type	Example	XML
string	6 Charlotte Square	<Address1>6 Charlotte Square</Address1>

Address2

Optional
The second line of the contact's delivery address.

Type	Example	XML
string	Example Line 2	<Address2>Example Line 2</Address2>

Address3

Optional
The third line of the contact's delivery address.

Type	Example	XML
string	Example Line 3	<Address3>Example Line 3</Address3>

Town

Optional
The city or town on the contact's delivery address.

Type	Example	XML
string	Newcastle	<Town>Newcastle</Town>

County

Optional
The state or region on the contact's delivery address.

Type	Example	XML
string	Tyne and Wear	<County>Tyne and Wear</County>

Postcode

Optional
The zip code on the contact's delivery address.

Type	Example	XML
string	NE1 4XF	<Postcode>NE1 4XF</Postcode>

Country

Optional
The country code for the contact's delivery address.

Type	Example	XML
string	GB	<Country>GB</Country>

Email

Optional
The contact's email address.

Type	Example	XML
string	GB	<Email>[email protected]</Email>

Phone

Optional
The contact's telephone number.

Type	Example	XML
string	0191 820 1484	<Phone>0191 820 1484</Phone>

Mobile

Optional
The contact's mobile number.

Type	Example	XML
string	0773 862 6087	<Mobile>0773 862 6087</Mobile>

DeliveryDate

Optional
The date on which the order was delivered.

Type	Example	XML
datetime	2023-01-20	<DeliveryDate>2023-01-20</DeliveryDate>

RequiredDeliveryDate

Optional
The date on which the order was initially required to be delivered.

Type	Example	XML
datetime	2023-01-20	<RequiredDeliveryDate>2023-01-20</RequiredDeliveryDate>

DespatchDate

Optional
The date on which the order was despatched.

Type	Example	XML
datetime	2023-01-20	<DespatchDate>2023-01-20</DespatchDate>

RequiredDespatchDate

Optional
The date on which the order was initially required to be despatched.

Type	Example	XML
datetime	2023-01-20	<RequiredDespatchDate>2023-01-20</RequiredDespatchDate>

Currency

Optional
The order's currency.

Type	Example	XML
string	GBP	<Currency>GBP</Currency>

This must the code for a currency that is configured in Mintsoft.

Comments

Optional
The field for any comments the customer contact has in relation to their order.

Type	Example	XML
string	This is an example order for Zynk Software Ltd.	<Comments>This is an example order for Zynk Software Ltd.</Comments>

DeliveryNotes

Optional
The field for any notes the customer contact has for the courier.

Type	Example	XML
string	Leave by the back door.	<DeliveryNotes>Leave by the back door.</DeliveryNotes>

GiftMessages

Optional
The field for any notes the customer contact has for the courier.

Type	Example	XML
string	Merry Christmas!	<GiftMessages>Merry Christmas!</GiftMessages>

VATNumber

Optional If the customer has a VAT number, it would be set in this field.

Type	Example	XML
string	GB123456789	<VATNumber>GB123456789</VATNumber>

EORINumber

Optional
If the customer has an EORI number, it would be set in this field.

Type	Example	XML
string	GB205672212000	<EORINumber>GB205672212000</EORINumber>

PIDNumber

Optional
If the customer has an PID number, it would be set in this field.

Type	Example	XML
string	SW2M2 567	<PIDNumber>SW2M2 567</PIDNumber>

IOSSNumber

Optional
If the customer has an IOSS number, it would be set in this field.

Type	Example	XML
string	IM0123456789	<IOSSNumber>IM0123456789</IOSSNumber>

OrderValue

Optional
The total net value of the customer contact's order.

Type	Example	XML
double	259.98	<OrderValue>200</OrderValue>

TotalVAT

Optional
The total tax value of the customer contact's order.

Type	Example	XML
double	0	<TotalVAT>40</TotalVAT>

Courier Service

Optional
The name of the courier service selected for the customer contact's order.

Type	Example	XML
string	Customer Collection	<CourierService>Customer Collection</CourierService>

This must match a courier serivce name from Mintsoft.

ShippingTotalExcludingVAT

Optional
The total net value of the customer contact's shipping costs.

Type	Example	XML
double	16.66	<ShippingTotalExcludingVAT>16.66</ShippingTotalExcludingVAT>

ShippingTotalVAT

Optional
The total tax value of the customer contact's shipping costs.

Type	Example	XML
double	3.32	<ShippingTotalVAT>3.32</ShippingTotalVAT>

DiscountTotalExcludingVAT

Optional
The total net value of the customer contact's order discounts.

Type	Example	XML
double	0	<DiscountTotalExcludingVAT>0</DiscountTotalExcludingVAT>

DiscountTotalVAT

Optional
The total tax value of the customer contact's order discounts.

Type	Example	XML
double	0	<DiscountTotalVAT>0</DiscountTotalVAT>

NumberOfParcels

Optional
The number of parcels expected with the order.

Type	Example	XML
int	2	<NumberOfParcels>2</NumberOfParcels>

Channel

Optional
The origin of the customer contact's order.

Type	Example	XML
string	Magento	<Channel>Magento</Channel>

This must match a channel name from Mintsoft.

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.

<ClientID>1</ClientID>

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.

<MatchClientOn>Code</MatchClientOn>
<Client>
    <Code>CLIE0001</Code>
</Client>

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.

<MatchClientOn>Name</MatchClientOn>
<Client>
    <Name>Client Example 1</Name>
</Client>

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.

<MatchClientOn>ShortName</MatchClientOn>
<Client>
    <ShortName>Client 1</ShortName>
</Client>

This must match a client short name from Mintsoft.

Warehouse

MatchWarehouseOn

Optional

You can match the warehouse to the record using one of the following options:

• ID Default When this option is given, you must provide the warehouse ID value at the header level.
• Code When this option is given, you must provide the code value at the <Warehouse> level.
• Name When this option is given, you must provide the name value at the <Warehouse> level.

Please note, when a value is not provided, the matching logic defaults to ID and the task will expect a WarehouseID to be provided at the header level.

WarehouseID

Optional
When the MatchWarehouseOn is set to ID or is not provided, use this field to set the warehouse ID.

<WarehouseID>3</WarehouseID>

This must match a warehouse ID from Mintsoft.

Warehouse → Code

Optional
When the MatchWarehouseOn is set to Code, use this field to set the warehouse code.

<MatchWarehouseOn>Warehouse</MatchWarehouseOn>
<Warehouse>
    <Code>WARE0001</Code>
</Warehouse>

This must match a warehouse code from Mintsoft.

Warehouse → Name

Optional
When the MatchWarehouseOn is set to Name, use this field to set the warehouse name.

<MatchWarehouseOn>Name</MatchWarehouseOn>
<Warehouse>
    <Name>Warehouse Example 1</Name>
</Warehouse>

This must match a warehouse name from Mintsoft.

Items

ProductID

Optional
You can optionally provide the related product ID. This will link the item to a corresponding product in Mintsoft.

Please note, that for each item either a ProductID or SKU value must be provided.

Type	Example	XML
long	1	<ProductID>1</ProductID>

The given value must match a product ID from Mintsoft.

SKU

Optional
You can optionally provide the related product SKU. This will link the item to a corresponding product in Mintsoft.

Please note, that for each item either a ProductID or SKU value must be provided.

Type	Example	XML
string	10006 00 06 00060	<SKU>10006 00 06 00060</SKU>

The given value must match a product SKU from Mintsoft.

QuantityOrdered

Required
The quantity ordered the customer contact has ordered for this item

Type	Example	XML
int	1	<QuantityOrdered>1</QuantityOrdered>

Details

Optional
This field can be used to provide a description of the product or service that has been ordered.

Type	Example	XML
string	An example item.	<Details>An example item.</Details>

UnitPrice

Required
The selling price for a single unit of the ordered product.

Type	Example	XML
double	100	<UnitPrice>100</UnitPrice>

UnitPriceVAT

Optional
The VAT amount for a single unit of the ordered product.

Type	Example	XML
double	100	<UnitPriceVAT>20</UnitPriceVAT>

Discount

Optional
The discount amount for the line item.

Type	Example	XML
double	0	<Discount>0</Discount>

Warehouse

Optional
You can optionally provide a warehouse for each line item.

Please note, for items that are not assigne their own warehouse, the warehouse from the order level will be applied.

The warehouse at the item level uses the same logic and data format as the warehouse at the order level.