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.), must be included on every row.
  • A web contact consists of DeliveryAddress: First Name, Last Name, Email Address, Phone Number.

...


API

FTP

Manual

XML

x

x


JSON

x



CSV


x

x



Entity Relationships

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

Field level details

...

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. For CSV, can be auto incremented if this cannot be provided, which will increment each sales order starting from 1.

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. 

If the clients populate the "Order Line Message" , then this order will be a non standard requirement

nvarchar(250)





Quantity

Quantity of the SKU to be dispatched in units. Line Item Quantity needs to be greater than zero. Unit quantity should match the inbound quantity (per EACH)

Int


Mandatory



UnitPrice

The price of the unit (per unit) i.e. 4.99. Ex VAT if VAT field is provided in separate VAT field. 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

If  VAT ispopulated

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.

If “SalesOrderLineItem.Vat” is greater than zero then “SalesOrderLineItem.UnitPrice” is required

decimal(18, 2)


Conditional: When required for the carrier 



CurrencyCode

The currency code of the unit price etc. (ISO-3). Use the same code for the entire order.

nchar(3)


Conditional: if UnitPrice or VAT are populated

Commercial Inv



Anchor
_GoBack
_GoBack