Versions Compared

Key

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


Description

This method can be called to create new sales orders in SupplyStream. The products within the order must have sufficient available stock for the order to be created if "PushToDC" is set to true.

...

  • The Sales Order is defined by the SalesOrderNumber (Identifier)
  • If one Line Item in the sales order returns an error (for example, 'Error Submitting SalesOrder: TESTSO - Error. Product 5963405 has no free stock.'), then the entire sales order fails to upload.
  • The address is not validated on upload.
  • The sales order cannot be edited once uploaded.
  • In a CSV, if a sales order number is used, and then repeated later on in the file (separated by another sales order), these entities will be treated as separate sales orders.
  •  A single Sales Order (defined by the Sales Order number) does not accept multiple lines of the same ProductCode. 
  • Anything that comes through as a SalesOrderLineItem will need inventory and we will need to fully process as a pick.
  • Once a Sales Order is at status Dispatched, the Sales Order is closed. No further dispatches will be sent for this sales order.
  • If there is not enough or no stock for a SKU on an order, the order will be rejected. The sales order would either need to be uploaded again once the stock is present, the out of stock SKU's removed (or quantity reduced), or the order cancelled on the client system.
  • In a CSV file, if you have a multi line order, the details of the order (address, SO number, etc.), but be included on every row. 

...

This uses the same method as the above diagram, but also incorporates delivery address lookup. This diagram shows the systematic flow used by incorporating the 'delivery address lookup' function of the Load Sales Orders service.
 


Entity Relationships

This diagram shows the high level relationship between the entities detailed in the Field Level Details section of this page.

Field level details

SalesOrder







Field

Description

Data Type

Value Limits

Requirement

Use on standard documents

Field returned in service ID/table/field (multi services split by ";")

SalesOrderNumber

Sales Order Number. Must be unique.

nvarchar(50)

Must be unique.

Mandatory

Dispatch Note, Commercial Inv

12/Dispatch/SalesOrderNumber

SalesOrderReference

Open reference field

nvarchar(50)



Dispatch Note, Commercial Inv

12/Dispatch/SalesOrderReference

OnHold

Related to wholesale, retail environment; build and then send. Order is not sent for picking but available stock is assigned to the order. Release a Sales Order from hold from SEKO 360 or using the Load Release Sales Order from Hold service.

Boolean

true, false

DoNotPushToDC

If set to TRUE, the order is sent to SupplyStream, but no stock is assigned to it and is not sent to be picked by the DC. A dispatch request must then be made from your SupplyStream account.

Boolean

true, false




NIFNumber

This will be populated by exception. It will hold a personal taxation code and is needed for shipping to some destinations. (potential rename of field)

nvarchar(100)





CourierName

Courier the goods should be dispatched on. CourierName accepted values supplied by SEKO.

Nvarchar(100)

Values provided by SEKO

If required by DC



CourierService

Courier service the goods should be dispatched on. CourierService accepted values supplied by SEKO.

Nvarchar(100)

Values provided by SEKO

If required by DC



Notes

Open notes field that appears on the standard outbound documentation

nvarchar(4000)



Dispatch Note, Commercial Inv


SpecialInstructions

A note to the DC. (Not seen if wave picking is used).

nvarchar(4000)





SalesOrderDate

The date as appears on the outbound documentation. If left blank, the date in which the sales order was created will be used. Other CSV date format options available at request.

Datetime

API: YYYY-MM-dd e.g. 2013-12-12

yyyyMMdd HHmmss
hh = 12-hour clock from 01 to 12
HH = 24-hour clock from 00 to 23


Dispatch Note, Commercial Inv


OrderType

We exclude the following order types from Wave Picking: Retail, Wholesale, WorkOrder. Typically we use Retail or Wholesale to manage trade. Work Order is for managing internal builds etc, in the DC.

nvarchar(100)

Standard, Web, Retail, Wholesale, WorkOrder

Mandatory



SalesInvoiceNumber

Sales Invoice number

nvarchar(100)




12/Dispatch/ SalesInvoiceNumber

DocumentIdentifier

Used to identify different documents. This code is provided by SEKO.

nvarchar(100)





GiftMessage

The message to the person the gift is being sent to. Pick Note will specify "Yes" if a Gift Message is present.

nvarchar(500)





GiftMessageFrom

The person the gift is from. The new field can be populated as required, including personalised names i.e. “Mum”. If first name and last name is required, the entire name should be populated within this field. 

nvarchar(100)





GiftMessageTo

The person who the gift is being sent to. The new field can be populated as required, including personalised names i.e. “Dad”. It also allows the user to specify the “To” when the gift message is for someone else who lives at the same address as the delivery recipient. If first name and last name is required, the entire name should be populated within this field. 

nvarchar(100)





ScheduledShipDate

Date in which the sales order should be dispatched. Only to be used with trade orders.

Date in which the sales order should be dispatched. Appears on the pick note.

Datetime

API: YYYY-MM-dd e.g. 2013-12-12



ShipmentTerms

DDU, DDP, etc.nvarchar(100)DDU & DAP are the options.



 

Conditional: When required for the carrier

Commercial Inv

CourierShopIDCode used during carrier allocation.nvarchar(50)



...

DeliveryDetails







Field

Description

Data Type

Value Limits

Requirement

Use on standard documents

Field returned in service ID/table/field (multi services split by ";")

ContactCode

Placeholder

nvarchar(100)





Title

Title of the delivery contact i.e. Mrs, Mr, etc. If 'Title' included, DeliveryDetails→ FirstName or DeliveryDetails→ LastName required.

nvarchar(20)





FirstName

First name of the delivery contact

nvarchar(50)


Conditional: Required for some carriers. If required for carrier, only required if DeliveryDetails→ LastName not included

Dispatch Note, Commercial Inv, Pick Note

12/Dispatch/ ShipToAttention

LastName

Last name of the delivery contact

nvarchar(50)


Conditional: Required for some carriers. If required for carrier, only required if DeliveryDetails→  FirstName not included

Dispatch Note, Commercial Inv, Pick Note

12/Dispatch/ ShipToAttention

Line1

Line 1 of the delivery contacts address

nvarchar(100)


Mandatory

Dispatch Note, Commercial Inv, Pick Note

12/Dispatch/ DeliveryAddressLine1

Line2

Line 2 of the delivery contacts address

nvarchar(100)



Dispatch Note, Commercial Inv

12/Dispatch/ DeliveryAddressLine2

Line3

Line 3 of the delivery contacts address

nvarchar(100)



Commercial Inv

12/Dispatch/ DeliveryAddressLine3

Line4

Placeholder

nvarchar(100)



Commercial Inv


City

City of the delivery contacts address

nvarchar(50)


Mandatory

Dispatch Note, Commercial Inv, Pick Note

12/Dispatch/ DeliveryAddressCity

County

County of the delivery contacts address

nvarchar(50)


Mandatory

Commercial Inv, Pick Note

12/Dispatch/ DeliveryAddressCounty

PostcodeZip

Postcode of the delivery contacts address. Postcode is not validated by the system

nvarchar(20)


Mandatory

Dispatch Note, Commercial Inv, Pick Note

12/Dispatch/ DeliveryAddressPostCode

CountryCode

Country of the delivery contacts address (ISO-2 or ISO-3).
Appears on standard physical docs as full country name.

nvarchar(2)


Mandatory

Dispatch Note, Commercial Inv, Pick Note

12/Dispatch/ DeliveryAddressCountry

PhoneNumber

Phone number of the delivery contact
Used by some carriers to send customer SMS notifications

nvarchar(20)


Conditional: required by some carriers

Commercial Inv

12/Dispatch/ DeliveryPhoneNumber

EmailAddress

Email address of the delivery contact
Used by some carriers to send customer email notifications

This will not show on SupplyStream unless you provide a First name

nvarchar(150)


Conditional: required by some carriers


12/Dispatch/ DeliveryEmailAddress

...

SalesOrderLineItem







Field

Description

Data Type

Value Limits

Requirement

Use on standard documents

Field returned in service ID/table/field (multi services split by ";")

LineNumber

Integer that uniquely identifies a line of an order. Must be more than 0. Character length restriction on the Line Number is 8 .

The SupplyStream system will order the line items by ascending LineNumber.

Int


Mandatory


12/DispatchLineItem/LineNumber

ProductCode

SKU to be dispatched. Must be unique per sales order. There must be available stock on the SKU.

nvarchar(100)


Mandatory

Dispatch Note, Commercial Inv

12/DispatchLineItem/ProductCode

OrderLineMessage

Message assigned to the SKU on line level. Used for purposes such as engraving, where the engrave message would appear in this field.

nvarchar(250)





CustomsValue

This is a unit value, calculated by the client to show duties due.

decimal(18, 2)


Required if ShipmentTerms DDP is specified



Quantity

Quantity of the SKU to be dispatched in units

Int


Mandatory



UnitPrice

The price of the unit (per unit) i.e. 4.99. Unit price should not be 0 if required by carrier or Commercial Invoice required. Unit Price is recalculated on short shipment.

decimal(18, 2)


Conditional: if required for shipping

Commercial Inv


VAT

The VAT of the unit (per unit) i.e. 0.67. This is added together to the Unit Price * Quantity value in the "Amount" column on the standard commercial invoice.
(UnitPrice * Quantity) + (VAT * Quantity) = Amount
VAT is recalculated on short shipment.

As a note, if supplying VAT irrespective of DDU/DDP, the unit value must be NET not GROSS.

decimal(18, 2)


Conditional: When required for the carrier 



CurrencyCode

The currency code of the unit price etc. (ISO-3)

nchar(3)


Conditional: if required for shipping

Commercial Inv


...