Description

As soon as a dispatch is confirmed by the DC on SupplyStream, this method will push the dispatch information to the Hub.

API

FTP

Manual

XML

x

x

JSON

x

CSV

x

Dispatch

Field

Description

Data Type

MessageGroupId

Placeholder

nvarchar(100)

MessagePart

This is the message part of the total number of messages. API only.

int

MessageTotal

This is the total number of messages. Each dispatch is a separate part. API only.

int

IntegrationId

This is determined by SupplyStream and is the client unique identifier. This will be a consistent unique value per client. Example: CCIND

nvarchar(100)

SequenceNumber

This is determined by SupplyStream . Every push message will increment by 1 for each service selected

int

ToBePackedDate

Date the sales order reached the status of 'To be Packed'. Example: 2016-07-07T16:15:38Z

datetime

ToDispatchDate

Date the sales order reached the status of 'To Dispatch'. Example: 2016-07-07T16:15:50Z

datetime

DispatchDate

Date the sales order was systematically dispatched from SupplyStream . Example: 2016-07-07T16:16:01Z

datetime

TrackingUrl

The courier specific URL for tracking the dispatch.

nvarchar(4000)

DispatchId

SupplyStream internal value. Example: 2dfd50ff-eb0c-4eff-bd10-5814d0b0b9f9

nvarchar(100)

CourierService

The courier service the sales order was dispatched on as text i.e. Next Day

nvarchar(50)

Weight

The weight of the dispatched goods. Example: 4.25

decimal(18, 4)

WeightUOM

The WeightUOM of the dispatched goods. This is either KG of LB.

nvarchar(2)

ShipToAttention

Delivery address contacts name

nvarchar(200)

DeliveryAddressLine1

Delivery address Line 1

nvarchar(100)

InterfaceRecordId

This is the SupplyStream Globally Unique Identifier. If the GUID is not provided in the Load message, this will be automatically generated by the system. System generated example: a99645dc-5b45-4917-890c-4b02c68ac342.

varchar(100)

DeliveryAddressLine2

Delivery address Line 2

nvarchar(100)

DeliveryAddressLine3

Delivery address Line 3

nvarchar(100)

DeliveryAddressCity

Delivery address city

nvarchar(50)

DeliveryAddressCounty

Delivery address county

nvarchar(50)

DeliveryAddressPostCode

Delivery address postcode

nvarchar(20)

DeliveryAddressCountry

Delivery address country in ISO-2

nvarchar(2)

DeliveryPhoneNumber

Delivery address contacts phone number

nvarchar(20)

DeliveryEmailAddress

Delivery contacts email address

nvarchar(150)

SalesInvoiceNumber

Sales Invoice Number entered on order creation

nvarchar(100)

TrackingUrlReturn

Placeholder

nvarchar(200)

SalesOrderNumber

Sales Order Number entered on order creation

nvarchar(50)

SalesOrderReference

Sales Order reference entered on order creation

nvarchar(50)

DispatchNumber

Client specific counter for sales orders. This is the 'Dispatch No' shown in SupplyStream

nvarchar(100)

CourierName

Name of the courier the sales order was dispatched with.

In the case of DC cancellations, the CourierName field to show: "Cancelled".

nvarchar(100)

CourierRef

Reference code/tracking number as supplied by the courier service

nvarchar(50)

DCCode

SEKO created code that uniquely identifies the DC from other SEKO DC's. This code is supplied by SEKO.

nvarchar(100)

BeingPickedDate

Date the sales order reached the status of 'Being picked'. Example: 2016-07-07T16:15:35Z

datetime

DispatchLineItem

Field

Description

Data Type

LineInterfaceRecordId

SupplyStream internal value. Example: 31dcea54-d4c9-42a7-bed9-6fe22d1f7a41

varchar(100)

LineNumber

Integer that identifies a line of a sales order

int

ProductCode

The SKU that has been systematically dispatched

nvarchar(100)

EAN

The SKU that has been systematically dispatched

nvarchar(50)

Quantity

The quantity that has been systematically dispatched. A line can have a dispatch quantity of 0. 

int

LotNumber

The lot number of the SKU that has been systematically dispatched

nvarchar(100)

SerialNumber

Example SerialNumber: SN001. The same product code may be split over multiple lines if there are multiple SerialNumbers for that ProductCode within the Dispatch

nvarchar(100)

RetailComplianceLabel

Example RetailComplianceLabel: 00008432690000120391. The same product code may be split over multiple lines if there are multiple RetailComplianceLabels for that ProductCode within the Dispatch. Currently does not support LotNo or Serial Numbers.

nvarchar(100)

OrderLineMessage

This field returns the OrderLineMessage provided in the Load Sales Orders or Load Web Sales Orders service.

nvarchar(100)