Page Comparison

Source Ref

String

Unique Booking Reference from the client’s source system

If the External Matching Ref (below) is NOT present, ‘Source Ref’ is the matching key for the Booking.

As per the current Voyager system, if there is already a Booking in the system with this same Source Ref value that is NOT already Cancelled, this message will be treated as an Update (plus see Enrichment for the ‘Booking Change’ section below)

Otherwise this API message will be treated as a NEW Booking.

Mandatory

Source Ref is missing

External Matching Ref

String

Another unique Booking Reference from the client’s source system which they use for their external matching & external communications (if different from their source ref). This is here to support existing bookings being received from other clients.

If present, ‘External Matching Ref’ is assumed to be the matching key for this Booking (to support current implementations).

As per the current Voyager system, if this value is populated and if there is already a Booking in the system with this same External Matching Ref value that is NOT already Cancelled, this message will be treated as an Update (plus see Enrichment for the ‘Booking Change’ section below)

Otherwise this API message will be treated as a NEW Booking.

Optional

Booking Reason

Enumeration

ASN, GOODS TRANSFER, SALES ORDER

The reason for the booking:

ASN: notify SEKO of inbound goods into SEKO’s warehouse but the client will arrange transport

GOODS TRANSFER: booking for SEKO to arrange transport of goods from client premises (e.g. the factory) to a SEKO warehouse. Could also be used to book transfer of goods from any type of location to any other type of location that is not in relation to a Sales Order.

SALES ORDER: booking for SEKO to fulfil a client’s Sales Order by collecting goods from a location (typically SEKO’s own warehouse) and deliver to the client’s end customer’s site, and possibly to install & quality-check via our White Glove partner services

Must be one of the enumerated values¹

Mandatory²

¹Unrecognised Booking Reason

²Booking Reason is missing

Order Type (WG-385)

String

Describes the type of sales order, maintenance, repair, installation etc

Mandatory

Delivery Type (WG-385)

String

Describes the delivery, eg. delivery to customer, customer picks up etc.

Optional

Allocate Goods From Ref

String

The Source Booking Reference of a separate ASN or GOODS TRANSFER booking, which is intended by the Client to supply the necessary Goods to fulfil this SALES ORDER booking

Optional, but must only be present if Booking Reason = SALES ORDER.

Allocate Goods From Ref is present but this is not a SALES ORDER booking

Is Return

Boolean

If TRUE, the goods need to be moved because they are being returned by the end customer

Optional, but must only be present if Booking Reason = GOODS TRANSFER

Is Return is present but this is not a GOODS TRANSFER booking

Incoterms

Enumeration

EXW, FCA, CPT, CIP, DPU, DAP, DDP, FAS, FOB, CFR, CIF

The client may wish to inform us of the required Incoterms (i.e. the split of costs between Consignor and Consignee for the movement of goods)

Optional

Must be one of the enumerated values

Unrecognised Incoterms

Incoterms Location

String

The client may wish to inform us of the relevant location for which the Incoterms are assumed to apply e.g. the name of the origin or destination port

Optional

Source Creation Time

Date-Time

The timestamp at which the booking had been created in the client’s source system

Optional

DescriptionSKU

String

Free-format description of SKU code for this item of Goods

Must be present if SKU is not present

Both Goods SKU and Goods Description are missing

SKUMandatory

Goods SKU code is missing

Description

String

SKU code Description for this item of Goods

Must be present if Description is not presentOptional

Sales Order Line ID

String

Line ID from the Sales Order that corresponds to this item of Goods

Optional, only applicable for Booking Reason = SALES ORDER

Sales Order Line ID is present but this is not a SALES ORDER booking

Quantity

Quantity Type

Quantity measure for this Goods item, which can be expressed in various ways, see below

Mandatory, but see below for more details

(see below)

Condition

Enumeration

NEW, USED, DAMAGED

The condition of the goods, see enumerated values

Optional, only applicable for Booking Reason = GOODS TRANSFER¹

Must be one of the enumerated values²

¹Goods Condition is present but this is not a GOODS TRANSFER

²Unrecognised Goods Condition

DescriptionSKU

String

Free-format description of SKU code for this item of Child Goods

Must be present if (child) SKU is not present

Child Goods

Mandatory

Goods SKU is missing in Child GoodsSKU

Description

String

SKU code for Free-format description of this item of Child Goods

Must be present if (child) Description is not presentOptional

Quantity

Quantity Type

Quantity measure for this Child Goods item, which can be expressed in various ways, see Quantity Type definition for main Goods above

Mandatory, but see above for more details

(see above Quantity Type validation, but messages when validation fails prefixed by “Child “)

Lists the mode of transport of the goods and container mode and provides extra information about how the goods will be (or should be) transported

This entire section is optional but MUST be specified if Booking Reason = ASN

Booking Reason is ASN but no Transit details section has been specified

Location Code

String

External (client-side) code for the Location, if required

WG-106 Validation of codes:

For Location Type in (“warehouse,factory”)

Location code must be supplied.

Otherwise:

Optional, but must be present if no Location Name provided

WG-106 Validation of codes:

For Location Type in (“warehouse,factory”)

Location code must be supplied and exist in White Glove.

Otherwise:

Missing <Collection / Delivery> Location Code and Location Name

Location Name

String

Name of the location e.g. site name, factory name, warehouse name etc

Optional, but must be present if no Location Code provided

Address Line 1

String

Line 1 of the location address

Optional, but must be present if no Location Code provided

Missing <Collection / Delivery> Location Address Line 1 and no Location Code

Address Line 2

String

Line 2 of the location address

Optional

City

String

Location’s City

Optional, but must be present if no Location Code provided

Missing <Collection / Delivery> Location City and no Location Code

Region

String

Location’s Region or County

Optional

Postcode / ZIP

String

Postcode or ZIP code

Optional, but must be present if no Location Code provided

Missing <Collection / Delivery> Postcode/ZIP Code and no Location Code

Country Code

String

2-letter Country ISO Code

Optional, but must be present if no Location Code provided¹

Must be a valid 2-letter Country ISO Code²

¹Missing <Collection / Delivery> Location Country and no Location Code

²<Collection / Delivery> Location Country is not a valid ISO Code

Location Code

String

External (client-side) code for the Location, if required

WG-106 Validation of codes:

For Location Type in (“warehouse”)

Location code must be supplied.

Otherwise:

Optional, but must be present if no Location Name provided

WG-106 Validation of codes:

For Location Type in (“warehouse”)

Location code must be supplied and exist in White Glove.

Otherwise:

Missing <Collection / Delivery> Location Code and Location Name

Location Name

String

Name of the location e.g. site name, factory name, warehouse name etc

Optional, but must be present if no Location Code provided