Amazon Integration - Revision history

Sichen: /* Importing Amazon Orders */

2010-02-17T00:22:49Z

‎Importing Amazon Orders

Sichen: /* Publishing Products to Amazon */

2010-02-13T00:38:05Z

‎Publishing Products to Amazon

Sichen: /* Publishing Products to Amazon */

2009-03-16T17:02:10Z

‎Publishing Products to Amazon

Sichen: /* Introduction */

2009-01-30T01:53:02Z

‎Introduction

Sichen: /* Publishing Products to Amazon */

2009-01-30T01:52:08Z

‎Publishing Products to Amazon

Sichen: /* Basic Workflow */

2009-01-30T01:51:30Z

‎Basic Workflow

Sichen: /* Tax Amounts Import */

2009-01-30T01:42:09Z

‎Tax Amounts Import

Sichen: /* Tax Amounts Import */

2009-01-30T01:41:55Z

‎Tax Amounts Import

Sichen: /* Setting Up Amazon Integration */

2009-01-30T01:41:08Z

‎Setting Up Amazon Integration

Sichen at 23:35, 30 April 2008

2008-04-30T23:35:30Z

@@ Line 42: / Line 42: @@
 === Importing Amazon Orders ===
-Pending order documents are downloaded from Amazon and stored periodically into the AmazonOrderDocument entity.  The entire XML document of all the orders retrieved from each request to Amazon is stored in this entity.  An acknowledgment is then posted back to Amazon.
+To be able to import orders from Amazon, you must first have Amazon Merchant Services configure your account to generate order reports in XML instead of flat file format.
 Then, another service periodically extracts the XML document from AmazonOrderDocument into staging tables such as AmazonOrder, AmazonOrderItem, AmazonOrderItemPriceComp, etc.

@@ Line 26: / Line 26: @@
 === Publishing Products to Amazon ===
-Products with AmazonProduct records will be published to Amazon.  The publish products to Amazon service will periodically search your products for changes and write an XML file in <tt>runtime/output/</tt> directory in the format: Amazon***Feed_yy-mm-dd_hhmmss.xml.  It will then use the soap interface to contact Amazon to upload the XML file and store the processing document ID returned by Amazon in  the AmazonProduct entity.  If there were any issues with the upload, opentaps will sends you an e-mail.
+The <tt>AmazonProduct</tt> entity controls which products are published to Amazon and supplies additional attributes such as tax code, fulfillment terms, and search terms for Amazon.  If the Amazon component is enabled, an AmazonProduct is automatically created whenever you create or update your product, so that the product is scheduled for addition or updating on Amazon.  To publish the product successfully, though, your product must have a unique UPCA, which you can create in the catalog manager, and you need to go to the Amazon Integration application's Products tab and edit the Amazon Product record to set up its tax code.  The tax code is required for uploading products to Amazon.  (For testing try a tax code of "ABCD".)
 The Amazon integration component disallows the changing of the ASIN and SKU GoodIdentification numbers in the catalog manager.
 If you wish to remove a product from the Amazon upload, set a flag on the AmazonProduct entity.
 After the main product information from AmazonProduct has been uploaded, running the opentaps.amazon.checkAcknowledgementStatuses service will check if the Amazon document for the product has been acknowledged by Amazon.  Once the product has been acknowledged, then you can publish its inventory, price, and image information to Amazon.

@@ Line 26: / Line 26: @@
 === Publishing Products to Amazon ===
-Products with AmazonProduct records will be published to Amazon.  The publish products to Amazon service will periodically search your products for changes and write an XML file in <tt>runtime/output/</tt> directory in the format: Amazon***Feed_yy-mm-dd_hhmmss.xml.  It will then use the soap interface to contact Amazon to upload the XML file.  It will then e-mail you with the results of the upload.
+Products with AmazonProduct records will be published to Amazon.  The publish products to Amazon service will periodically search your products for changes and write an XML file in <tt>runtime/output/</tt> directory in the format: Amazon***Feed_yy-mm-dd_hhmmss.xml.  It will then use the soap interface to contact Amazon to upload the XML file and store the processing document ID returned by Amazon in  the AmazonProduct entity.  If there were any issues with the upload, opentaps will sends you an e-mail.
 The tax code is required for uploading products to Amazon.
@@ Line 32: / Line 32: @@
 The Amazon integration component disallows the changing of the ASIN and SKU GoodIdentification numbers in the catalog manager.
-If you wish to remove a product from the   Amazon upload, set a flag on the AmazonProduct entity.
+If you wish to remove a product from the Amazon upload, set a flag on the AmazonProduct entity.
 === Importing Amazon Orders ===

@@ Line 5: / Line 5: @@
 including product description, images, and prices to Amazon; download
 customers and orders from Amazon; and confirm the shipment of orders
-with Amazon so that Amazon can process payments for you.
+with Amazon so that Amazon can process payments for you.  To see how this works, see [[Amazon Tests]].
 == Setting Up Amazon Integration==

@@ Line 27: / Line 27: @@
 Products with AmazonProduct records will be published to Amazon.  The publish products to Amazon service will periodically search your products for changes and write an XML file in <tt>runtime/output/</tt> directory in the format: Amazon***Feed_yy-mm-dd_hhmmss.xml.  It will then use the soap interface to contact Amazon to upload the XML file.  It will then e-mail you with the results of the upload.
 The Amazon integration component disallows the changing of the ASIN and SKU GoodIdentification numbers in the catalog manager.
 === Importing Amazon Orders ===

@@ Line 24: / Line 24: @@
 == Basic Workflow ==
-* Product Importing
+=== Publishing Products to Amazon ===
-** The Amazon integration component disallows the changing of the ASIN and SKU GoodIdentification numbers in the catalog manager.
-** Outgoing XML feeds for product data posting are saved in the runtime/output directory in the format: Amazon***Feed_yy-mm-dd_hhmmss.xml
+Products with AmazonProduct records will be published to Amazon.  The publish products to Amazon service will periodically search your products for changes and write an XML file in <tt>runtime/output/</tt> directory in the format: Amazon***Feed_yy-mm-dd_hhmmss.xml.  It will then use the soap interface to contact Amazon to upload the XML file.  It will then e-mail you with the results of the upload.
-* Customer Matching
-** Amazon uses email address as the unique identifier of a customer.
+The Amazon integration component disallows the changing of the ASIN and SKU GoodIdentification numbers in the catalog manager.
-** Amazon sends phone numbers which are parsed with regex into separate area code and phone numbers
-** Amazon sends state and country codes which are matched against the Geo and GeoAssoc entities in opentaps.
+=== Importing Amazon Orders ===
-* Order Importing
-** Pending order documents are downloaded from Amazon and stored periodically (opentaps.amazon.storePendingOrderDocuments service)
+Pending order documents are downloaded from Amazon and stored periodically into the AmazonOrderDocument entity.  The entire XML document of all the orders retrieved from each request to Amazon is stored in this entity.  An acknowledgment is then posted back to Amazon.
-** Acknowledgement is posted to Amazon of downloaded order documents (opentaps.amazon.acknowledgeOrderDocumentDownload service)
-** Amazon orders are extracted from stored order documents (opentaps.amazon.extractOrdersForImport service)
+Then, another service periodically extracts the XML document from AmazonOrderDocument into staging tables such as AmazonOrder, AmazonOrderItem, AmazonOrderItemPriceComp, etc.
-** Extracted orders are imported into the Opentaps data model (opentaps.amazon.importOrders service)
-** Acknowledgement is posted to Amazon of imported orders (opentaps.amazon.acknowledgeImportedOrders service)
+Next, the import orders service imports the orders from Amazon to opentaps.  Orders which cannot be imported will be flagged as problem orders with their error messages.  And acknowledgment is sent back to Amazon of the orders that have been imported.
-** Acknowledgement is posted to Amazon of fulfilled (shipped) order items. This is accomplished by two independent services: opentaps.amazon.queueShippedItemsForFulfillmentPost, which is responsible for detecting shipment of order items related to Amazon orders (currently via an entity-ECA triggered by the update of a ShipmentRouteSegment.carrierServiceStatusId to SHRSCS_ACCEPTED) and queueing them for fulfillment acknowledgement; and opentaps.amazon.acknowledgeFulfilledOrderItems which posts the fulfillment acknowledgement to Amazon of any order items in the acknowledgement queue.
-** Posted acknowledgement documents are periodically checked for availability of their related processing report from Amazon. If the processing report becomes available it will be retrieved and the statuses of the related objects updated according to the information in the report.
+When you pack your orders, records are created in the AmazonOrderItemFulfillment table.  Another periodically schedule service will post the acknowledgement of the packed orders back to Amazon.
-** There are no execution dependencies - these steps will all run independently from one another by scheduled jobs and will operate on whatever data is available in the right condition at each runtime.
 == Tax Amounts Import ==

@@ Line 70: / Line 70: @@
 <AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="AMAZONCITYVALUE" taxJurisCounty="AMAZONCOUNTYVALUE" taxJurisState="AMAZONSTATEVALUE"
 taxAuthPartyId="CITYTAXAUTHPARTYID" taxAuthGeoId="CITYTAXAUTHGEOID" />
-<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="AMAZONSTATEVALUE"
+<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_"
 taxAuthPartyId="STATETAXAUTHPARTYID" taxAuthGeoId="STATETAXAUTHGEOID" />
 </pre>

@@ Line 52: / Line 52: @@
 <pre>
-<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="_NA_" taxAuthPartyId="YOURTAXAUTHPARTYID" taxAuthGeoId="YOURTAXAUTHGEOID" />
+<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="_NA_"
 </pre>
@@ Line 58: / Line 59: @@
 <pre>
-<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="WA" taxAuthPartyId="WA_TAXMAN" taxAuthGeoId="WA" />
+<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="WA"
-<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="NY" taxAuthPartyId="NY_DTF" taxAuthGeoId="NY" />
+taxAuthPartyId="WA_TAXMAN" taxAuthGeoId="WA" />
 </pre>
@@ Line 65: / Line 68: @@
 <pre>
-<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="AMAZONCITYVALUE" taxJurisCounty="AMAZONCOUNTYVALUE" taxJurisState="AMAZONSTATEVALUE" taxAuthPartyId="CITYTAXAUTHPARTYID" taxAuthGeoId="CITYTAXAUTHGEOID" />
+<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="AMAZONCITYVALUE" taxJurisCounty="AMAZONCOUNTYVALUE" taxJurisState="AMAZONSTATEVALUE"
-<AmazonOrderTaxJurisToAuth taxJurisDistrict="_NA_" taxJurisCity="_NA_" taxJurisCounty="_NA_" taxJurisState="AMAZONSTATEVALUE" taxAuthPartyId="STATETAXAUTHPARTYID" taxAuthGeoId="STATETAXAUTHGEOID" />
+taxAuthPartyId="CITYTAXAUTHPARTYID" taxAuthGeoId="CITYTAXAUTHGEOID" />
 </pre>

@@ Line 13: / Line 13: @@
 * Load the seed data in hot-deploy/amazon/data/AmazonSeedData.xml
 * Load the demo data in hot-deploy/amazon/data/AmazonDemoData.xml or use it as a guide to configure your own data
-* Configure the following properties in hot-deploy/amazon/config/amazon.properties (see below for descriptions of the properties):
+* Configure the following properties in hot-deploy/amazon/config/amazon.properties (see below for descriptions of the properties).  E-mail addresses are optional, but they are used for notifying you in case there are problems with your integration, so it is important to set them:
 ** opentaps.amazon.merchantIdentifier
 ** opentaps.amazon.merchantName
 ** opentaps.amazon.userName
 ** opentaps.amazon.password
-** opentaps.amazon.error.email.fromAddress (optional)
+** opentaps.amazon.error.email.fromAddress
-** opentaps.amazon.error.email.toAddress (optional)
+** opentaps.amazon.error.email.toAddress
-* If you plan to use Opentaps to schedule shipments with carriers, comment out the ShipmentRouteSegment eECA in hot-deploy/amazon/entitydef/eecas_amazon_orders.xml and uncomment the completePack sECA in hot-deploy/amazon/servicedef/secas_amazon_orders.xml. This will ensure that the tracking numbers returned by the carrier are correctly posted to Amazon.
+* If you plan to use Opentaps to schedule shipments with carriers, comment out the ShipmentRouteSegment eECA in <tt>hot-deploy/amazon/entitydef/eecas_amazon_orders.xml</tt> and uncomment the completePack sECA in <tt>hot-deploy/amazon/servicedef/secas_amazon_orders.xml</tt>. This will ensure that the tracking numbers returned by the carrier are correctly posted to Amazon.
 == Basic Workflow ==

← Older revision		Revision as of 23:35, 30 April 2008
Line 1:		Line 1:
		+	== Introduction ==
		+
		+	The opentaps Amazon component is designed to help you sell your
		+	products as an Amazon merchant. It will upload your product catalog,
		+	including product description, images, and prices to Amazon; download
		+	customers and orders from Amazon; and confirm the shipment of orders
		+	with Amazon so that Amazon can process payments for you.
		+
	== Setting Up Amazon Integration==		== Setting Up Amazon Integration==