025160 Evri Windsor Framework changes

1.      Overview

 

KCSL have enhanced the Evri/Hermes v3 integration to include changes for the Windsor Framework.


2.      Specification

The Windsor implementation needs the following fields.

(There must be a single line provided per SKU item for shipments to Northern Ireland.)

 

Data Requirements – B2C

It is a requirement that the following API fields are populated as described in the request parameters section of this specification:

- Parcel Entity – Description (*Already populated based on an option but would need to be supplied always)

- Parcel Entity – Value (*Already populated as item total)

- Parcel Entity – Weight (*Already populated)

- Parcel Entity - numberOfItems (*Currently only populated when HS_OPT_REQUIRE_CONTENTS is enabled)

- Contents Entity – skuDescription (Already populated)

- Contents Entity – itemQuantity (Already populated)

 

Data Requirements – C2C (Don't think we do Customer to customer?)

It is a requirement that the following fields are populated as described in the request parameters section of this specification:

- Parcel Entity – Description (*Already populated based on an option but would need to be supplied always)

- Parcel Entity – numberOfItems (*Currently only populated when HS_OPT_REQUIRE_CONTENTS is enabled)

- SenderAddress Entity – addressLine1, addressLine2, addressLine3, addressLine4 (Already sent based on options HS_OPT_SENDER_ADDR1 HS_OPT_SENDER_ADDR2 HS_OPT_SENDER_ADDR3 HS_OPT_SENDER_ADDR4 HS_OPT_SENDER_ADDR5)


3.      Configuration

An update and a changelog will be applied as part of this development. The additional configuration step is as follows.

 

[ System Data | Couriers | Right Click – Configuration ].



Having this option enabled will ensure that the following fields are always included and populated within the file exported to the courier, if the destination is to Northern Ireland.

 

Parcel section :  Description         (‘Courier configuration | Goods description’ field).

Parcel section :  Value                    (Parcel Total Value).

Parcel section :  Weight                 (Parcel Total Weight).

Parcel section :  numberOfItems                (Total number of Items in the parcel).

Contents section : skuDescription             (The stock items ‘Description’ field).

Contents section : itemQuantity                (The quantity for the stock item in the parcel).

 

In addition the courier configuration for the ‘Sender Address’ fields need to be populated.

 

An example of the export to courier file is.

<parcel>

                                <weight>600</weight>

                                <length>0</length

                                <width>0</width>

                                <depth>0</depth>

                                <girth>0</girth>

                                <combinedDimension>0</combinedDimension>

                                <volume>0</volume>

                                <currency>GBP</currency>

                                <value>1667</value>

                                <numberOfItems>1</numberOfItems>

                                <description>Test Item</description>

                                <originOfParcel>GB</originOfParcel>

                                <dutyPaid>P</dutyPaid>

                                <contents>

                                                <content>

                                                                <skuCode>Test001</skuCode>

                                                                <skuDescription>Test Item 001</skuDescription>

                                                                <hsCode>52093900</hsCode>

                                                                <value>1667</value>

                                                                <countryOfManufacture>US</countryOfManufacture>

                                                                <itemWeight>600</itemWeight>

                                                                <itemQuantity>1</itemQuantity>

                                                </content>

                                </contents>

                                <dutyPaidValue>1667</dutyPaidValue>

                                <vatValue>333</vatValue>

                </parcel>



4.      Usage

After applying the above Configuration, typical steps for usage would include the following.

 

When an order is assigned to a Hermes v3 courier with the new ‘Enable Windsor Framework’ enabled to an address in Northern Ireland, then the required information will be included.

Did you find this article helpful?