All Collections
Integrations
E-commerce
Customer sale & Purchase Order Update/Change
Customer sale & Purchase Order Update/Change

Customer sale & Purchase Order Update/Change

Updated over a week ago

Customer sale & Purchase Order Update/Change

Description

This document explains each Tag format and function required to provide a well-formed XML Customer sale/Purchase order UPDATE.

Orders can also be described as Purchase UpdateChange or Sale Order Update/Change and acronyms such as POC, SOC.

Detail Steps

tREMOTETransHeader

Sales Order header information

TAG NAME

TAG EXAMPLE

Description

Details

Size

Type

Usage

NewDataSet

-

Required SCHEMA formatting for a Sale Order

Tag should be closed at end of file data

-

-

R

tREMOTETransHeader

-

-

-

-

-

R

DTD

EdifactV2

The document encoding type

Required for Edifact users requiring response codes

50

NVARCHAR

R

RevisionNumber

2

The Purchase update document number

If not populated will be treated as a new order

20

INT

R

Company_ID

DATAPEL

Value must be DATAPEL

Required. Set to “DATAPEL”

7

NVARCHAR

R

StoreCode

SYD

Location Ship From Code

Required but can be blank. Assigned as default location from WMS configuration

50

NVARCHAR

R

PostingDate

2009-04-29T10:12:20+

DateTime of Transaction

Order Date. Suggested format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators

-

INT

R

TransID

164101

Invoice Number

Can be Blank for WMS to allocate next INV number

8

NVARCHAR

R

TransDate

2009-04-29T10:12:20+

DateTime of Transaction

Promised Date Suggested format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators

-

INT

R

Salesperson

Long

Salesperson ID

Last name of Salesperson. If “DEFAULT”, substituted with default Salesperson

52

NVARCHAR

O

CustomerID

2

Customer ID

MYOB CARD RECORD ID

-

INT

O

CardIdentification

CUS0000001

MYOB Card Identification or MYOB Tax ID

Required if CustomerID not present. Card Identification of Billing Customer.

16

NVARCHAR

O

SHIPCustomerID

2

Customer ID

Optional MYOB CARD RECORD ID

-

INT

O

SHIPCardIdentification

CUS0000001

MYOB Card Identification or MYOB Tax ID

Optional. Card Identification of Receiving Customer.

-

INT

O

SaleType

S

Type is S - Sale O - Order Q - Quote

S and O for import as order, Q to import as Quote, response file example STDs C for Purchase acknowledgement D for ASN/Delivery Advice

1

NVARCHAR

R

Status

O

NOT RELEVANT IF REMOTE SALE IMPORT AUTO PICK/PACK is SET

O - default Order A - Allocate (Sale Type must be Order/Invoice) picks and allocates available inventory

1

NVARCHAR

O

Special2

2000

Customers Purchase Order No.

The Transaction should use the original PO number or original number with -1 -2 -3 suffix

50

NVARCHAR

R

Notes

-

-

“Comment” field in Sale Order

255

NVARCHAR

O

SaleNote

-

WMS Field Sale Notes

Optional

2500

NVARCHAR

O

ShipNote

-

-

“Ship Note” field in WMS Sale Order

200

NVARCHAR

O

TERMS

-

-

Terms - (attempts Match)if unused/blank then default on card

30

NVARCHAR

O

Priority

-

Maps to WMS Order Priority HIGH, HOLD, LOW or as a number (0-3)

Optional

1

INT

O

ShippingMethod

-

-

“Name of Method” or “Default” will use customer default shipping method

255

NVARCHAR

O

ConNote

-

ConNote - Consignment Number

(ASSIGNED IF ALLOCATE SELECTED OR AUTOPICK SET OTHERWISE IGNORED)

50

NVARCHAR

O

Sent2HostDateTime

2008-04-30T17:02:11

Optional DateTime of XML Emit

Optional. Used for logging

-

INT

O

ReferralSource

-

ReferralSource - mapped to MYOB/WMS referral source descriptions

Optional

32

NVARCHAR

O

UDF1

a1b2text

Custom Data Field

Optional

200

NVARCHAR

O

UDF2

a1b2text

Custom Data Field

Optional

200

NVARCHAR

O

UDF3

a1b2text

Custom Data Field

Optional

200

NVARCHAR

O

OriginalTransID

164101

-

Internal ref maps to SAL_EDItransid

50

NVARCHAR

O

SuppressKits

False

Set to True, Yes, False or No

Setting 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)

5

NVARCHAR

O

/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 NAME

TAG Example

Description

Detail

Size

Type

Usage

tREMOTETransSaleLines

-

-

Require SCHEMA formatting for each sale line

-

-

-

SKU

320

Product Number / Barcode

Required. 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” code

50

NVARCHAR

R

SaleQty

1

Quantity Sold

Required (unless SaleUnitQty is populated). as Quantity Sold (eg. Piece) - 0 for Cancelled Lines - New Qty For Amended Lines

-

INT

R

SaleUnitQty

1

Unit Sold

Required (unless SaleQty is populated. as Unit Sold (eg. Box) - 0 For Cancelled Lines - New QTY for Amended Lines

-

INT

R

SaleUnitAmountIncTax

9.95

Sale Unit Price

Required if . as per Agreed Unit Sale Price Inc Tax - field takes presidence over if populated

-

Float

R

SaleUnitAmountExcTax

9.95

Sale Unit Price

Required if is Blank or NULL. as per Agreed Unit Sale Price Excl Tax

-

Float

R

SaleTaxByHost

Y

Tax code and amount to be set By the WMS

If Null then next check is

3

NVARCHAR

O

SaleTaxCode

N-T

Tax Code

if N or NULL then, sets exact Tax Code on sale

3

NVARCHAR

O

SaleTaxRate

10.00

Tax 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)) )

-

Float

O

SaleTaxUnitAmount

0.90

Tax Amount

If > 0, automatically changes Tax to GST for line item

-

Float

O

SKUDescription

Clown Dots

Product Description

If 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)

255

NVARCHAR

O

LineNote

May We have Blue Please

Additional Product Description

-

200

NVARCHAR

O

JobCode

JobCode

Job Code (Must already be in the Job Code List to apply/ no new additions)

-

50

NVARCHAR

O

JobNote

JobCodeNote

Additional Text Field

Optional

250

NVARCHAR

O

SaleUnitDiscount

25.50

Discount - This is the discount percentage.

-

-

Float

O

SaleRRP

9.95

RRP Unit Price

Optional. Recommended Unit Retail Sale Price Inc Tax

-

-

N

SalePriceByHost

Y

Y = Price Set By WMS N = Price Set by Import File

Optional - Price set by import file for NULLS

3

NVARCHAR

O

CurrencyCode

A

Set to A

-

-

-

N

SaleLineNo

1

-

-

-

INT

O

Cost

0.0000

Set to 0.0000

-

-

Float

O

/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. It's up to the user to then verify, create payment in WMS order and delete line item.

TAG NAME

TAG Example

Description

Details

Size

Type

Usage

tREMOTETransSaleTenders

-

ONLY ONE NODE supported

-

-

-

-

TenderType

Securepay

Payment Method

Required. 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 manually

50

NVARCHAR

O

TenderAmount

9.95

Payment Amount

Required. Tax Inclusive Payment Total

-

Float

O

CurrencyCode

A

Set to A

Optional

-

-

O

ForeignTenderAmount

0.0000

Set to 0.0000

Optional

-

-

O

TenderLine

1

-

Optional.

-

-

O

tREMOTETransSaleTenders

-

--

Schema End

-

-

R

IMPORTANT

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


tREMOTETransCustomer

Sale Order Customer / Shipping Information

TAG NAME

TAG Example

Description

Details

Size

Type

Usage

tREMOTETransCustomer

-

Schema Format Node

-

-

-

ShipToName

gtp test

SHIP TO Customer Name

Company or Last Name of Customer

-

-

O

ShipToAddress1

174 Hampden Road

SHIP TO Address Line 1

-

-

-

O

ShipToAddress2

-

Address Line 2

-

-

-

O

ShipToSuburb

NEDLANDS

SHIP TO Suburb

-

-

-

O

ShipToPostCode

6009

SHIP TO Post Code

-

-

-

O

FaxNo

-

Fax

-

-

-

O

PhoneNo1

1300 856 533 1300 856 533

Phone Contact

Optional

-

-

O

PhoneNo2

-

Phone Contact

-

-

-

O

EmailAddress

Email Address

-

-

-

O

Sent2HostDateTime

2009-04-29T10:12:20

Optional DateTime of XML Emit

Optional. 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

  • These Transactions should include all lines required in the new sale and 0 QTY for cancelled Lines.

  • The Transaction should use the original PO number with -1 -2 -3 suffix.


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.


Did this answer your question?