Description

This documents explains each Tag format and function required to provide a well-formed XML Customer sale/Purchase order as input to WMS.

Orders can also be described as Purchases or Sale Orders and accronyms such as PO, SO.

Detail Steps

tREMOTETransHeader

Sales Order header information

TAG NAMETAG EXAMPLEDescriptionDetailsSizeTypeUsage
NewDataSet
Required SCHEMA formatting for a Sale OrderTag should be closed at end of file data

R
tREMOTETransHeader




R
DTDEdifactV2The document encoding typeRequired for Edifact users requiring response codes50NVARCHARO
RevisionNumber1PO always Revision 1fix to 13INTR
Company_IDDATAPELValue must be DATAPELRequired. Set to “DATAPEL”7NVARCHARR
StoreCodeSYDLocation Ship From CodeRequired but can be blank. Assigned as default location from WMS configuration50NVARCHARR
PostingDate2009-04-29T10:12:20+DateTime of TransactionOrder Date. Suggested format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators
INTR
TransID164101 Invoice NumberCan be Blank for WMS to allocate next INV number8NVARCHARR
TransDate2009-04-29T10:12:20+DateTime of TransactionPromised Date Suggested format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators
INTR
SalespersonLongSalesperson IDLast name of Salesperson or card Identification. If “DEFAULT”, substituted with default Salesperson52NVARCHARO
CustomerID2Customer IDMYOB CARD RECORD ID
INTO
CardIdentification

CUS0000001

MYOB Card Identification or MYOB Tax IDRequired if CustomerID not present. Card Identification of Billing Customer.16NVARCHARO
MYOBCardName

The Shoe Shop

Card Name exactly as stored in MYOB/WMSRequired if CustomerID not populated/unmatched or CardIdentification of Billing Customer not populated/unmatched.50NVARCHARO

SHIPCustomerID

2

Customer IDOptional MYOB CARD RECORD ID
INTO
SHIPCardIdentification

CUS0000001

MYOB Card Identification or MYOB Tax IDOptional. Card Identification of Receiving Customer.
INTO
SaleTypeSType is S - Sale O - Order Q - Quote R- Blind Return X- ExchangeS and O for import as order, Q to import as Quote, response file example STDs = R will be a blind return and creates a Goods Inward (as per Sales return workflow), X will create a Sale Order with pick lines - no goods inward and is recommended for workflows where the stock is immediately returned into inventory.1NVARCHARR
StatusONOT RELEVANT IF REMOTE SALE IMPORT AUTO PICK/PACK is SETO - default Order A - PICK (Sale Type must be Order/Invoice) picks available inventory D- picks packs and Ships if all stock available.1NVARCHARO
AllocateYAllocates whole order regardless of availability (Does not split allocate)
  "Y" OR "T" If Used then AllocateDate is set to Imported dated
1NVARCHAR0
Special22000Customers Purchase Order No.
50NVARCHARO
Notes

“Comment” field in Sale Order255NVARCHARO
SaleNote
WMS Field Sale NotesOptional2500NVARCHARO
ShipNote

“Ship Note” field in WMS Sale Order200NVARCHARO
TERMS

Terms - (attempts Match)if unused/blank then default on card30NVARCHARO
Priority
Maps to WMS Order Priority HIGH, HOLD, LOW or as a number (0-3)Optional1INTO
ShippingMethod

“Name of Method” or “Default” will use customer default shipping method255NVARCHARO
ConNote
ConNote - Consignment Number(ASSIGNED IF ALLOCATE SELECTED OR AUTOPICK SET OTHERWISE IGNORED)50NVARCHARO
Sent2HostDateTime2008-04-30T17:02:11Optional DateTime of XML EmitOptional. Used for logging
INTO
ReferralSource
ReferralSource - mapped to MYOB/WMS referral source descriptionsOptional32NVARCHARO
UDF1a1b2textCustom Data FieldOptional (STD usage = Advertisement Date)200NVARCHARO
UDF2a1b2textCustom Data FieldOptional (STD usage = Dept/Zone)200NVARCHARO
UDF3a1b2textCustom Data FieldOptional (STD usage = Department / Zone Description)200NVARCHARO
OriginalTransID164101
Internal ref maps to SAL_EDItransid50NVARCHARO
SuppressKitsFalseSet to True, Yes, False or NoSetting this tag in the XML Sale Header (not done per line) will cause any KIT item to be ignored and imported as a standard item code with the assigned pricing or price by host. (useful when you want to import the kit as a whole not just the kit header)5NVARCHARO

/tREMOTETransHeader










Usage = R - Required, O - Optional, N - Not In Use

  1. tREMOTETransHeader/Company_ID - Please put “DATAPEL” for all orders to identify the processing process model for WMS
  2. tREMOTETransHeader/TaxInclusive - Order processed as tax inclusive in WMS, please put “TRUE”, else leave blank
  3. If there is a shipping method/cost involved you can specify using the following tags, the shipping method and cost will come through to WMS as separated order line within the order.
  4. tREMOTETransHeader/ShippingCost - Shipping cost, tax inclusive

 

tREMOTETransSaleLines

Sale Order line information (multiple allowed)

TAG NAMETAG ExampleDescriptionDetailSizeTypeUsage
tREMOTETransSaleLines

Require SCHEMA formatting for each sale line


SKU320Product Number / BarcodeRequired. Use same item number or Barcode (normally CF1,CF2,CF3 or UDF1) as specified in MYOB, any line with item that cannot be identified cause the entire order to be OnHold and Item number to be entered with “\c” code50NVARCHARR
HOSKU32102Product Number / BarcodeIf the is not found it will try for HOSKU if populated50NVARCHARO
SaleQty1Quantity SoldRequired (unless is populated). as Quantity Sold (eg. Piece)
INTR
SaleUnitQty1Unit SoldRequired (unless is populated. as Unit Sold (eg. Box)
INTR
SaleUnitAmountIncTax9.95Sale Unit PriceRequired if . as per Agreed Unit Sale Price Inc Tax - field takes presidence over if populated
FloatR
SaleUnitAmountExcTax9.95Sale Unit PriceRequired if is Blank or NULL. as per Agreed Unit Sale Price Excl Tax
FloatR
SaleTaxByHostYTax code and amount to be set By the WMSIf Null then next check is3NVARCHARO
SaleTaxCodeN-TTax Codeif N or NULL then, sets exact Tax Code on sale but is required for kit headers in all cases3NVARCHARO
SaleTaxRate10.00Tax Rate (in Percent value e.g 10.00%)Ignored if match is found. if N and VAT<\TaxCode> <> existing Tax Code in MYOB or BOTH NULL then(10.00 for GST, 0 for N-T)(Auto calculates unit price = SaleUnitAmountIncTax / (1+(SaleTaxRate/100)) )
FloatO
SaleTaxUnitAmount0.90Tax AmountIf > 0, automatically changes Tax to GST for line item
FloatO
SKUDescriptionClown DotsProduct DescriptionIf blank allocates default item description (You may also add line Promised Date (not after date) here in the format of #D27/08/2014 it must be at the end of the line description)255NVARCHARO
LineNoteMay We have Blue PleaseAdditional Product Description
200NVARCHARO
JobCodeJobCodeJob Code (Must already be in the Job Code List to apply/ no new additions)
50NVARCHARO
JobNoteJobCodeNoteAdditional Text FieldDelivery Store ID for Multi Delivery Orders250NVARCHARO
SaleUnitDiscount25.50Discount - This is the discount percentage.

FloatO
SaleRRP9.95RRP Unit PriceOptional. Recommended Unit Retail Sale Price Inc Tax

N
SalePriceByHostYY = Price Set By WMS N = Price Set by Import FileOptional - Price set by import file for NULLS3NVARCHARO
CurrencyCodeASet to A


N
SaleLineNo1


INTO
Cost0.0000Set to 0.0000

FloatO
/tREMOTETransSaleLines
End Sale Line


R

Usage = R - Required, O - Optional, N - Not in Use

 


tREMOTETransSaleTenders

Sale Order Payment / Tender information

IMPORTANT: Does not create payment in WMS. Add a line to notify user of payment amount and method.Up to user to then verify, create payment in WMS order and delete line item.|

TAG NAMETAG ExampleDescriptionDetailsSizeTypeUsage
tREMOTETransSaleTenders
ONLY ONE NODE supported



TenderTypeSecurepayPayment MethodRequired. Accounting Payment Methods e.g. Credit Card, PayPal. The payment type matching a payment method in the MYOB/WMS database. If no match is found a new comment line will be created within the order to specify the payment type and amount, and users will need to process it in their system manually50NVARCHARO
TenderAmount9.95Payment AmountRequired. Tax Inclusive Payment Total
FloatO
CurrencyCodeASet to AOptional

O
ForeignTenderAmount0.0000Set to 0.0000Optional

O
TenderLine1
Optional.

O
tREMOTETransSaleTenders
-Schema End

R

IMPORTANT: If users need to process the payment information as single payment applied directly to the sale order then set Tools → Preferences → Adaptors → Process Payment Information from Remote Sales, as checked, otherwise all payment information will be appear as a comment line in the order by default and is manually reconciled.

 


tREMOTETransCustomer

Sale Order Customer / Shipping Information

TAG NAMETAG ExampleDescriptionDetailsSizeTypeUsage
tREMOTETransCustomer
Schema Format Node


ShipToNamegtp testSHIP TO Customer NameCompany or Last Name of Customer

O
ShipToAddress1174 Hampden RoadSHIP TO Address Line 1


O
ShipToAddress2
Address Line 2


O
ShipToSuburbNEDLANDSSHIP TO Suburb


O
ShipToPostCode6009SHIP TO Post Code


O
FaxNo
Fax


O
PhoneNo11300 856 533 1300 856 533 Phone ContactOptional

O
PhoneNo2
Phone Contact


O
EmailAddressbevan.holman@gtp.com.auEmail AddressWhen populated and if UDF3 is null or "" then  data within this field will populate UDF3

O
Sent2HostDateTime2009-04-29T10:12:20Optional DateTime of XML EmitOptional. Used for logging

O
/tREMOTETransCustomer

Schema Node End

R

Important - Use TransCustomer to manually allocate shipping address. Primary billing information is assigned by CardIdentification in TransSaleHeader



Related Information

XML Text Encoding Rules

Preferred encoding UTF-8

The fields in the xml file should not use cdata and should not contain any of the following characters without encoding ~ < > & TAB CR LF ( ascii 10 / 13)

Special Characters

Characters used in programming should be encoded as below.

~ - ~tl~

< - ~lt~

”>” - ~gt~

& - ~am~

Chr(9) - ~09~

Chr(10) - ~10~

Chr(13) - ~13~

' Single quotes do not require any encoding.