NewHaven Software Wiki - User contributions [en]

Custom SQL Filters

2015-09-24T17:53:15Z

Jmorrison: /* Examples */

In addition to the standard invoice and mail list filter criteria provided in CMS, you also have the option to write your own SQL. This is useful for when you'd want to create a filter that is beyond the standard options available through the CMS interface.

It is important to note that when you select the 'Write Own SQL' checkbox, it supersedes all other criteria and becomes the only enabled option on the filter screen. You cannot combine it with other filter criteria. You can, however, customize a mail filter created in CMS.

In the Mail List Filter section you have the option of creating a filter using the checkboxes to get as close as you can to your desired filter. Once saved you would then click on View SQL to see the resulting SQL CMS has created based on the options selected. You cannot edit that SQL there but you can copy it and create a new filter with 'Write Own SQL' and paste/edit it there.

This can be very handy and is rather easy to do as, often times, the only modification desired is a change in Boolean values. For example, if you create a filter based on two customer description codes (CDC's) the default Boolean is 'OR'. In other words, customers will qualify for this filter if they have one code OR the other. If you only wanted customers who had both codes, you would create a custom filter, paste in the SQL from the original filter and change the OR to an AND.

Syntax is very important in these filters so if you are writing one from scratch, please pay attention to these examples for guidance on what your Selects should look like (namely the use of DISTINCT and which tables are being referenced):

=Mail List Filters=
==Requirements==
Every mail list filter must include (start with) at least the following:
<source lang="tsql">
SELECT DISTINCT C.*
FROM CUST C
WHERE ...
</source>

==Mail list filter examples==
NOTE: When writing your own SQL keep in mind if you are going to be using these statements in [[Compound Mail List Filters]], you will need to return C.ID, not C.* This makes these individual filters suitable for use only as components for Compound filters. They can no longer be used on their own. Our recommendation is to label them as compound filter components. Like COMP_Products_By_Date and COMP_Not_Select_Products. Doing this you will know not to use them by themselves. To use the filters by themselves and to combine different filters together, you have to use joins and not compound filters.

===Products Purchased===
Target customers based on products fulfilled within a date range (3 examples) and thus excludes unfulfilled back orders and future ships. Date range is based off of the fulfill date. These filters also exclude fully returned/canceled items.

*In a Date Range
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT between '2010-01-31' and '2010-03-31'
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Greater than a specified date
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT > '2010-01-31'
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Ordered in the last 30 days
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT > (TODAY(*) - 30)
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Sold by a specific salesperson, only shipped and not returned (no date range)
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C INNER JOIN orderhdr o ON c.id = o.cust_num
INNER JOIN itemsord i ON o.order_id = i.order_id
WHERE o.proforma <> 1
AND o.tempsave <> 1
AND i.status > 5
AND i.order_qty > (i.cur_return + cur_cancel)
AND (i.prod_code = 'PRODUCT CODE'
AND o.SALES_ID = 'Salesperson Username')
</source>

*Customers that bought from a specified list of products in a selected date range. Exclude if they bought any from another list of products or if the customer is set to Do Not Mail Catalog.
(this query has to look at your entire order history and will take a long time to run)
<source lang='tsql'>
SELECT DISTINCT C.* FROM CUST C
LEFT JOIN CUSTFLAGS CF ON CF.ID = C.ID AND CF.FLAG_ID = 1
JOIN ITEMSORD I ON I.CUST_NUM = C.ID
WHERE I.FULFILL_DT BETWEEN '2012-02-01' AND '2013-03-07'
AND (I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT
AND I.PROD_CODE IN ('PRODCODE-A','PRODCODE-B')
-- FLAG_ID <> 1 by matching on null with the left join
AND CF.FLAG_ID IS NULL
AND C.ID NOT IN
(SELECT IO.CUST_NUM FROM ITEMSORD IO WHERE IO.PROD_CODE IN (
-- Comma delimited list of product codes to match for exclusion from the customer list
'PRODCODE-X','PRODCODE-Y','PRODCODE-Z')
GROUP BY IO.CUST_NUM
-- End customer exclusion list
);
</source>

===[[CMS Customer Filter for customers with a specific item on Back Order]]===
Click the title link to redirect to an article specifically on this topic.

===[[Targeting Catalog Requestors]]===
Click the title link to redirect to an article specifically on this topic.

===Customers with Unshipped Orders in a Date Range===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
LEFT OUTER JOIN ORDERHDR O ON (C.ID = O.CUST_NUM)
WHERE
((O.order_dt BETWEEN '2012-05-18' AND '2013-09-18')
AND (isnull(o.shipped_dt,'1899-12-30') = '1899-12-30'))
AND (C.EMAIL <> '')
</source>

===By First Order Date===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE
(C.FIRST_DATE BETWEEN '2013/08/15' AND '2013/08/15')
</source>

===Phone number Area code===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE
(C.ID IN (SELECT CUST_NUM FROM PHONES
where phone_num like
'(297%'
or phone_num like
'297'
or phone_num like
'1297'
or phone_num like
'1-297'
))
</source>

===Customers having more than one Customer Description Code===
In CMS it is easy to find customers who have any one code, or one of several, but you'll need custom SQL like the following to find customers who must have more than one of a list of codes to qualify.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.ID IN (
SELECT CUST_NUM FROM CUSTDESC
WHERE CUSDESKE in ('0525','0600')
GROUP BY CUST_NUM
HAVING COUNT(CUST_NUM) >= 2 -- 2 = the number of values to find
)
</source>

*Change the cusdeske values to correspond to the desired customer description codes (CDC) per the CUSDESCO table
*Change the integer in the last line to indicate the number of CDC matches required

===Customers with a Company Name===

<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.COMPANY <> ''
</source>

===Last Modified===
The Last Modified field was added in CMS 8.0 but does not yet have a corresponding mail filter option. Here are a couple of examples of how you can build this into your filters:
*Last Modified in a range of dates:
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (C.LAST_UPDAT BETWEEN '2011/05/02' AND '2012/05/02')
</source>
Change the dates as needed.

*Last Modified in the last 180 days:
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (C.LAST_UPDAT > (TODAY(*) - 180))
</source>
Change 180 to whatever number of days back is desired.

===All Recipients for a Customer (e.g. Amazon)===
If you are processing orders with Amazon or similar partner, you'll only get shipping addresses and not billing information from them since Amazon handles all of the payments. As such these orders will import into CMS with Amazon as the customer and always attach themselves to your Amazon customer record. If you have the option enabled in CMS Order Entry Options, new customer records will also be created for each ship-to. It may be helpful to be able to identify those ship-to customer records. This might be to tag them with a customer description code, exclude from an upcoming mailing, etc. This SQL can be used as a mail list filter to find those recipient customer records that have ordered through Amazon (or whoever your orders are coming from.)

<source lang="tSQL">
SELECT DISTINCT C.*
From CUST c
where C.ID in
(Select a.cust_num
From Address a
Join recipient r on r.address_id = a.address_id
Join recipient_order ro on ro.recipient_id = r.recipient_id
Join orderhdr o on o.order_id = ro.order_idWhere o.cust_num = '0000518128')
</source>

Change the customer number in the last line to match your billing account for Amazon. Zero pad to ten total characters as shown in the above example.

===Orders Placed from Selected Order Sources===
<source lang="tSQL">
SELECT DISTINCT c.*
FROM CUST c, ORDERHDR o
WHERE (o.ORDER_SRC in
(Select ID from ORDERSRC where name in
('Phoned In','Mailed In'))
AND o.ORDER_DT BETWEEN '2011-01-31' AND '2011-10-31'
AND o.CANCELLED = 0)
AND (o.CUST_NUM = C.ID)
</source>

===Invoice created in a date range with a captured credit card but invoice is unshipped===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, INVOICE I
JOIN Payledger p on p.order_id = i.order_id
and p.invoice_id = i.invoice_id
JOIN chargeinfo r on p.payid = r.payid
WHERE I.ORDER_DT between '2012-08-31' and '2013-02-28'
AND I.SHIPPED_FL = '0'
AND r.edc = 1
AND (I.CUST_NUM = C.ID)
</source>

===Customers with a declined credit card in last 30 days===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
JOIN paylist l on l.ID = C.ID
JOIN paytypes t on t.pay_type = l.pay_type
Where l.badpayment = '1'
AND l.DELETED = '0'
AND t.credit_car = '1'
AND l.createdate > (TODAY(*)-30)
</source>

===Filter based on one of the customer user defined fields where the value is greater than X===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (REGEXP_SUBSTR(C.USERCODE1,'\d+\.*\d*') > 12.4)
</source>
*This method allows you to perform a greater or less than query on a user field which is not explicitly defined as numeric. That said, this filter will fail if you have any non-numeric values in the corresponding user-defined field in any of the customer records.
*It is important to understand that any time you are running a "greater than" or "less than" operator against a numeric value you must not use quotes. Otherwise SQL will interpret that as a string comparison. And string comparing numeric values will not be accurate.

=Invoice filters=
==Invoice Filter requirements==
Every invoice filter must include (start with) at least the following:
<source lang="tsql">
SELECT DISTINCT I.* FROM INVOICE I, ORDERHDR O
where ...
and I.order_id = O.order_id
</source>

==Examples==
*Target invoices whose item total is greater than $X
<source lang="tsql">
SELECT DISTINCT I.* FROM Invoice I, Orderhdr O
WHERE I.ITEM_TOT > 300
and I.order_id = O.order_id
</source>
Modify the 300 in this example to represent the desired item total threshold. This item total take into account line and order level discounts but does not include S&H, taxes, or other order level charges.

*Target invoices shipping to Canada
<source lang="tsql">
Select Distinct I.* from Invoice I, Address A, Orderhdr O
where I.SHIP_ID = A.ADDRESS_ID
and A.COUNTRY = '001'
and I.order_id = O.order_id
</source>

*Target invoices with packages shipping via specific methods. This is useful with Best Shipping since the order/invoice no longer has a shipping method or if you're trying to filter on the actual shipping choice used instead of the underlying service level (which is how the shipping method filters work normally)
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I, Package P, Orderhdr O
WHERE I.order_id = P.order_id and I.invoice_id = P.invoice_id
and I.order_id = O.order_id
and P.shipmethid in
(SELECT shipmethid FROM SHIPMETH
WHERE SEL_LETTER in ('C','UC'))
</source>

*Targets fulfilled invoices with a specific adcode that does not use a specific term and the order does not contain an item ending with M:
<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I, ORDERHDR O
WHERE I.order_id = O.order_id
AND O.adcode = ' HOMESHOW'
AND O.term_id <> '002'
AND I.fulfill_dt > '2010-01-01'
AND I.order_id|I.invoice_id NOT IN
(SELECT order_id|invoice_id
FROM itemsord
WHERE fulfill_dt > '2010-01-01'
AND prod_code LIKE '%M')
</source>

*Single Item Orders - The technique used here to identify which invoice are single product is unusual and noteworthy. There is a join against a sub-select because a sub-select on its own is only useful when looking for a single field and in this case we need both order_id and invoice_id.
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN ORDERHDR O ON O.order_id = I.order_id
JOIN ITEMSORD T ON T.order_id = I.order_id AND T.invoice_id = I.invoice_id
JOIN (SELECT order_id, invoice_id FROM itemsord
GROUP BY ORDER_ID, Invoice_id
HAVING count(line_id) = 1) j ON j.order_id = I.order_id AND j.invoice_id = I.invoice_id
WHERE I.TRANS_TYPE <> 'R' --Excluding returns
AND T.PROD_CODE IN ('SUB1','SUB2','SUB3')
</source>

*Invoices by State and Carrier - We wrote this for invoice filtering by state. This shows the use of a sub-select that is not part of a join:
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN Orderhdr O ON O.order_id = I.order_id
JOIN Address A ON A.ADDRESS_ID = I.SHIP_ID
WHERE A.STATE IN
('ME','NH','VT','MA','CT','RI','NJ','DE','MD','DC','NY','PA','VA','NC','SC','GA','TN','KY','WV','OH','AL')
AND O.SHIP_VIA IN (SELECT ship_code FROM SHIPPERS WHERE SHIPPER = 'UPS')
</source>

*Invoices using a specific shipping method AND have at least one item in a bin location range:

<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON O.ORDER_ID = I.ORDER_ID
JOIN (
SELECT IO.INVOICE_ID, IO.ORDER_ID FROM SKUWARE S
JOIN ITEMSORD IO ON IO.SKU_ID = S.SKU_ID
WHERE REGEXP_SUBSTR(S.BINLOC,'\d+\.\d') BETWEEN 3.0 AND 3.9
GROUP BY IO.ORDER_ID, IO.INVOICE_ID, IO.WAREHOUSE
) BIN ON BIN.INVOICE_ID = I.INVOICE_ID AND BIN.ORDER_ID = I.ORDER_ID
WHERE I.SHIPMETH_USED = 'First Class Mail'
</source>

*Invoices using a specific shipping method AND have only items in a bin location range (assumes bin locations are numeric):

<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON O.ORDER_ID = I.ORDER_ID
JOIN (SELECT IO.INVOICE_ID,
IO.ORDER_ID, IO.WAREHOUSE,
REGEXP_SUBSTR(S.BINLOC,'\d+\.*\d*') AS BINLOC_NUM,
COUNT(IO.ITEMID) AS ITEMS
FROM SKUWARE S JOIN ITEMSORD IO ON IO.SKU_ID = S.SKU_ID
GROUP BY IO.ORDER_ID, IO.INVOICE_ID, IO.WAREHOUSE, S.BINLOC
HAVING BINLOC_NUM BETWEEN 3.0 AND 3.9
) IC ON IC.ORDER_ID = I.ORDER_ID AND IC.INVOICE_ID = I.INVOICE_ID
WHERE IC.ITEMS = (
SELECT COUNT(*) FROM ITEMSORD IO
WHERE IO.ORDER_ID = I.ORDER_ID
AND IO.INVOICE_ID = I.INVOICE_ID
)
AND I.SHIPMETH_USED = 'First Class Mail'
</source>

=Related Articles=
*[[Compound Mail List Filters]]

EMV Cards

2015-07-13T19:07:45Z

Jmorrison: /* Will it work with my merchant account? */

Some background information on EMV cards, clarification on the industry's roll-out plans, requirements, and frequently asked questions.

=[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/what-is-emv/ What is EMV]=
The above title link is an informative article from our primary payment processing partner, Mercury Payment Systems (MPS). The cards are also referred to as "chip card" (because they have a chip embedded in the card) or NFC which is near field communications chip. Most new devices will have you insert the card chip first into a slot, instead of swiping the mag stripe, where others will use the NFC technology where you'd merely wave the chip over the reader.

=Why chips?=
The chip is used in lieu of the magnetic stripe to communicate the card number, expiration date, and name to the device you plug it into (no more swiping.) These chip cards are much more difficult to copy/duplicate. This technology used is prevalent worldwide (we're late to the game in the U.S.A.) and helps to reduce fraudulent "card-present" transactions. It offers no additional security for card use online or by phone (CNP - card not present transactions). It's worth noting that these cards still have a mag stripe on them to be used with traditional/current card swipe solutions since it is expected that it will take retailers a few years to implement chip card readers.

=Should I care?=
If you do all of your business by phone and/or online, no need to worry about the change. It is something you should consider if you have a retail store front or other scenario where you accept physical cards.

As a consumer you'll start receiving new chip cards from your credit card providers and be instructed on how to use them as merchants start adopting the hardware needed to process them.

=Do I have to accept EMV in my store?=
[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/ "U.S. merchants are not required to implement EMV by October 2015"]

Supporting EMV is not a requirement, see the link about or the following article from Visa:

*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp

Be aware that if you accept an EMV card by using its mag stripe instead, and the charge turns out to be fraudulent, you will be responsible for the fraudulent transaction costs.

=What about the PCI fines?!=
This is not about PCI, breaches or the crippling fines that go with them. If a fraudulent transaction occurs with an EMV card, the merchant is responsible for the cost of that fraudulent transaction. It appears to be the same as losing a chargeback dispute. It is not a data breach that would incur PCI fines. Here is an article from the PCI Council that explains their stance:

*https://www.pcisecuritystandards.org/news_events/quick_resources/increasing_security_with_emv_chip_and_pci.php

It does help to reduce fraudulent card-present transactions. While not a requirement, you may find it is worth the expense/effort to implement an EMV card reader.

There is an additional scenario where if the card was swiped in your store and then a duplicate card was created by someone obtaining the mag stripe data from your system, you would then also be liable for any transactions made with the duplicated card. CMS does not, however, store the mag stripe data (per our adherence to PA-DSS 3.1 regulations) so this should not be a concern for CMS users unless your mag stripe reader itself was replaced/spoofed.

=When or is it required?=
The first phase of the EMV roll-out is October 1, 2015 but even then it is not required. These articles confirm it is a liability shift, not a requirement:

*http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/
*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp
*http://www.mercurypay.com/article/emv-chip-card-technology

Our primary payment partner MPS just announced their EMV solution in April and we are a now researching how we can support it. The only solution for EMV is to integrate with one of their certified input devices. We can't say yet when we will be able to support EMV but it's possible/likely that it will not be by October.

=I want it already, what's the ETA?=
To clarify, these EMV readers are not just another input device to feed the card data to CMS for processing like the mag stripe readers have been. This is a new paradigm where the card reader device MUST handle the processing. As such each device must be individually certified (which is rigorous) and thus we expect to only offer support for a small number of devices. CMS will also have to be modified to support feeding transaction data to the device, have the device process the transaction, and CMS be updated with the results of that processing. This is not a trivial project and must be executed carefully to ensure a trouble-free and PCI compliant implementation. Bottom line, it's going to take some time.

=Will it work with my merchant account?=
Our only solution for EMV will be with MPS and some of their devices. If your merchant account is not with MPS, please contact us so we can arrange to have a quote prepared for you.

Again, this has no effect on card not present (CNP) transaction, only card-present.

If you were to assess the number of card present fraudulent charges you've received in the past and then further reduce that by the fraction of future charges that will be made with cards that are EMV (noting this liability doesn't apply to non-EMV cards), in most cases the resulting risk should be low. As explained in this article the corresponding liability risk should also be low.

=Any more good news?=
Indeed. The devices we're examining appear to also be conducive to working with other payment solutions like PIN Debit, ApplyPay and other NFC payment solutions.

EMV Cards

2015-07-13T19:04:08Z

Jmorrison: /* What about the PCI fines?! */

Some background information on EMV cards, clarification on the industry's roll-out plans, requirements, and frequently asked questions.

=[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/what-is-emv/ What is EMV]=
The above title link is an informative article from our primary payment processing partner, Mercury Payment Systems (MPS). The cards are also referred to as "chip card" (because they have a chip embedded in the card) or NFC which is near field communications chip. Most new devices will have you insert the card chip first into a slot, instead of swiping the mag stripe, where others will use the NFC technology where you'd merely wave the chip over the reader.

=Why chips?=
The chip is used in lieu of the magnetic stripe to communicate the card number, expiration date, and name to the device you plug it into (no more swiping.) These chip cards are much more difficult to copy/duplicate. This technology used is prevalent worldwide (we're late to the game in the U.S.A.) and helps to reduce fraudulent "card-present" transactions. It offers no additional security for card use online or by phone (CNP - card not present transactions). It's worth noting that these cards still have a mag stripe on them to be used with traditional/current card swipe solutions since it is expected that it will take retailers a few years to implement chip card readers.

=Should I care?=
If you do all of your business by phone and/or online, no need to worry about the change. It is something you should consider if you have a retail store front or other scenario where you accept physical cards.

As a consumer you'll start receiving new chip cards from your credit card providers and be instructed on how to use them as merchants start adopting the hardware needed to process them.

=Do I have to accept EMV in my store?=
[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/ "U.S. merchants are not required to implement EMV by October 2015"]

Supporting EMV is not a requirement, see the link about or the following article from Visa:

*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp

Be aware that if you accept an EMV card by using its mag stripe instead, and the charge turns out to be fraudulent, you will be responsible for the fraudulent transaction costs.

=What about the PCI fines?!=
This is not about PCI, breaches or the crippling fines that go with them. If a fraudulent transaction occurs with an EMV card, the merchant is responsible for the cost of that fraudulent transaction. It appears to be the same as losing a chargeback dispute. It is not a data breach that would incur PCI fines. Here is an article from the PCI Council that explains their stance:

*https://www.pcisecuritystandards.org/news_events/quick_resources/increasing_security_with_emv_chip_and_pci.php

It does help to reduce fraudulent card-present transactions. While not a requirement, you may find it is worth the expense/effort to implement an EMV card reader.

There is an additional scenario where if the card was swiped in your store and then a duplicate card was created by someone obtaining the mag stripe data from your system, you would then also be liable for any transactions made with the duplicated card. CMS does not, however, store the mag stripe data (per our adherence to PA-DSS 3.1 regulations) so this should not be a concern for CMS users unless your mag stripe reader itself was replaced/spoofed.

=When or is it required?=
The first phase of the EMV roll-out is October 1, 2015 but even then it is not required. These articles confirm it is a liability shift, not a requirement:

*http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/
*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp
*http://www.mercurypay.com/article/emv-chip-card-technology

Our primary payment partner MPS just announced their EMV solution in April and we are a now researching how we can support it. The only solution for EMV is to integrate with one of their certified input devices. We can't say yet when we will be able to support EMV but it's possible/likely that it will not be by October.

=I want it already, what's the ETA?=
To clarify, these EMV readers are not just another input device to feed the card data to CMS for processing like the mag stripe readers have been. This is a new paradigm where the card reader device MUST handle the processing. As such each device must be individually certified (which is rigorous) and thus we expect to only offer support for a small number of devices. CMS will also have to be modified to support feeding transaction data to the device, have the device process the transaction, and CMS be updated with the results of that processing. This is not a trivial project and must be executed carefully to ensure a trouble-free and PCI compliant implementation. Bottom line, it's going to take some time.

=Will it work with my merchant account?=
Our only solution for EMV will be with MPS and some of their devices. If your merchant account is not with MPS, please contact us so we can get arrange to have a quote prepared for you.

Again, this has no effect on card not present (CNP) transaction, only card-present.

If you were to assess the number of card present fraudulent charges you've received in the past, and then further reduce that by the fraction of future charges that will be made with cards that are EMV (noting this liability doesn't apply to non-EMV cards), in most cases the resulting risk should figure to be quite low. As explained in this article, the corresponding liability risk should also be quite low.

=Any more good news?=
Indeed. The devices we're examining appear to also be conducive to working with other payment solutions like PIN Debit, ApplyPay and other NFC payment solutions.

EMV Cards

2015-07-13T19:02:06Z

Jmorrison: /* Do I have to accept EMV in my store? */

Some background information on EMV cards, clarification on the industry's roll-out plans, requirements, and frequently asked questions.

=[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/what-is-emv/ What is EMV]=
The above title link is an informative article from our primary payment processing partner, Mercury Payment Systems (MPS). The cards are also referred to as "chip card" (because they have a chip embedded in the card) or NFC which is near field communications chip. Most new devices will have you insert the card chip first into a slot, instead of swiping the mag stripe, where others will use the NFC technology where you'd merely wave the chip over the reader.

=Why chips?=
The chip is used in lieu of the magnetic stripe to communicate the card number, expiration date, and name to the device you plug it into (no more swiping.) These chip cards are much more difficult to copy/duplicate. This technology used is prevalent worldwide (we're late to the game in the U.S.A.) and helps to reduce fraudulent "card-present" transactions. It offers no additional security for card use online or by phone (CNP - card not present transactions). It's worth noting that these cards still have a mag stripe on them to be used with traditional/current card swipe solutions since it is expected that it will take retailers a few years to implement chip card readers.

=Should I care?=
If you do all of your business by phone and/or online, no need to worry about the change. It is something you should consider if you have a retail store front or other scenario where you accept physical cards.

As a consumer you'll start receiving new chip cards from your credit card providers and be instructed on how to use them as merchants start adopting the hardware needed to process them.

=Do I have to accept EMV in my store?=
[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/ "U.S. merchants are not required to implement EMV by October 2015"]

Supporting EMV is not a requirement, see the link about or the following article from Visa:

*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp

Be aware that if you accept an EMV card by using its mag stripe instead, and the charge turns out to be fraudulent, you will be responsible for the fraudulent transaction costs.

=What about the PCI fines?!=
This is not about PCI, breaches or the crippling fines that go with them. If a fraudulent transaction occurs with an EMV card, the merchant is responsible for the cost of that fraudulent transaction. It appears to be the same as losing a chargeback dispute. It is not a data breach that would incur PCI fines. Here is an article from the PCI Council that explains their stance:

*https://www.pcisecuritystandards.org/news_events/quick_resources/increasing_security_with_emv_chip_and_pci.php

It does help to reduce fraudulent card-present transactions so, while not a requirement, you may find it is worth the expense/effort to implement an EMV card reader.

There is an additional scenario where if the card was swiped in your store and then a duplicate card was created by someone obtaining the mag stripe data from your system, you would then also be liable for any transactions made with the duplicated card. CMS does not, however, store the mag stripe data (per our adherence to PA-DSS 3.1 regulations) so this should not be a concern for CMS users unless your mag stripe reader itself was replaced/spoofed.

=When or is it required?=
The first phase of the EMV roll-out is October 1, 2015 but even then it is not required. These articles confirm it is a liability shift, not a requirement:

*http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/
*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp
*http://www.mercurypay.com/article/emv-chip-card-technology

Our primary payment partner MPS just announced their EMV solution in April and we are a now researching how we can support it. The only solution for EMV is to integrate with one of their certified input devices. We can't say yet when we will be able to support EMV but it's possible/likely that it will not be by October.

=I want it already, what's the ETA?=
To clarify, these EMV readers are not just another input device to feed the card data to CMS for processing like the mag stripe readers have been. This is a new paradigm where the card reader device MUST handle the processing. As such each device must be individually certified (which is rigorous) and thus we expect to only offer support for a small number of devices. CMS will also have to be modified to support feeding transaction data to the device, have the device process the transaction, and CMS be updated with the results of that processing. This is not a trivial project and must be executed carefully to ensure a trouble-free and PCI compliant implementation. Bottom line, it's going to take some time.

=Will it work with my merchant account?=
Our only solution for EMV will be with MPS and some of their devices. If your merchant account is not with MPS, please contact us so we can get arrange to have a quote prepared for you.

Again, this has no effect on card not present (CNP) transaction, only card-present.

If you were to assess the number of card present fraudulent charges you've received in the past, and then further reduce that by the fraction of future charges that will be made with cards that are EMV (noting this liability doesn't apply to non-EMV cards), in most cases the resulting risk should figure to be quite low. As explained in this article, the corresponding liability risk should also be quite low.

=Any more good news?=
Indeed. The devices we're examining appear to also be conducive to working with other payment solutions like PIN Debit, ApplyPay and other NFC payment solutions.

EMV Cards

2015-07-13T19:00:38Z

Jmorrison: /* Do I have to accept EMV in my store? */

Some background information on EMV cards, clarification on the industry's roll-out plans, requirements, and frequently asked questions.

=[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/what-is-emv/ What is EMV]=
The above title link is an informative article from our primary payment processing partner, Mercury Payment Systems (MPS). The cards are also referred to as "chip card" (because they have a chip embedded in the card) or NFC which is near field communications chip. Most new devices will have you insert the card chip first into a slot, instead of swiping the mag stripe, where others will use the NFC technology where you'd merely wave the chip over the reader.

=Why chips?=
The chip is used in lieu of the magnetic stripe to communicate the card number, expiration date, and name to the device you plug it into (no more swiping.) These chip cards are much more difficult to copy/duplicate. This technology used is prevalent worldwide (we're late to the game in the U.S.A.) and helps to reduce fraudulent "card-present" transactions. It offers no additional security for card use online or by phone (CNP - card not present transactions). It's worth noting that these cards still have a mag stripe on them to be used with traditional/current card swipe solutions since it is expected that it will take retailers a few years to implement chip card readers.

=Should I care?=
If you do all of your business by phone and/or online, no need to worry about the change. It is something you should consider if you have a retail store front or other scenario where you accept physical cards.

As a consumer you'll start receiving new chip cards from your credit card providers and be instructed on how to use them as merchants start adopting the hardware needed to process them.

=Do I have to accept EMV in my store?=
[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/ "U.S. merchants are not required to implement EMV by October 2015"]

Supporting EMV is not a requirement, see the link about or the following article from Visa:

*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp

The rub is that if you do not, and you accept an EMV card by using its mag stripe instead, and the charge turns out to be fraudulent, you will be responsible for the fraudulent transaction costs.

=What about the PCI fines?!=
This is not about PCI, breaches or the crippling fines that go with them. If a fraudulent transaction occurs with an EMV card, the merchant is responsible for the cost of that fraudulent transaction. It appears to be the same as losing a chargeback dispute. It is not a data breach that would incur PCI fines. Here is an article from the PCI Council that explains their stance:

*https://www.pcisecuritystandards.org/news_events/quick_resources/increasing_security_with_emv_chip_and_pci.php

It does help to reduce fraudulent card-present transactions so, while not a requirement, you may find it is worth the expense/effort to implement an EMV card reader.

There is an additional scenario where if the card was swiped in your store and then a duplicate card was created by someone obtaining the mag stripe data from your system, you would then also be liable for any transactions made with the duplicated card. CMS does not, however, store the mag stripe data (per our adherence to PA-DSS 3.1 regulations) so this should not be a concern for CMS users unless your mag stripe reader itself was replaced/spoofed.

=When or is it required?=
The first phase of the EMV roll-out is October 1, 2015 but even then it is not required. These articles confirm it is a liability shift, not a requirement:

*http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/
*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp
*http://www.mercurypay.com/article/emv-chip-card-technology

Our primary payment partner MPS just announced their EMV solution in April and we are a now researching how we can support it. The only solution for EMV is to integrate with one of their certified input devices. We can't say yet when we will be able to support EMV but it's possible/likely that it will not be by October.

=I want it already, what's the ETA?=
To clarify, these EMV readers are not just another input device to feed the card data to CMS for processing like the mag stripe readers have been. This is a new paradigm where the card reader device MUST handle the processing. As such each device must be individually certified (which is rigorous) and thus we expect to only offer support for a small number of devices. CMS will also have to be modified to support feeding transaction data to the device, have the device process the transaction, and CMS be updated with the results of that processing. This is not a trivial project and must be executed carefully to ensure a trouble-free and PCI compliant implementation. Bottom line, it's going to take some time.

=Will it work with my merchant account?=
Our only solution for EMV will be with MPS and some of their devices. If your merchant account is not with MPS, please contact us so we can get arrange to have a quote prepared for you.

Again, this has no effect on card not present (CNP) transaction, only card-present.

If you were to assess the number of card present fraudulent charges you've received in the past, and then further reduce that by the fraction of future charges that will be made with cards that are EMV (noting this liability doesn't apply to non-EMV cards), in most cases the resulting risk should figure to be quite low. As explained in this article, the corresponding liability risk should also be quite low.

=Any more good news?=
Indeed. The devices we're examining appear to also be conducive to working with other payment solutions like PIN Debit, ApplyPay and other NFC payment solutions.

EMV Cards

2015-07-13T18:59:03Z

Jmorrison: /* Why chips? */

Some background information on EMV cards, clarification on the industry's roll-out plans, requirements, and frequently asked questions.

=[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/what-is-emv/ What is EMV]=
The above title link is an informative article from our primary payment processing partner, Mercury Payment Systems (MPS). The cards are also referred to as "chip card" (because they have a chip embedded in the card) or NFC which is near field communications chip. Most new devices will have you insert the card chip first into a slot, instead of swiping the mag stripe, where others will use the NFC technology where you'd merely wave the chip over the reader.

=Why chips?=
The chip is used in lieu of the magnetic stripe to communicate the card number, expiration date, and name to the device you plug it into (no more swiping.) These chip cards are much more difficult to copy/duplicate. This technology used is prevalent worldwide (we're late to the game in the U.S.A.) and helps to reduce fraudulent "card-present" transactions. It offers no additional security for card use online or by phone (CNP - card not present transactions). It's worth noting that these cards still have a mag stripe on them to be used with traditional/current card swipe solutions since it is expected that it will take retailers a few years to implement chip card readers.

=Should I care?=
If you do all of your business by phone and/or online, no need to worry about the change. It is something you should consider if you have a retail store front or other scenario where you accept physical cards.

As a consumer you'll start receiving new chip cards from your credit card providers and be instructed on how to use them as merchants start adopting the hardware needed to process them.

=Do I have to accept EMV in my store?=
[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/ "EMV is not a mandate in October 2015"]

Supporting EMV is not a requirement, see the link about or the following article from Visa:

*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp

The rub is that if you do not, and you accept an EMV card by using its mag stripe instead, and the charge turns out to be fraudulent, you will be responsible for the fraudulent transaction costs.

=What about the PCI fines?!=
This is not about PCI, breaches or the crippling fines that go with them. If a fraudulent transaction occurs with an EMV card, the merchant is responsible for the cost of that fraudulent transaction. It appears to be the same as losing a chargeback dispute. It is not a data breach that would incur PCI fines. Here is an article from the PCI Council that explains their stance:

*https://www.pcisecuritystandards.org/news_events/quick_resources/increasing_security_with_emv_chip_and_pci.php

It does help to reduce fraudulent card-present transactions so, while not a requirement, you may find it is worth the expense/effort to implement an EMV card reader.

There is an additional scenario where if the card was swiped in your store and then a duplicate card was created by someone obtaining the mag stripe data from your system, you would then also be liable for any transactions made with the duplicated card. CMS does not, however, store the mag stripe data (per our adherence to PA-DSS 3.1 regulations) so this should not be a concern for CMS users unless your mag stripe reader itself was replaced/spoofed.

=When or is it required?=
The first phase of the EMV roll-out is October 1, 2015 but even then it is not required. These articles confirm it is a liability shift, not a requirement:

*http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/
*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp
*http://www.mercurypay.com/article/emv-chip-card-technology

Our primary payment partner MPS just announced their EMV solution in April and we are a now researching how we can support it. The only solution for EMV is to integrate with one of their certified input devices. We can't say yet when we will be able to support EMV but it's possible/likely that it will not be by October.

=I want it already, what's the ETA?=
To clarify, these EMV readers are not just another input device to feed the card data to CMS for processing like the mag stripe readers have been. This is a new paradigm where the card reader device MUST handle the processing. As such each device must be individually certified (which is rigorous) and thus we expect to only offer support for a small number of devices. CMS will also have to be modified to support feeding transaction data to the device, have the device process the transaction, and CMS be updated with the results of that processing. This is not a trivial project and must be executed carefully to ensure a trouble-free and PCI compliant implementation. Bottom line, it's going to take some time.

=Will it work with my merchant account?=
Our only solution for EMV will be with MPS and some of their devices. If your merchant account is not with MPS, please contact us so we can get arrange to have a quote prepared for you.

Again, this has no effect on card not present (CNP) transaction, only card-present.

If you were to assess the number of card present fraudulent charges you've received in the past, and then further reduce that by the fraction of future charges that will be made with cards that are EMV (noting this liability doesn't apply to non-EMV cards), in most cases the resulting risk should figure to be quite low. As explained in this article, the corresponding liability risk should also be quite low.

=Any more good news?=
Indeed. The devices we're examining appear to also be conducive to working with other payment solutions like PIN Debit, ApplyPay and other NFC payment solutions.

NewTestPage

2014-03-19T21:37:56Z

Jmorrison:

[[Category:Pending]]

NewTestPage

2014-03-19T21:37:35Z

Jmorrison:

[[Category:Pending]]
Should not create.

NewTestPage

2014-03-19T21:36:32Z

Jmorrison: Created page with 'Category:Something Should not create.'

[[Category:Something]]
Should not create.

Hold Until Date Analysis

2014-03-19T21:28:29Z

Jmorrison:

Analysis for the pre-processing (early fulfillment) of scheduled future shipping orders.

=Overview=
Companies with heavy seasonal business may be taking orders well in advance of the holiday and, when the holiday is close to arriving, the user finds themselves with the monumental task of shipping thousands of packages a day where they otherwise would normally process 100 or less. The request from these companies is the ability to prepare these shipments weeks in advance, when they are slower, in order to even out the workload.

=Current Challenges=
The only way to manage future shipments in CMS today is to use the future fulfill option (which we call future ship.) It really is, however, a delay of the fulfillment. When a future ship order is fulfilled early, it alters the fulfill date and CMS expects that you want it to ship today. There is also no current facility to communicate a future pickup date to UPS Worldship or to delay the sending of shipping confirmation emails since CMS creates these as soon as the invoice is set as shipped.

=Elements of the solution=
*Ability to schedule a shipment for the future
*Communicate the desired pick-up date to the carrier via shipping integrations (Worldship and Dazzle at minimum)
*Post-dating a future shipping date or delaying the setting of the shipped date so the shipped date reflects the date it will actually ship (pick-up date), not when the label is printed
*Update packages with tracking numbers when labels are printed and have some visibility into the state the order is in (labelled but not shipped, and corresponding controls/lock-downs)
*Post-dating shipping confirmation emails to match pick-up date (so post-dating is taking place on package and invoice)
*Way to see, set, and alter the date in the CMS Manifest
*Means of deciding which orders to release and when without losing the pickup date (date to ship)

=Concerns=
*Does CMS need to enforce or warn about carrier's delayed pickup date limitations when releasing a HUD order early?
**USPS only allows 7 days advance
**UPS allows 6 months advance
**FedEx - Freight must be today, Ground up to 14 days, Air services only can be delayed until next shipping day
*Some indication to the operator that this has been processed/labeled so they do not edit
*When is the payment processed? Any concern with authorization on release if shipping/capture occurs after the auth expires?
*For an order that is labeled but not shipped, what is the recourse for an operator to modify or return the order (i.e. customer calls to alter gift message after label printed)
*If we are allocating early to orders shipping in the future, there is a greater chance the item will not actually be on the shelf when it comes time to pick. Should any provision be made to explicitly handle this (removing the item from the order without restocking) or is it up to the user to simply do what they'd have to do today which is remove the item from the order and manually adjust stock (and contact the customer)?
*For items that have fixed availability (the primary impetus of wanting to allocate at the time of order) should they be set as discontinued to disallow back orders or do we need a new flag that doesn't set it as discontinued but also does not allow back ordering?

=Ideas for the Solution=
One possible way to handle these orders could be with a new Hold type called Hold Until Date (HUD) much like our [http://updates.newhavensoftware.com/v905release_notes.htm#link-1-1 Hold Until Complete] (HUC) feature. These would be manually placed on HUD (vs HUC which CMS can automatically-set). This gives us the following benefits:
*Exposure that the order is being held until a certain date
*Allocation for future ships
*Means of identifying and reporting on orders through FulfillMan>Holds
*No -2 fulfillment invoice
*Released from Hold Manager (does release change/update any dates on the order, invoice, package, payment, etc?)
*Integrations
**Mods to our XML integration to pass the pick-up date which we know to work
**Mods to UPSPackages to include the pick-up date for keyed imports (must be tested although we know Worldship can be set in a pick-up date mode so may not be needed)
**Endicia - TBD
**FedEx - Possibly not required for a phase 1 solution
*Like HUC, HUD would not allow for BO items, future ship items, or multiple invoices (or does it need to?)

=Analysis=
==Proof of Concept==
Ideas to test in special builds to help expose all needed aspects of the solution.
===Step 1 - Label <> Shipped===
In CMS disconnect any logic that would automatically set a shipped date based on the creation of a label or updating of a tracking number. We'll want to separate the two so a label can be generated without posting as shipped.
*How should this be automated? Possibly we set as shipped if label processed date <= date to ship otherwise leave to other mechanism to set as shipped (Unshipped, EoD update from Worldship, or ?)

===HUD===
Explore the "Hold Until Date" idea. Order could be a mix of HUC and HUD and could only fulfill if both were met. Possibly an HUC fulfillment would be allowed to occur but remain on HUD if the date has not been met. How then are HUD's released and how would we handle an early release so its original date could be retained for use in passing through to the shipping integrations for Pickup Date. Seems to require a new HUD tab in Fulfillment Manager. Like Future Ships, seems there should be an override option. Could future ships and HUD be merged and released from the same list (like we do for HUC) or should they remain separate?

==Use Cases==
List of user stories/cases to better understand what they are trying to accomplish and expected behavior:
==C.River==

===L.Orchards===

[[Category:Specs]]
[[Category:Published]]

Test page 2

2014-03-19T21:28:00Z

Jmorrison:

[[Category:Pending]]
This is more information related to nothing
Testing

Build A Product

2014-03-19T21:27:32Z

Jmorrison:

[[Category:Pending]]

"Build a Product" products are a way of allowing users to build their own product from a group of products you have chosen. In our example we will use a chocolate gift pack where the user can select four chocolate bars from a list of six.

==Setting up a Build A Product==

Setting up a build a product is the same as you would setup a normal product (Inventory >> All Products >> Add Product), except from the '''Product Type''' dropdown menu you will select '''Build a Product''' (see image below). Make sure you give your product a name, SKU, URL Name and a Full Description. Add any images and additional parameters and then from the bottom of the page select '''Save and Close'''. This will take you back to the All Products page.

[[Image:Build a product main.jpg]]

Exporting customer list from CMS

2014-03-19T21:18:40Z

Jmorrison:

[[Category:Published]]
The steps below outline how to export a list of customer names and e-mail addresses from CMS into a simple text file. This file is perfectly suited for importing into eCMS.

== Setting up the mail list export in CMS ==
# Click Customers->Mail List->Export from Mail List.
# Next to the Layout To Use drop-down box, click Setup.
## Give the layout a name.
## Immediately below, change the Record Separator to CR/LF.
## Change the Field Separator to a | character (the pipe: Shift-\).
## Click the Add Field button.
## Click the Field button just below, and select the First Name field.
## Repeat the 2 steps immediately above for the Last Name and Email Address fields.
## Click Save, then Close.
# Select your new layout from the drop-down.
# Choose a destination file named with a .txt extension.
# Next to the Use Filter drop-down box, click the triple-dot button.
## Give the filter a name.
## Select the criteria you'd like to use in this filter.
## Click Save, then Close.

== Running the mail list export ==
# Select your new layout and filter from the drop-down menus.
# Click Run Export.
# A popup will tell you how many records were exported, and the file location as a reminder.

Address Matching in CMS

2013-08-22T23:57:47Z

Jmorrison: /* Matching orders to existing customers during order import */

=Overview=
When an order or catalog request is imported into CMS, from any source, CMS must take steps to identify if this is a new or existing customer. If it is a new customer you'd want CMS to create a new customer record. On the other hand, if it is for an existing customer you'd want CMS to attach the order or catalog request to its matching/existing customer record and not create a duplicate customer.

This article explains the logic used by CMS uses when trying to determine that customer match during an import. A similar process is used to determine if the recipient (ship-to) is different from the buyer and this too is covered here.

=Matching orders to existing customers during order import=
All imported orders that are not imported with the [[Automated Imports Module]] option must go through a verification process (Fulfillment>Verify Imports) so you can ensure the imported order is one that should be converted into a real order. During that verification process you can tell if a customer match was found by looking at the Cust# field on the View Invoice screen (the first screen you are presented with when verifying an order.) If there is a number in this field you know CMS has matched it up to a customer in your mail list. If no match was found, the Cust# field will instead say "<new>".
The logic CMS uses to find such matches is as follows:
<ol>
<li>If a customer number was passed in the file, CMS will use that customer number to match against the customer number in CMS and will append to that customer. No further matching logic will be used. Most sources of orders will not be able to establish and/or pass the proper customer number so, while it will be considered the best match if present...it usually isn't.</li>
<li>The next matching will be done on email address (CMS 9.0 or later only and can be defeated with a setup option under Fulfillment Options>Import). CMS will match the order to a unique customer record it finds with the same email address. If more than one customer record is found with the same email address, no match will be made by email address. '''Note:''' in the XML only the <nowiki><Order><Customer><ContactAddress><Address><Email></nowiki> element is used for email address matching</li>
<li>If no customer number or email match it is then up to CMS to scrutinize the name and address to find a match. In this case CMS will match the last name and all of the numbers from the address and 5 digit zip code. (Note: this matching is done by comparing the customer's mailing address against the order's mailing/primary address, not billing or shipping.) Only when there is a perfect match will CMS link the imported order to a customer. The reason CMS uses numbers only for the address and only a last name is to ensure the match does not get tripped up by middle initials, misspellings, punctuation and abbreviations. Here is an example:</li>
</ol>

<blockquote>
William Smith 
123 Main Street Apt 3 
Evanston, IL 60202-1234 
 
will still match 
 
Bill P. Smith 
123 Main St. #3 
Evenston, IL 60202
</blockquote>

If you should find that CMS has matched up an order to the wrong customer or did not find a customer that it should have, during the verification of the order you can still go to the first screen on the order (Customer) and retrieve the proper customer there. Be warned that when retrieving a customer in this manner it will replace the billing and shipping addresses from the imported order with the default addresses from the retrieved customer record. We expect this behavior to change in the future so CMS will retain the addresses from the imported order or give you the option which to use.

=Multi-recipient and Gift orders=
CMS is capable of handling and importing orders with multiple recipients and/or gift orders (where the recipient is different than the buyer.) In either of the two scenarios the purchaser may or may not be receiving merchandise themselves. When importing such orders, CMS needs to determine if the recipient(s) is the same as the purchaser or if they should be treated as someone else. The reason for this is CMS will can (optionally) create new customer records for recipients and when printing invoices/pick-tickets CMS will suppress prices from showing so the recipient will not see what you paid.

This is logic used to determine if the recipient is the same as the buyer works in the following ways:
<ol>
<li>In our XML specification document (CMSxml.xsd) there is an attribute of the <Recipient> tag that reads 'IsPurchaser'. If the system that is generating the output for CMS to import is capable, our first recommendation would be to use this attribute. In use it looks like: <Recipient IsPurchaser="false"> In this example the value of 'false' is telling CMS that the recipient is not the same as the purchaser and as such should treat this as a gift order, even if there are no gift notes. If the purchaser is shipping to themselves, even at a different address, this value should be 'true'.</li>
<li>If any gift notes are present, CMS assumes the buyer is not sending themselves a gift and will make the order a gift order (multiple ship-to, in this case with just one recipient.)</li>
<li>If there are no gift notes and there is no 'IsPurchaser' attribute passed, CMS then has to determine if the recipient and purchaser are the same or not. In this case CMS is only using the last name. If the last name matches exactly, CMS will treat the recipient as if they are the purchaser, even if the addresses or any other information is different. While there are a few scenarios where this logic fails (parents shipping to their kid at college) it is the best CMS can do without having the information from 1 and 2 above. It does ensure though that the more common scenario of a person shipping to themselves at another address (work, vacation, etc.) will be handled correctly as a normal, non-gift type order.</li>
</ol>

Note: CMS uses an internal address_id to uniquely identify the recipient in an order. This means the same customer/recipient cannot appear more than once in the order but otherwise there is no reason why you cannot have two recipients with the same name (as long as they are different customers.) This has changed in CMS 9.0 where you can now have the same recipient on the order multiple times.

=Customer Duplicate Report=

Also worthy of note is the Customer Duplicate report used for finding possible duplicates. This report is found in the Reports menu under the category Customers. The logic this report uses is a bit different than CMS's and can be a good tool to find those that made it past CMS's logic. The most notable difference in logic is that it is matching on physical or email address, not by name.

Matches are on state, city, 5-digit zipcode, then first 10 digits of either the address3 line or Address1 line, depending on which has data.

This system has a lot of merit in that it is total independent of name spellings or most cases of address spellings (even St vs Street) since only the first 10 characters are considered. (UPDATE: As of CMS 8.0 this report now allows you to select how many characters to consider which allows you to control the level of sensitivity.) This system is really matching on the address vs the customer so if you had a husband and wife with diff names at the same address, you'd find them as a possible dupe match. This should prove to be a good tool to find duplicates that escaped CMS's customer matching (or dupes created by operators for non-imported orders.)

Alternate search terms - customer matching, order imports, order importing, name matching

CMS System Requirements

2012-02-10T19:55:51Z

Jmorrison: /* Workstations */

CMS 7.0 system requirements are fairly meager considering the capabilities of today's machines. As such, most anything you buy or even already own today will be more than adequate. You do, however, want to make sure you're meeting the following system requirements.

=64-bit vs 32-bit=
This option affects both your hardware and software. Many Windows operating systems are available in either a 32-bit or 64-bit version. Either will work with CMS and CMS's database server software - Sybase Adaptive Server Anywhere (aka iAnywheree). The 64-bit version does not offer any benefits to CMS over its 32-bit counterpart. Sybase, on the other hand, would stand to benefit to some degree from a 64-bit OS, at least in its support of additional RAM and caching. If you're looking at running Windows XP Pro, Vista or 2003 Server we'd recommend sticking with the 32-bit editions. If you're considering Windows 7 or 2008 Server you may opt for either the 32 or 64-bit editions. Be aware that Windows Server 2008 R2 is only available in 64-bit.

=Hardware=
==Servers==
This section applies to machines that are operating as pure servers or for stand-alone installations which are acting as both a server and workstation.

'''Minimum Requirements'''
* Pentium 4 - 1.8 GHz or faster CPU
* 1 Gigabyte RAM
* 20 GB Hard Drive with 2 GB available
* CD-ROM or CD-R/RW Drive
* SVGA Monitor

'''Database Server Additional Recommendations'''
#The best things you can do to improve the performance of your CMS server is maximize your RAM and purchase fast hard drives. The speed and number of processors has less to do with CMS performance than does I/O (disk read/write speed) and being able to cache some or all of the database into RAM. This should be your first goal when purchasing a new server or optimizing and existing server. Read more about [http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#What_is_.22database_caching.22.3F database caching] options below to make the most of your available RAM.
#Solid State Drives (SSD) can be an attractive option/addition to your server. They are essentially RAM and are extremely fast.
#Isolate your CMS database onto its own drive so it is not sharing a drive with your operating system or other server files.
#The CMS database server (Sybase) can make use of dual processors but, as a rule, processing speed does not play a huge role in performance. Consider this nice to have but not a necessity and lower in priority than the RAM and fast drive recommendations above.
#Fast network cards - Especially useful if you run a lot of reports from your workstations.
#[http://en.wikipedia.org/wiki/RAID RAID] 6 or other drive array. Priority of redundancy over striping if going with a different RAID configuration. Your server is at the heart of your company's operation and you need to make sure you can keep it going. Redundancy will help you sleep at night.
#Backups - While not a performance issue, this is an important consideration for a new server. You'll want to have an automated system in place to move the nightly CMS backup (must be turned on and configured) to other storage locations. Ideally you'd have a rolling backup routine that allows you to store backups for each night without overwriting the previous backups and then move the last backup of the week off-site (DVD, tape or online backup location). This way even if your place of business was in a natural disaster or your server was stolen, you would reasonably be able to recover. We unfortunately had a customer of ours go out of business because they were unable to recover when their server was lost in a fire. Protect yourself from the same fate.

'''Configuration'''

When running directly on a Windows server (2003 and up), CMS will not be able to make web service calls until the following configuration change is made. This can impact some CMS integrations so the following setting should be made on your server:

* '''Server 2003:''' Go into Control Panel->System->Advanced->Performance->Settings
* '''Server 2008:''' Go into Control Panel->System & Security->System->advanced System Settings->Performance->Settings
* Choose the Data Execution Prevention tab.

The default setting is Turn on DEP for all programs and services except those I select, and there is no reason to change it for CMS. However, you need to add CMS to the exception list, which will then allow CMS to communicate with web services.

==CMS workstations==
Workstations are those machines that are running CMS from a server on your network. If you are running CMS on only one machine or that machine is your server, please see the Server requirements above.

'''Minimum Requirements'''
* Pentium III 500 MHz or faster
* 1 GB RAM
* CD-ROM Drive
* 20GB Hard Drive with 2GB available
* SVGA Monitor
* 10Mbps Network Card(s) or faster

'''CMS Workstation Recommendations'''

Very little processing, disk space or hardware is required to run CMS on a workstation. Most everything takes place on the server so your workstation requirements are reasonably small. Our only recommendation beyond the minimums is to maximize your RAM and consider faster network cards.

==[http://en.wikipedia.org/wiki/Peripheral Peripherals]==
CMS will work with most any peripheral (e.g. printers) as long as the manufacture still supports it and offers drivers for your operating system. If the manufacture does not support your device and offer drivers for your operating system, NewHaven Software cannot assist you with it. It may work with CMS but, if not, you must upgrade your device to a currently supported model.

While this may seem like we're just washing our hands of supporting older hardware, there is really more to it. CMS, like most other Windows applications, relies on Windows to operate as an intermediary with its peripherals. In other words, CMS communicates to Windows and then Windows communicates with the peripheral. If Windows does not have a current driver, that communication may fail or operate in unexpected ways. In other words, any problems with the peripheral are outside of our software and control.

===[[POS Module]]===
The only place where CMS has more specific hardware requirements are the peripherals used with its POS Module. The Point of Sale Module only supports specific models of printers, cash drawers, credit card swipes and UPC bar code scanners.

*Printers - Star TSP143II or Samsung SRP-350
*[[Barcode Scanners]] - CMS requires USB serial emulation mode. If you are not purchasing these models through NewHaven Software, '''be sure that you are supplied with a proper cable to allow USB serial emulation'''.
**Honeywell (HandHeld) 3800G
**Metrologic Fusion MS3780
*Cash Drawer - APG 320 MultiPro or MMC 225151644204
*Credit card swipe/reader - Magtek model 21040102

Other hardware may work with CMS but these are the only models we have tested and can support or offer configuration instructions for. The credit card reader, however, is unlikely to work unless you have the specific model we have recommended.

NHS recommends [http://www.posworld.com/ POS World] for your POS hardware. Sharp people, great service, prices and support. Contact Rich King there and identify yourself as a CMS user and he will make sure you get the right equipment. rking@posworld.com , 1.888.801.7282 x678 , www.posworld.com

===Shipping Manifest===
*Barcode scanners - CMS supports the USB/serial scanners listed above under POS Module and also can work with any keyboard wedge style scanner albeit with reduced capability. Read this article on [[Barcode Scanners]] for more information.
*Scales - CMS will work with most any scale that connects via a serial connection and can emulate a Mettler Toledo (models 8213 or PS60) or the UPS Fairbanks scale. USB connections are supported in CMS 8.0 for the Toledo PS60 and PS90.
Other scanners or scales may work with CMS but these are the ones we support and can assist you with configuration.

=Operating Systems=
The following are operating systems currently supported by Microsoft and NewHaven Software for use with CMS.
==Servers==
*Windows Server 2003 SP2
**Server 2003 Editions supported - Standard, Small Business Server, Enterprise
*Windows Server 2008
**Server 2008 Editions supported - Standard, Small Business Server, Enterprise

==Workstations and CMS Solo==
*Windows XP Pro (must be SP3)
*Vista Business Edition SP2
*Vista Ultimate SP2
*7 Professional
*7 Ultimate

NOTE: Microsoft will end support for Windows 2000 Professional on July 13, 2010. Windows 2000 is also not compatible with CMS version 7.0. For more information please refer to the article [[Windows 2000 and CMS]]

=Remote Connections=
There are many options available to you when wanting to run CMS remotely. The core issue that must be observed is that CMS must be running on a machine that is connected locally to its database server. As long as that is true, you'll have no troubles running CMS remotely. You cannot, however, have CMS running locally on your workstation and connect to a remote server. The following are some remote access solutions and tips.

==Remote Access Software==
Software like LogMeIn and GoToMyPC are inexpensive remote access tools that allow you to connect to your PC via their website, thus from any other PC. Performance is a little slower than other solutions but is low cost, flexible and easy to use.

==[http://en.wikipedia.org/wiki/Remote_Desktop_Services Remote Desktop and Terminal Server]==
*Our preferred method is to use Windows built-in remote access options. Remote Desktop allows you to connect to your work machine with CMS on it and control it remotely. To do this you must first establish a virtual private network (VPN) connection.
*Terminal Services is also an option that will allow you to VPN into your server and create/run a remote session right on the server and without the need for a dedicated workstation. This is also a popular option but does require purchasing Windows client access licenses (CALs).

==Virtual Deployments==
We do not yet support running CMS on a virtual server but expect to announce our support for it some time in 2012. We are currently running several virtual machines here at NewHaven Software for our many test environments. We are also running our production environment on a virtual server (VMware). We hope to look at [http://en.wikipedia.org/wiki/Desktop_virtualization VDI] and Citrix XenServer/App in the future. We do have some CMS customers running live on a virtual server presently as well.

Early indications are that CMS and the database server will run with no particular technical issues although performance is not as good as running on a dedicated non-virtual server. Reinforcing what has been said above, lots or RAM and fast drives (read/write) are the biggest factors that impact CMS performance. We suspect that any recommendations we make for running CMS on a virtual server will revolve around ensuring that proper resources are dedicated to CMS.

If you think virtualization is in your future, please contact us for assistance in setting up a test environment. Keep us in the loop regarding your successes and failures so we can build a knowledge base here to share with other users.

Before deploying into production we of course strongly recommend testing. You'll want to validate that performance is acceptable and that all connectivity, including from peripherals, and all integrations are working and performing at acceptable levels.

==Cloud Computing==
While there are many appeals to moving to the cloud, there is still a great deal of uncertainty in how this will affect your PCI DSS compliance. It appears the PCI Council is currently wrestling with issues surrounding cloud and mobile computing so more information and regulation may be coming soon. We will be testing cloud computing alternatives to prepare but we will hold back recommending any such solutions until the PCI Council has announced their stance.

=FAQ's=
==Do I really need a new machine?==
Probably not. The operating system is far more important than your hardware. If your operating system is no longer supported, you may be able to update it or reinstall a current operating system on your current machine. Please consult Microsoft for their minimum requirements for the operating system your selecting. Generally if it meets Microsoft's requirements for their operating system, it will be good enough for CMS as well. From there, you need to decide if good enough is really good enough and that will be clear in the performance of Windows, CMS or other applications.

==My operating system is currently supported, do I need a new machine?==
Hardware is rarely an issue with CMS and you could be running old machines and still experience reasonable performance. If you're satisfied with the speed of CMS, you're able to run a supported operating system without errors, and you have adequate disk space, you may choose to continue to run on your existing machine(s).

If you were to do only one thing, it should be to max the amount of RAM your machine will take. RAM is cheap, too cheap to not have plenty of.

Secondarily, a CMS server needs a lot of disk space not just for its database but it may require additional free gigabytes of space for temp files that is creates and destroys through normal usage. You should never have less than 2Gig of free space on your server. If that is a problem, and you're not going to upgrade your server, at least move onto new hard drives. Here too, drive space is cheap these days.

There may be other compelling reasons to upgrade your machines, be it for speed, other applications or compatibility with other new technologies. New machines that are capable of running 64-bit operating systems, for example, are capable of handling more than 4 Gigabytes of RAM. While this would rarely be a CMS consideration for a workstation, if you have a database (.db file) that is larger than 2 Gig, you should seriously consider a server with more than 4G of RAM.

As a rule, the performance you need from CMS is merely a factor of hardware. As your company grows, CMS can scale perfectly well with you but may require improved hardware to keep up with the increased server load. Evaluating CPU/memory usage and free disk space during the heat of the day will give you an indication of how well your server is handling the load and if more resources are needed.

==Why can't I continue to use an older operating system?==
Even if has worked fine with CMS for years, if Microsoft no longer supports it, you really don't want to be using it. Once they stop offering security patches, as they just have stopped doing for Windows 2000, you become vulnerable to new threats (viruses, hacks, etc.) and you may find that CMS will no longer work. Such is the case with Windows 2000 as it does not contain the components need for CMS version 7.0 to run properly. [http://wiki.newhavensoftware.com/index.php/Windows_2000_and_CMS This link] provides more information on this subject.

PCI requirements also dictate that your systems must be kept up to date with current security patches.

==What is "database caching"?==
One of the great features of your CMS database is that it requires little to no maintenance. There is no re-indexing, server administration, etc. It largely just takes care of itself.

One thing you can do, however, to maximize your database performance is to use a setting for database caching. This option requires more RAM but RAM is cheap and the performance gains are worthwhile. With this option, you can force Windows to allocate a specific amount of RAM to your database to allows some or all of your database to be loaded into memory and thus can have significant affects on your server performance.

Limitations (applicable to v8 thru v12) are as follows:

*Maximum cache size for (Win32) Windows XP Home Edition, Windows XP Professional, Windows Server 2003 Web Edition, Windows Server 2003 Standard Edition, Windows 2008, Windows 7 - '''1.8 Gb'''

*Maximum cache size for (Win32) Windows Server 2003 Enterprise Edition, Windows Server 2003 Datacenter Edition, Windows Vista Ultimate, Windows Vista Enterprise, Windows Vista Business, Windows Vista Home Premium, Windows Vista Home Basic - '''2.7 Gb'''

*Maximum cache size (Win 64) limited by physical memory on 64-bit engines - ''NOTE: Our experience to date has shown that caching beyond 1.8G is not possible even with 64bit operating systems.''

Source - http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.sqlanywhere.12.0.0/dbadmin/da-limits.html

To update your cache size, you'll want to modify the registry key for the service (HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\ASANYs_NHSDataService\Parameters) like this:
-n NHSDataServer "C:\NewHaven Software\Data\Company\Company.db" -c 1800M -ti 0 -tl 0

The above is a cache of 1800 Meg (1.8 Gig.) K, M and G are recognizable increments and they must be in caps. It does not accept decimals however so if you want 1.5G you should do 1500M as shown in the above example. You can experiment with other or higher values but if the service doesn't start you may need to back your number down or revert to an earlier setting.

If you're interested in this option and have enough RAM, please contact NewHaven Technical Support for information on how to enable this option.

==What about my network?==
Our recommendations here are pretty generic. If you're still on the old 10mbps cards you should consider upgrading. 1Gbps is pretty standard these days. CMS doesn't need a lot of bandwidth but could benefit from 100mbps over 10mbps...depending on what other network traffic you might expect. If you have hubs or old switches, that would be a good place to look at upgrading.

==Will CMS work with wireless?==
Yes, although CMS must maintain a constant connection with its database and even momentary interruptions in that connection can be enough to cause errors. As such, we do not recommend running CMS over a wireless network connection. You can, however, use Remote Desktop via wireless to connect to a machine that is on your physical network and, in that scenario, you would not be subject to disconnect issues.

==Can I run CMS remotely?==
Yes, but it must be done using RDP (remote desktop), terminal services or remote access software like Logmein. CMS must be running on the same network/domain as its database server. You'll need to remote into Windows first and then run CMS from that machine. You cannot have CMS installed locally and connect to a remote network/server. See the section on [http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#Remote_Connections remote connections] above.

==Can NewHaven Software assist with purchasing or configuring my hardware/network?==
We can make recommendations, like we have in this article, but the actual purchase, configuration and maintenance of your hardware and network must be performed by someone at your location. This would either be done by someone on staff that is capable or a local contractor that can provide these services and expertise to you. We're happy to consult with your staff or contractors on any CMS related configurations.

Setting up CMS email through Exchange

2011-11-22T19:50:37Z

Jmorrison: Created page with 'To setup CMS email to work through Exchange follow the instructions below. #Bring up the Exchange server manager #Open Administrative groups #Open First administrative group …'

To setup CMS email to work through Exchange follow the instructions below.

#Bring up the Exchange server manager
#Open Administrative groups
#Open First administrative group
#Open Servers
#Open “your server name”
#Open Protocols
#Open SMTP
#Right click on Default SMTP Virtual Server
#Select Properties
#Select the Access tab
#Select Relay
#Select Add
#Add in the IP address of the CMS server

== CMS Emails from the workstations ==

With this in mind all workstations that need to relay through exchange will have to have their IPs added. In addition check for virus protection on the workstations, that may block port 25.

Exchange Server

2011-11-22T19:49:42Z

Jmorrison: Created page with '* Setting up CMS email through Exchange'

* [[Setting up CMS email through Exchange]]

CV3 Web Service Replication

2011-11-22T01:06:42Z

Jmorrison:

In order to create a web service that CMS can talk to, that mimics the CV3 web service, you must first accept the following methods into your web service:

*activate
*CMWebService
*accountCreate
*createAccount
*getAccount
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Web_Service_Replication#getStoresForAccount getStoresForAccount]'''
*createStore
*echoBase64Variation
*echoDate
*echoHexBinary
*echoDecimal
*echoBoolean
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Web_Service_Replication#downloadOrders downloadOrders]'''
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Web_Service_Replication#confirmOrdersReceived confirmOrdersReceived]'''
*importProducts
*exportProducts
*changePassword
*updateOrders 

You can compare this to the wsdl located here: [https://ecms.commercev3.com/services/serviceCV3.php?wsdl https://ecms.commercev3.com/services/serviceCV3.php?wsdl]

== About Responses ==

All responses are base64 encoded and look like this: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<getStoresForAccountResponse>
<return xsi:type="xsd:base64Binary">PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+Cgo8U3RvcmVzPgogICA8U3RvcmU+CiAgICAgIDxJRD4yMjI2PC9JRD4KICAgICAgPE5hbWU+Y21zVGVzdFN0b3JlPC9OYW1lPgogICA8L1N0b3JlPgogICA8U3RvcmU+CiAgICAgIDxJRD4yNTg1PC9JRD4KICAgICAgPE5hbWU+R2FtZXMgYnkgTWFpbDwvTmFtZT4KICAgPC9TdG9yZT4KPC9TdG9yZXM+Cg==</return>
</getStoresForAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source> All the responses below are only the encoded section which is a base64 encoded xml file.

The XML is expected to be in the CMS XML format. See the [[CMSxml.xsd]] for more info.

== getStoresForAccount ==

=== Sample Request ===

Here we send the auth info to get the store information (see the response example) <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:getStoresForAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<username xsi:type="xsd:string">cms_test_user</username>
<password xsi:type="xsd:string">password</password>
</soap:getStoresForAccount>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

You can see here an ID and Store Name are returned. CMS uses these to create the order source. At least one number and name combination are '''required'''. Though the name and number are arbitrary to what the customer would like to see displayed in CMS.  <source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>

<Stores>
<Store>
<ID>2226</ID>
<Name>TestStoreFirst</Name>
</Store>
<Store>
<ID>2585</ID>
<Name>TestStoreSecond</Name>
</Store>
</Stores>
</source>

== downloadOrders ==

=== Sample Request ===

<source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:downloadOrders soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<version xsi:type="xsd:string"></version>
</soap:downloadOrders>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<CMSData>
<Orders>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>52.85</OrderTotal>
<ItemTotal>57.85</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Discount>10.00</Discount>
<AdCode>XMAS11</AdCode>
<RefOrderID>Ex1-SizeDisc2</RefOrderID>
<Notes>Please do not substitute.</Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient>
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>L</SizeName>
<ColorName>Army Green</ColorName>
<OrderQuantity>2</OrderQuantity>
<UnitPrice>19.95</UnitPrice>
<TotalPrice>39.90</TotalPrice>
</Item>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>Small</SizeName>
<ColorName>Leather</ColorName>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>17.95</UnitPrice>
<TotalPrice>17.95</TotalPrice>
<ProductDescription>Our Finest Shirt</ProductDescription>
<CustomizationLine>Optional customization text, no limit on characters</CustomizationLine>
<SerialNumber>Optional serial number, any text up to 50 characters</SerialNumber>
<CustomizationUser1>Optional user-defined field/attribute up to 50 characters</CustomizationUser1>
<CustomizationUser2>Optional user-defined field/attribute up to 50 characters</CustomizationUser2>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>52.85</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>60.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>6.00</ShippingCharges>
<Adjustment>-5.00</Adjustment>
<AdCode>WEB123</AdCode>
<RefOrderID>Ex2-Ship2Wrk</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="true">
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company>The Schneid Corp</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>987 5th Ave Ste 311</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>LLGOSD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Finest product</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>60.95</PaymentAmount>
<PaymentType>MasterCard</PaymentType>
<PaymentName>Robert Schneider</PaymentName>
<CardInfo>
<AccountNumber>5432111111111111</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>63.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Adjustment>-1.00</Adjustment>
<AdCode>TVLGOS</AdCode>
<SalesPersonInitials>LUK</SalesPersonInitials>
<RefOrderID>Ex3GiftOrder</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>rrschneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="false">
<ShipToAddress>
<ContactName>
<FirstName>Jimmy</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Dean</LastName>
<Company>Farm Fresh Sausage, Link</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>123 Fryers Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>jdean@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>GLCCD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Next Finest kit</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage>Happy Birthday Jimmy!</GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>63.95</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2015-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>

<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
</Orders>
<CatalogRequests>
<CatalogRequest ID="123456781">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Alejandro</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Gallardo</LastName>
<Company>Unataki</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>3660 NW 114 Ave</AddressLine3>
<City>Miami</City>
<State>FL</State>
<PostalCode>33178</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>8005551212</PhoneNumDigits>
</PhoneNumber>
<Email>janrrot@example.com</Email>
<SourceCode>SPPS</SourceCode>
</Customer>
</CatalogRequest>
<CatalogRequest ID="1234567901">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Mark</FirstName>
<MiddleInitial>R</MiddleInitial>
<LastName>Freeze</LastName>
<Company>UFO</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>555 Schenker St</AddressLine3>
<City>Addison</City>
<State>IL</State>
<PostalCode>60101</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>9876543210</PhoneNumDigits>
</PhoneNumber>
<Email>mrfreeze@example.com</Email>
<SourceCode>SS4</SourceCode>
</Customer>
</CatalogRequest>
</CatalogRequests>
</CMSData>
</source>

== confirmOrdersReceived ==

=== Sample Request ===

Here we're sending a list of the orders that were successfully downloaded into CMS. The item list is the RefOrderID referenced in the downloadOrders response. <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<soap:confirmOrdersReceived soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<order_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]">
<item>17</item>
<item>18</item>
</order_ids>
<catalog_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]"/>
</soap:confirmOrdersReceived>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

This does not send xml back but a normal response is sent 1 being successful 0 something didn't go right with the confirmation: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<confirmOrdersReceivedResponse>
<return xsi:type="xsd:boolean">1</return>
</confirmOrdersReceivedResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source>

RubbishDump

2011-11-22T01:04:56Z

Jmorrison: moved RubbishDump to CV3 Web Service Replication over redirect

#REDIRECT [[CV3 Web Service Replication]]

CV3 Web Service Replication

2011-11-22T01:04:56Z

Jmorrison: moved RubbishDump to CV3 Web Service Replication over redirect

In order to create a web service that CMS can talk to, that mimics the CV3 web service, you must first accept the following methods into your web service:

*activate
*CMWebService
*accountCreate
*createAccount
*getAccount
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#getStoresForAccount getStoresForAccount]'''
*createStore
*echoBase64Variation
*echoDate
*echoHexBinary
*echoDecimal
*echoBoolean
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#downloadOrders downloadOrders]'''
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#confirmOrdersReceived confirmOrdersReceived]'''
*importProducts
*exportProducts
*changePassword
*updateOrders 

You can compare this to the wsdl located here: [https://ecms.commercev3.com/services/serviceCV3.php?wsdl https://ecms.commercev3.com/services/serviceCV3.php?wsdl]

== About Responses ==

All responses are base64 encoded and look like this: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<getStoresForAccountResponse>
<return xsi:type="xsd:base64Binary">PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+Cgo8U3RvcmVzPgogICA8U3RvcmU+CiAgICAgIDxJRD4yMjI2PC9JRD4KICAgICAgPE5hbWU+Y21zVGVzdFN0b3JlPC9OYW1lPgogICA8L1N0b3JlPgogICA8U3RvcmU+CiAgICAgIDxJRD4yNTg1PC9JRD4KICAgICAgPE5hbWU+R2FtZXMgYnkgTWFpbDwvTmFtZT4KICAgPC9TdG9yZT4KPC9TdG9yZXM+Cg==</return>
</getStoresForAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source> All the responses below are only the encoded section which is a base64 encoded xml file.

The XML is expected to be in the CMS XML format. See the [[CMSxml.xsd]] for more info.

== getStoresForAccount ==

=== Sample Request ===

Here we send the auth info to get the store information (see the response example) <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:getStoresForAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<username xsi:type="xsd:string">cms_test_user</username>
<password xsi:type="xsd:string">password</password>
</soap:getStoresForAccount>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

You can see here an ID and Store Name are returned. CMS uses these to create the order source. At least one number and name combination are '''required'''. Though the name and number are arbitrary to what the customer would like to see displayed in CMS.  <source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>

<Stores>
<Store>
<ID>2226</ID>
<Name>TestStoreFirst</Name>
</Store>
<Store>
<ID>2585</ID>
<Name>TestStoreSecond</Name>
</Store>
</Stores>
</source>

== downloadOrders ==

=== Sample Request ===

<source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:downloadOrders soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<version xsi:type="xsd:string"></version>
</soap:downloadOrders>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<CMSData>
<Orders>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>52.85</OrderTotal>
<ItemTotal>57.85</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Discount>10.00</Discount>
<AdCode>XMAS11</AdCode>
<RefOrderID>Ex1-SizeDisc2</RefOrderID>
<Notes>Please do not substitute.</Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient>
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>L</SizeName>
<ColorName>Army Green</ColorName>
<OrderQuantity>2</OrderQuantity>
<UnitPrice>19.95</UnitPrice>
<TotalPrice>39.90</TotalPrice>
</Item>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>Small</SizeName>
<ColorName>Leather</ColorName>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>17.95</UnitPrice>
<TotalPrice>17.95</TotalPrice>
<ProductDescription>Our Finest Shirt</ProductDescription>
<CustomizationLine>Optional customization text, no limit on characters</CustomizationLine>
<SerialNumber>Optional serial number, any text up to 50 characters</SerialNumber>
<CustomizationUser1>Optional user-defined field/attribute up to 50 characters</CustomizationUser1>
<CustomizationUser2>Optional user-defined field/attribute up to 50 characters</CustomizationUser2>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>52.85</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>60.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>6.00</ShippingCharges>
<Adjustment>-5.00</Adjustment>
<AdCode>WEB123</AdCode>
<RefOrderID>Ex2-Ship2Wrk</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="true">
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company>The Schneid Corp</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>987 5th Ave Ste 311</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>LLGOSD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Finest product</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>60.95</PaymentAmount>
<PaymentType>MasterCard</PaymentType>
<PaymentName>Robert Schneider</PaymentName>
<CardInfo>
<AccountNumber>5432111111111111</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>63.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Adjustment>-1.00</Adjustment>
<AdCode>TVLGOS</AdCode>
<SalesPersonInitials>LUK</SalesPersonInitials>
<RefOrderID>Ex3GiftOrder</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>rrschneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="false">
<ShipToAddress>
<ContactName>
<FirstName>Jimmy</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Dean</LastName>
<Company>Farm Fresh Sausage, Link</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>123 Fryers Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>jdean@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>GLCCD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Next Finest kit</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage>Happy Birthday Jimmy!</GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>63.95</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2015-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>

<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
</Orders>
<CatalogRequests>
<CatalogRequest ID="123456781">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Alejandro</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Gallardo</LastName>
<Company>Unataki</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>3660 NW 114 Ave</AddressLine3>
<City>Miami</City>
<State>FL</State>
<PostalCode>33178</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>8005551212</PhoneNumDigits>
</PhoneNumber>
<Email>janrrot@example.com</Email>
<SourceCode>SPPS</SourceCode>
</Customer>
</CatalogRequest>
<CatalogRequest ID="1234567901">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Mark</FirstName>
<MiddleInitial>R</MiddleInitial>
<LastName>Freeze</LastName>
<Company>UFO</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>555 Schenker St</AddressLine3>
<City>Addison</City>
<State>IL</State>
<PostalCode>60101</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>9876543210</PhoneNumDigits>
</PhoneNumber>
<Email>mrfreeze@example.com</Email>
<SourceCode>SS4</SourceCode>
</Customer>
</CatalogRequest>
</CatalogRequests>
</CMSData>
</source>

== confirmOrdersReceived ==

=== Sample Request ===

Here we're sending a list of the orders that were successfully downloaded into CMS. The item list is the RefOrderID referenced in the downloadOrders response. <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<soap:confirmOrdersReceived soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<order_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]">
<item>17</item>
<item>18</item>
</order_ids>
<catalog_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]"/>
</soap:confirmOrdersReceived>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

This does not send xml back but a normal response is sent 1 being successful 0 something didn't go right with the confirmation: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<confirmOrdersReceivedResponse>
<return xsi:type="xsd:boolean">1</return>
</confirmOrdersReceivedResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source>

CV3 Web Service Replication

2011-11-22T00:54:29Z

Jmorrison: moved CV3 Web Service Replication to RubbishDump

In order to create a web service that CMS can talk to, that mimics the CV3 web service, you must first accept the following methods into your web service:

*activate
*CMWebService
*accountCreate
*createAccount
*getAccount
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#getStoresForAccount getStoresForAccount]'''
*createStore
*echoBase64Variation
*echoDate
*echoHexBinary
*echoDecimal
*echoBoolean
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#downloadOrders downloadOrders]'''
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#confirmOrdersReceived confirmOrdersReceived]'''
*importProducts
*exportProducts
*changePassword
*updateOrders 

You can compare this to the wsdl located here: [https://ecms.commercev3.com/services/serviceCV3.php?wsdl https://ecms.commercev3.com/services/serviceCV3.php?wsdl]

== About Responses ==

All responses are base64 encoded and look like this: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<getStoresForAccountResponse>
<return xsi:type="xsd:base64Binary">PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+Cgo8U3RvcmVzPgogICA8U3RvcmU+CiAgICAgIDxJRD4yMjI2PC9JRD4KICAgICAgPE5hbWU+Y21zVGVzdFN0b3JlPC9OYW1lPgogICA8L1N0b3JlPgogICA8U3RvcmU+CiAgICAgIDxJRD4yNTg1PC9JRD4KICAgICAgPE5hbWU+R2FtZXMgYnkgTWFpbDwvTmFtZT4KICAgPC9TdG9yZT4KPC9TdG9yZXM+Cg==</return>
</getStoresForAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source> All the responses below are only the encoded section which is a base64 encoded xml file.

The XML is expected to be in the CMS XML format. See the [[CMSxml.xsd]] for more info.

== getStoresForAccount ==

=== Sample Request ===

Here we send the auth info to get the store information (see the response example) <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:getStoresForAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<username xsi:type="xsd:string">cms_test_user</username>
<password xsi:type="xsd:string">password</password>
</soap:getStoresForAccount>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

You can see here an ID and Store Name are returned. CMS uses these to create the order source. At least one number and name combination are '''required'''. Though the name and number are arbitrary to what the customer would like to see displayed in CMS.  <source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>

<Stores>
<Store>
<ID>2226</ID>
<Name>TestStoreFirst</Name>
</Store>
<Store>
<ID>2585</ID>
<Name>TestStoreSecond</Name>
</Store>
</Stores>
</source>

== downloadOrders ==

=== Sample Request ===

<source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:downloadOrders soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<version xsi:type="xsd:string"></version>
</soap:downloadOrders>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<CMSData>
<Orders>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>52.85</OrderTotal>
<ItemTotal>57.85</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Discount>10.00</Discount>
<AdCode>XMAS11</AdCode>
<RefOrderID>Ex1-SizeDisc2</RefOrderID>
<Notes>Please do not substitute.</Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient>
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>L</SizeName>
<ColorName>Army Green</ColorName>
<OrderQuantity>2</OrderQuantity>
<UnitPrice>19.95</UnitPrice>
<TotalPrice>39.90</TotalPrice>
</Item>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>Small</SizeName>
<ColorName>Leather</ColorName>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>17.95</UnitPrice>
<TotalPrice>17.95</TotalPrice>
<ProductDescription>Our Finest Shirt</ProductDescription>
<CustomizationLine>Optional customization text, no limit on characters</CustomizationLine>
<SerialNumber>Optional serial number, any text up to 50 characters</SerialNumber>
<CustomizationUser1>Optional user-defined field/attribute up to 50 characters</CustomizationUser1>
<CustomizationUser2>Optional user-defined field/attribute up to 50 characters</CustomizationUser2>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>52.85</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>60.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>6.00</ShippingCharges>
<Adjustment>-5.00</Adjustment>
<AdCode>WEB123</AdCode>
<RefOrderID>Ex2-Ship2Wrk</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="true">
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company>The Schneid Corp</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>987 5th Ave Ste 311</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>LLGOSD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Finest product</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>60.95</PaymentAmount>
<PaymentType>MasterCard</PaymentType>
<PaymentName>Robert Schneider</PaymentName>
<CardInfo>
<AccountNumber>5432111111111111</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>63.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Adjustment>-1.00</Adjustment>
<AdCode>TVLGOS</AdCode>
<SalesPersonInitials>LUK</SalesPersonInitials>
<RefOrderID>Ex3GiftOrder</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>rrschneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="false">
<ShipToAddress>
<ContactName>
<FirstName>Jimmy</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Dean</LastName>
<Company>Farm Fresh Sausage, Link</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>123 Fryers Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>jdean@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>GLCCD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Next Finest kit</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage>Happy Birthday Jimmy!</GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>63.95</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2015-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>

<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
</Orders>
<CatalogRequests>
<CatalogRequest ID="123456781">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Alejandro</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Gallardo</LastName>
<Company>Unataki</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>3660 NW 114 Ave</AddressLine3>
<City>Miami</City>
<State>FL</State>
<PostalCode>33178</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>8005551212</PhoneNumDigits>
</PhoneNumber>
<Email>janrrot@example.com</Email>
<SourceCode>SPPS</SourceCode>
</Customer>
</CatalogRequest>
<CatalogRequest ID="1234567901">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Mark</FirstName>
<MiddleInitial>R</MiddleInitial>
<LastName>Freeze</LastName>
<Company>UFO</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>555 Schenker St</AddressLine3>
<City>Addison</City>
<State>IL</State>
<PostalCode>60101</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>9876543210</PhoneNumDigits>
</PhoneNumber>
<Email>mrfreeze@example.com</Email>
<SourceCode>SS4</SourceCode>
</Customer>
</CatalogRequest>
</CatalogRequests>
</CMSData>
</source>

== confirmOrdersReceived ==

=== Sample Request ===

Here we're sending a list of the orders that were successfully downloaded into CMS. The item list is the RefOrderID referenced in the downloadOrders response. <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<soap:confirmOrdersReceived soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<order_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]">
<item>17</item>
<item>18</item>
</order_ids>
<catalog_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]"/>
</soap:confirmOrdersReceived>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

This does not send xml back but a normal response is sent 1 being successful 0 something didn't go right with the confirmation: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<confirmOrdersReceivedResponse>
<return xsi:type="xsd:boolean">1</return>
</confirmOrdersReceivedResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source>

CV3 Web Service Replication

2011-11-22T00:42:26Z

Jmorrison:

In order to create a web service that CMS can talk to, that mimics the CV3 web service, you must first accept the following methods into your web service:

*activate
*CMWebService
*accountCreate
*createAccount
*getAccount
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#getStoresForAccount getStoresForAccount]'''
*createStore
*echoBase64Variation
*echoDate
*echoHexBinary
*echoDecimal
*echoBoolean
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#downloadOrders downloadOrders]'''
*'''[http://wiki.newhavensoftware.com/index.php/CV3_Webservice_Replication#confirmOrdersReceived confirmOrdersReceived]'''
*importProducts
*exportProducts
*changePassword
*updateOrders 

You can compare this to the wsdl located here: [https://ecms.commercev3.com/services/serviceCV3.php?wsdl https://ecms.commercev3.com/services/serviceCV3.php?wsdl]

== About Responses ==

All responses are base64 encoded and look like this: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<getStoresForAccountResponse>
<return xsi:type="xsd:base64Binary">PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+Cgo8U3RvcmVzPgogICA8U3RvcmU+CiAgICAgIDxJRD4yMjI2PC9JRD4KICAgICAgPE5hbWU+Y21zVGVzdFN0b3JlPC9OYW1lPgogICA8L1N0b3JlPgogICA8U3RvcmU+CiAgICAgIDxJRD4yNTg1PC9JRD4KICAgICAgPE5hbWU+R2FtZXMgYnkgTWFpbDwvTmFtZT4KICAgPC9TdG9yZT4KPC9TdG9yZXM+Cg==</return>
</getStoresForAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source> All the responses below are only the encoded section which is a base64 encoded xml file.

The XML is expected to be in the CMS XML format. See the [[CMSxml.xsd]] for more info.

== getStoresForAccount ==

=== Sample Request ===

Here we send the auth info to get the store information (see the response example) <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:getStoresForAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<username xsi:type="xsd:string">cms_test_user</username>
<password xsi:type="xsd:string">password</password>
</soap:getStoresForAccount>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

You can see here an ID and Store Name are returned. CMS uses these to create the order source. At least one number and name combination are '''required'''. Though the name and number are arbitrary to what the customer would like to see displayed in CMS.  <source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>

<Stores>
<Store>
<ID>2226</ID>
<Name>TestStoreFirst</Name>
</Store>
<Store>
<ID>2585</ID>
<Name>TestStoreSecond</Name>
</Store>
</Stores>
</source>

== downloadOrders ==

=== Sample Request ===

<source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/">
<soapenv:Header/>
<soapenv:Body>
<soap:downloadOrders soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<version xsi:type="xsd:string"></version>
</soap:downloadOrders>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<CMSData>
<Orders>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>52.85</OrderTotal>
<ItemTotal>57.85</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Discount>10.00</Discount>
<AdCode>XMAS11</AdCode>
<RefOrderID>Ex1-SizeDisc2</RefOrderID>
<Notes>Please do not substitute.</Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient>
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>lschneider1@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>L</SizeName>
<ColorName>Army Green</ColorName>
<OrderQuantity>2</OrderQuantity>
<UnitPrice>19.95</UnitPrice>
<TotalPrice>39.90</TotalPrice>
</Item>
<Item>
<ProductCode>SHIRT123</ProductCode>
<SizeName>Small</SizeName>
<ColorName>Leather</ColorName>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>17.95</UnitPrice>
<TotalPrice>17.95</TotalPrice>
<ProductDescription>Our Finest Shirt</ProductDescription>
<CustomizationLine>Optional customization text, no limit on characters</CustomizationLine>
<SerialNumber>Optional serial number, any text up to 50 characters</SerialNumber>
<CustomizationUser1>Optional user-defined field/attribute up to 50 characters</CustomizationUser1>
<CustomizationUser2>Optional user-defined field/attribute up to 50 characters</CustomizationUser2>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>52.85</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>60.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>6.00</ShippingCharges>
<Adjustment>-5.00</Adjustment>
<AdCode>WEB123</AdCode>
<RefOrderID>Ex2-Ship2Wrk</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="true">
<ShipToAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company>The Schneid Corp</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>987 5th Ave Ste 311</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>schneider@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>LLGOSD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Finest product</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage></GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>60.95</PaymentAmount>
<PaymentType>MasterCard</PaymentType>
<PaymentName>Robert Schneider</PaymentName>
<CardInfo>
<AccountNumber>5432111111111111</AccountNumber>
<ExpirationDate>2014-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>
<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
<Order>
<OrderDate>2011-09-15T22:31:38</OrderDate>
<OrderTotal>63.95</OrderTotal>
<ItemTotal>59.95</ItemTotal>
<StateTaxes>0.00</StateTaxes>
<ShippingCharges>5.00</ShippingCharges>
<Adjustment>-1.00</Adjustment>
<AdCode>TVLGOS</AdCode>
<SalesPersonInitials>LUK</SalesPersonInitials>
<RefOrderID>Ex3GiftOrder</RefOrderID>
<Notes></Notes>
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Robert</FirstName>
<MiddleInitial>A</MiddleInitial>
<LastName>Schneider</LastName>
<Company></Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>3555 Willows Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>rrschneider@example.com</Email>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>2399459920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
</Customer>
<Recipient IsPurchaser="false">
<ShipToAddress>
<ContactName>
<FirstName>Jimmy</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Dean</LastName>
<Company>Farm Fresh Sausage, Link</Company>
<Title></Title>
</ContactName>
<Address>
<AddressLine3>123 Fryers Rd</AddressLine3>
<City>Cape Coral</City>
<State>FL</State>
<PostalCode>33904</PostalCode>
<CountryID>840</CountryID>
<Email>jdean@example.com</Email>
</Address>
</ShipToAddress>
<Item>
<ProductCode>GLCCD</ProductCode>
<OrderQuantity>1</OrderQuantity>
<UnitPrice>59.95</UnitPrice>
<TotalPrice>59.95</TotalPrice>
<ProductDescription>Our Next Finest kit</ProductDescription>
</Item>
<PhoneNumber>
<PhoneNumDigits>9325499920</PhoneNumDigits>
<PhoneNumberType>Home</PhoneNumberType>
</PhoneNumber>
<Package></Package>
<GiftMessage>Happy Birthday Jimmy!</GiftMessage>
</Recipient>
<Payment>
<PaymentAmount>63.95</PaymentAmount>
<PaymentType>Visa</PaymentType>
<PaymentName>Robert A Schneider</PaymentName>
<CardInfo>
<AccountNumber>4444444444444448</AccountNumber>
<ExpirationDate>2015-09</ExpirationDate>
<CardInfoFlags Captured="false" ECommerce="true"></CardInfoFlags>
<CVC>123</CVC>
</CardInfo>
<PaymentFlags></PaymentFlags>
</Payment>

<DefaultShipMethod IndexBy="Code">U</DefaultShipMethod>
<OrderFlags></OrderFlags>
</Order>
</Orders>
<CatalogRequests>
<CatalogRequest ID="123456781">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Alejandro</FirstName>
<MiddleInitial></MiddleInitial>
<LastName>Gallardo</LastName>
<Company>Unataki</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>3660 NW 114 Ave</AddressLine3>
<City>Miami</City>
<State>FL</State>
<PostalCode>33178</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>8005551212</PhoneNumDigits>
</PhoneNumber>
<Email>janrrot@example.com</Email>
<SourceCode>SPPS</SourceCode>
</Customer>
</CatalogRequest>
<CatalogRequest ID="1234567901">
<Customer>
<ContactAddress>
<ContactName>
<FirstName>Mark</FirstName>
<MiddleInitial>R</MiddleInitial>
<LastName>Freeze</LastName>
<Company>UFO</Company>
<Title>CEO</Title>
</ContactName>
<Address>
<AddressLine2></AddressLine2>
<AddressLine3>555 Schenker St</AddressLine3>
<City>Addison</City>
<State>IL</State>
<PostalCode>60101</PostalCode>
<CountryID>840</CountryID>
</Address>
</ContactAddress>
<PhoneNumber>
<PhoneNumDigits>9876543210</PhoneNumDigits>
</PhoneNumber>
<Email>mrfreeze@example.com</Email>
<SourceCode>SS4</SourceCode>
</Customer>
</CatalogRequest>
</CatalogRequests>
</CMSData>
</source>

== confirmOrdersReceived ==

=== Sample Request ===

Here we're sending a list of the orders that were successfully downloaded into CMS. The item list is the RefOrderID referenced in the downloadOrders response. <source lang="xml">
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soapinterop.org/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<soap:confirmOrdersReceived soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<store_id xsi:type="xsd:integer">2226</store_id>
<username xsi:type="xsd:string">cms_test</username>
<password xsi:type="xsd:string">testpass</password>
<order_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]">
<item>17</item>
<item>18</item>
</order_ids>
<catalog_ids xsi:type="soap:ArrayOfstring" soapenc:arrayType="xsd:string[]"/>
</soap:confirmOrdersReceived>
</soapenv:Body>
</soapenv:Envelope>
</source>

=== Sample Response ===

This does not send xml back but a normal response is sent 1 being successful 0 something didn't go right with the confirmation: <source lang="xml">
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:si="http://soapinterop.org/xsd">
<SOAP-ENV:Body>
<confirmOrdersReceivedResponse>
<return xsi:type="xsd:boolean">1</return>
</confirmOrdersReceivedResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</source>