Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Type

Description

Validation

Default / Enrichment

Source Ref

String

Unique Booking Reference from the client’s source system

Mandatory.

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

If the Booking Change section is NOT present (see below), and 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 is an error “An active Booking already exists with Source Reference <…>”. message should 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 with SEKO.

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)

Optional

If present, ‘External Matching Ref’ is assumed to be the matching key for the Booking.

If the Booking Change section is NOT present (see below), and there is already a Booking As per the current Voyager system, if there is already a Booking in the system with this same External Matching Ref value that is NOT already Cancelled, this is an error “An active Booking already exists with External Matching Reference <…>”. message should 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 with SEKO.

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 booking

Optional, and must only be present if Booking Reason = SALES ORDER. It must also refer to a valid Source Ref for a Booking with Booking Reason = ASN or GOODS TRANSFER

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

Mandatory

Is Return

Boolean

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

Optional

Must only be present if Booking Reason = GOODS TRANSFER

FALSE

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

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

...

Booking Change Section

Description

Validation

Enrichment

This section contains information about any amendments or cancellation for a previously-sent Booking, that the Client wants to send to SEKO

If the External Matching Ref (below) is NOT present in the main booking header, Source Ref is the matching key for the Booking. Otherwise External Matching Ref is the matching key. (see main booking header section above)

If this section is present, the matching key value of this Booking must match the corresponding value in a previously-sent Booking which has not already been cancelled. If this condition is not met, it will flag the error condition "Previous Booking not found or already Cancelled" and no changes will be made and no new Booking will be created. If this condition is met, all changes contents in this API message will be applied / overwritten to that earlier booking instance.

Field

Type

If this section is missing, but there is already a Booking in the system with this same matching key value that is NOT already Cancelled, then it is being treated as a change (see main Header section).

If this situation occurs, see below for default/ enrichment of the Booking Change details

Field

Type

Description

Validation

Default / Enrichment

Reason

Enumeration

CANCELLED BY END CUSTOMER

CANCELLED BY CLIENT

AMENDMENT

Reason for the change

Mandatory if this section is present

If a booking update has occurred (see above) but this section was missing, introduce this section and populate this field with AMENDMENT

Additional Info

String

Any other free-form text information about change that SEKO needs to know about

Optional