Peoplevox XML Sales Orders

Zynk will import the data using the standard fields under Integration Templates that can be ran configured your Peoplevox web application. Note, the fields must use the default names, you can import the correct configuration using the file below.

Tasks

Integration Templates

Sales Order

Download Template

SalesOrderNumber,Customer,CustomerPurchaseOrderReferenceNumber,ShippingAddressLine1,ShippingAddressLine2,ShippingAddressCity,ShippingAddressRegion,ShippingAddressPostcode,ShippingAddressCountry,ShippingAddressReference,InvoiceAddressLine1,InvoiceAddressLine2,InvoiceAddressCity,InvoiceAddressRegion,InvoiceAddressPostcode,InvoiceAddressCountry,InvoiceAddressReference,IsPartialShipment,Status,RequestedDeliveryDate,ShippingCost,Email,ContactName,TotalSale,Discount,TaxPaid,CreatedDate,PaymentMethod,ServiceType,ChannelName

Sales Order Item

Download Template

SalesOrderNumber,ItemCode,QuantityOrdered,RequestedDeliveryDate,Line,Sequence,SalePrice

Identifiers

For inserting or updating records to Peoplevox Zynk uses the SalesOrderNumber field on a SalesOrder. It is invalid to insert / update a SalesOrder without providing the SalesOrderNumber. If updating an existing SalesOrder the items will be added or edited depending on what information is provided, it is not possible to remove lines.

Fields

SalesOrderNumber

Required
Sales order number.

Type Example XML
string(30) SO-123456 <SalesOrderNumber>SO-123456</SalesOrderNumber>

Customer

Optional
Customer name or reference.

Type Example XML
string(50) Andrew Snape <Customer>Andrew Snape</Customer>

CustomerPurchaseOrderReferenceNumber

Optional
Customer purchase order reference number.

Type Example XML
string(50) SO-ABCDEF <CustomerPurchaseOrderReferenceNumber>SO-ABCDEF</CustomerPurchaseOrderReferenceNumber>

ShippingAddressLine1

Optional
Line 1.

Type Example XML
string(100) i6 <ShippingAddressLine1>i6</ShippingAddressLine1>

ShippingAddressLine2

Optional
Line 2.

Type Example XML
string(100) 6 - 8 Charlotte Square <ShippingAddressLine2>6 - 8 Charlotte Square</ShippingAddressLine2>

ShippingAddressCity

Optional
City.

Type Example XML
string(100) Newcastle <ShippingAddressCity>Newcastle</ShippingAddressCity>

ShippingAddressRegion

Optional
Region.

Type Example XML
string(100) Tyne and Wear <ShippingAddressRegion>Tyne and Wear</ShippingAddressRegion>

ShippingAddressPostcode

Optional
Post code.

Type Example XML
string(100) NE1 4XF <ShippingAddressPostcode>NE1 4XF</ShippingAddressPostcode>

ShippingAddressCountry

Optional
Country.

Type Example XML
string(100) United Kingdom <ShippingAddressCountry>United Kingdom</ShippingAddressCountry>

ShippingAddressReference

Optional
Reference.

Type Example XML
string(100) WORK <ShippingAddressReference>WORK</ShippingAddressReference>

InvoiceAddressLine1

Optional
Line 1.

Type Example XML
string(100) i6 <InvoiceAddressLine1>i6</InvoiceAddressLine1

InvoiceAddressLine2

Optional
Line 2.

Type Example XML
string(100) 6 - 8 Charlotte Square <InvoiceAddressLine2>6 - 8 Charlotte Square</InvoiceAddressLine2>

InvoiceAddressCity

Optional
City.

Type Example XML
string(100) Newcastle <InvoiceAddressCity>Newcastle</InvoiceAddressCity>

InvoiceAddressRegion

Optional
Region.

Type Example XML
string(100) Tyne and Wear <InvoiceAddressRegion>Tyne and Wear</InvoiceAddressRegion>

InvoiceAddressPostcode

Optional
Post code.

Type Example XML
string(100) NE1 4XF <InvoiceAddressPostcode>NE1 4XF</InvoiceAddressPostcode>

InvoiceAddressCountry

Optional
Country.

Type Example XML
string(100) United Kingdom <InvoiceAddressCountry>United Kingdom</InvoiceAddressCountry>

InvoiceAddressReference

Optional
Reference.

Type Example XML
string(100) WORK <InvoiceAddressReference>WORK</InvoiceAddressReference>

IsPartialShipment

Optional
Is partial shipment, defaults to false.

Type Example XML
boolean true <IsPartialShipment>true</IsPartialShipment>

Available Values

  • true
  • false

Status

Optional
The name of the status. Only the “cancelled” status is permitted on imports; all other statuses are read-only (optional) (see Sales order statuses)

Type Example XML
string(50) New <Status>New</Status>

Available Values

  • Cancelled

RequestedDeliveryDate

Optional
Requested date in "yyyy-MM-dd HH:mm:ss" format.

Type Example XML
string(19) 2017-07-20 00:00:00 <RequestedDeliveryDate>2017-07-20 00:00:00</RequestedDeliveryDate>

ShippingCost

Optional
Shipping cost.

Type Example XML
decimal 5 <ShippingCost>5</ShippingCost>

Email

Required
Email.

Type Example XML
string(500) [email protected] <Email>[email protected]</Email>

ContactName

Required
Contact name.

Type Example XML
string(100) Andrew Snape <ContactName>Andrew Snape</ContactName>

TotalSale

Required
Total sale.

Type Example XML
decimal 18 <TotalSale>18</TotalSale>

Discount

Required
Discount.

Type Example XML
decimal 0 <Discount>0</Discount>

TaxPaid

Required
Tax paid.

Type Example XML
decimal 3 <TaxPaid>3</TaxPaid>

CreatedDate

Required
Created date in "yyyy-MM-dd HH:mm:ss" format.

Type Example XML
string(19) 2017-07-11 00:00:00 <CreatedDate>2017-07-11 00:00:00</CreatedDate>

PaymentMethod

Required
Payment method.

Type Example XML
int 1 <PaymentMethod>1</PaymentMethod>

ServiceType

Required
Service type.

Type Example XML
string(100) <ServiceType></ServiceType>

ChannelName

Required
Channel name.

Type Example XML
string(50) Website <ChannelName>Website</ChannelName>

SalesOrderItems

Required
You need to provide a collection of items as part of the import.

ItemCode

Required
Item code.

Type Example XML
string(50) PROD001 <ItemCode>PROD001</ItemCode>

QuantityOrdered

Required
Quantity ordered.

Type Example XML
1 1 <QuantityOrdered>1</QuantityOrdered>

RequestedDeliveryDate

Required
Requested date in "yyyy-MM-dd HH:mm:ss" format.

Type Example XML
string(19) 2017-07-19 00:00:00 <RequestedDeliveryDate>2017-07-19 00:00:00</RequestedDeliveryDate>

Line

Required
Line.

Type Example XML
string(16) <Line></Line>

Sequence

Required
Sequence.

Type Example XML
int 1 <Sequence>1</Sequence>

SalePrice

Required
Sale price.

Type Example XML
decimal 10 <SalePrice>10</SalePrice>

CustomerData

Optional
If you have the Auto Create Customers option enabled, you must provide the customer information object in the element.

See Peoplevox XML Customers

Example XML

Please see below an example of sales order XML:

<?xml version="1.0" encoding="utf-8"?>
<SalesOrders
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <SalesOrder>
        <SalesOrderNumber>SO-123456</SalesOrderNumber>
        <Customer>Andrew Snape</Customer>
        <CustomerPurchaseOrderReferenceNumber>SO-ABCDEF</CustomerPurchaseOrderReferenceNumber>
        <ShippingAddressLine1>i6</ShippingAddressLine1>
        <ShippingAddressLine2>6 - 8 Charlotte Square</ShippingAddressLine2>
        <ShippingAddressCity>Newcastle</ShippingAddressCity>
        <ShippingAddressRegion>Tyne and Wear</ShippingAddressRegion>
        <ShippingAddressPostcode>NE1 4XF</ShippingAddressPostcode>
        <ShippingAddressCountry>United Kingdom</ShippingAddressCountry>
        <ShippingAddressReference>WORK</ShippingAddressReference>
        <InvoiceAddressLine1>i6</InvoiceAddressLine1>
        <InvoiceAddressLine2>6 - 8 Charlotte Square</InvoiceAddressLine2>
        <InvoiceAddressCity>Newcastle</InvoiceAddressCity>
        <InvoiceAddressRegion>Tyne and Wear</InvoiceAddressRegion>
        <InvoiceAddressPostcode>NE1 4XF</InvoiceAddressPostcode>
        <InvoiceAddressCountry>United Kingdom</InvoiceAddressCountry>
        <InvoiceAddressReference>WORK</InvoiceAddressReference>
        <IsPartialShipment>true</IsPartialShipment>
        <Status>New</Status>
        <RequestedDeliveryDate>2017-07-20 00:00:00</RequestedDeliveryDate>
        <ShippingCost>5</ShippingCost>
        <Email>[email protected]</Email>
        <ContactName>Andrew Snape</ContactName>
        <TotalSale>18</TotalSale>
        <Discount>0</Discount>
        <TaxPaid>3</TaxPaid>
        <CreatedDate>2017-07-11 00:00:00</CreatedDate>
        <PaymentMethod>1</PaymentMethod>
        <ServiceType></ServiceType>
        <ChannelName>Website</ChannelName>
        <SalesOrderItems>
            <SalesOrderItem>
                <ItemCode>PROD001</ItemCode>
                <QuantityOrdered>1</QuantityOrdered>
                <RequestedDeliveryDate>2017-07-19 00:00:00</RequestedDeliveryDate>
                <Line></Line>
                <Sequence>1</Sequence>
                <SalePrice>10</SalePrice>
            </SalesOrderItem>
        </SalesOrderItems>
    </SalesOrder>
</SalesOrders>

Please see below an example of sales order XML with customer data included:

<?xml version="1.0" encoding="utf-8"?>
<SalesOrders>
	<SalesOrder>
		<SalesOrderNumber>SO-223456</SalesOrderNumber>
		<CustomerPurchaseOrderReferenceNumber>SO-BBCDEF</CustomerPurchaseOrderReferenceNumber>
		<ShippingAddressLine1>i6</ShippingAddressLine1>
		<ShippingAddressLine2>6 - 8 Charlotte Square</ShippingAddressLine2>
		<ShippingAddressCity>Newcastle</ShippingAddressCity>
		<ShippingAddressRegion>Tyne and Wear</ShippingAddressRegion>
		<ShippingAddressPostcode>NE1 4XF</ShippingAddressPostcode>
		<ShippingAddressCountry>United Kingdom</ShippingAddressCountry>
		<InvoiceAddressLine1>i6</InvoiceAddressLine1>
		<InvoiceAddressLine2>6 - 8 Charlotte Square</InvoiceAddressLine2>
		<InvoiceAddressCity>Newcastle</InvoiceAddressCity>
		<InvoiceAddressRegion>Tyne and Wear</InvoiceAddressRegion>
		<InvoiceAddressPostcode>NE1 4XF</InvoiceAddressPostcode>
		<InvoiceAddressCountry>United Kingdom</InvoiceAddressCountry>
		<IsPartialShipment>true</IsPartialShipment>
		<Status>New</Status>
		<RequestedDeliveryDate>2017-07-20 00:00:00</RequestedDeliveryDate>
		<ShippingCost>5</ShippingCost>
		<Email>[email protected]</Email>
		<ContactName>Andrew Snape</ContactName>
		<TotalSale>18</TotalSale>
		<Discount>0</Discount>
		<TaxPaid>3</TaxPaid>
		<CreatedDate>2017-07-11 00:00:00</CreatedDate>
		<PaymentMethod>1</PaymentMethod>
		<ServiceType/>
		<ChannelName>Website</ChannelName>
		<SalesOrderItems>
			<SalesOrderItem>
				<ItemCode>PROD001</ItemCode>
				<QuantityOrdered>1</QuantityOrdered>
				<RequestedDeliveryDate>2017-07-19 00:00:00</RequestedDeliveryDate>
				<Line/>
				<Sequence>1</Sequence>
				<SalePrice>10</SalePrice>
			</SalesOrderItem>
		</SalesOrderItems>
		<CustomerData>
			<CustomerType>Individual</CustomerType>
			<Name>John Doe</Name>
			<FirstName>John</FirstName>
			<LastName>Doe</LastName>
			<Phone>0191 820 1484 +24</Phone>
			<Mobile>0773 862 6085</Mobile>
			<Email>[email protected]</Email>
			<CreditLimit>1000</CreditLimit>
			<CreditStatus>true</CreditStatus>
			<Wholesaler>false</Wholesaler>
		</CustomerData>
	</SalesOrder>
</SalesOrders>