360Works Amazon MWS Plugin/Documentation

From 360Works Product Documentation Wiki
(Difference between revisions)
Jump to: navigation, search
m (Auto-upload documentation)
m (Auto-upload documentation)
 
Line 1: Line 1:
 
=360Works Amazon MWS Plugin User Guide=
 
=360Works Amazon MWS Plugin User Guide=
−
 
+
Provides integration with Amazon Merchant Web Services. Read more at <a href="https://developer.amazonservices.com/">https://developer.amazonservices.com/</a>.
  
  
Line 9: Line 9:
 
=Function Summary=
 
=Function Summary=
 
<div id="toc">
 
<div id="toc">
−
*[[#AmazonGetLowPrice|AmazonGetLowPrice]] ( sku [ ; condition=x ; fulfillmentChannel=Amazon ; ... ] ) &mdash; return the lowest price for a particular SKU and condition.
+
*[[#AmazonGetLowPrice|AmazonGetLowPrice]] ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) &mdash; return the lowest price for a particular SKU and condition.
 +
*[[#AmazonGetLowPriceAndShipping|AmazonGetLowPriceAndShipping]] ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) &mdash; return the lowest price for a particular SKU and condition.
 +
*[[#AmazonGetLowPriceByASIN|AmazonGetLowPriceByASIN]] ( ASIN { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) &mdash; return the lowest price for a particular ASIN and condition.
 
*[[#AmazonGetMyPrice|AmazonGetMyPrice]] ( sku ) &mdash; Return pricing information for user's own listing.
 
*[[#AmazonGetMyPrice|AmazonGetMyPrice]] ( sku ) &mdash; Return pricing information for user's own listing.
 
*[[#AmazonGetOrderItemValue|AmazonGetOrderItemValue]] ( orderId ; orderItemId ; property ) &mdash; Fetch a single attribute for an order item.
 
*[[#AmazonGetOrderItemValue|AmazonGetOrderItemValue]] ( orderId ; orderItemId ; property ) &mdash; Fetch a single attribute for an order item.
 
*[[#AmazonGetOrders|AmazonGetOrders]] ( lastUpdatedAfter ; lastUpdatedBefore ) &mdash; Fetch a list of orderIds which were modified within a date range.
 
*[[#AmazonGetOrders|AmazonGetOrders]] ( lastUpdatedAfter ; lastUpdatedBefore ) &mdash; Fetch a list of orderIds which were modified within a date range.
 
*[[#AmazonGetOrderValue|AmazonGetOrderValue]] ( orderId ; property ) &mdash; Fetch a single attribute for an order.
 
*[[#AmazonGetOrderValue|AmazonGetOrderValue]] ( orderId ; property ) &mdash; Fetch a single attribute for an order.
−
*[[#AmazonLastError|AmazonLastError]] (  ) &mdash;  
+
*[[#AmazonLastError|AmazonLastError]] (  ) &mdash; Returns the last Plugin-related error which occurred.
−
*[[#AmazonLicenseInfo|AmazonLicenseInfo]] (  ) &mdash;  
+
*[[#AmazonLicenseInfo|AmazonLicenseInfo]] (  ) &mdash; Returns some information about the license, if there is one.
−
*[[#AmazonRegister|AmazonRegister]] ( licenseKey ; registeredTo ) &mdash;  
+
*[[#AmazonLookupASIN|AmazonLookupASIN]] ( value { ; "searchBy=ISBN" ; ... } ) &mdash; Looks up an Amazon ASIN by ISBN.
−
*[[#AmazonSetErrorCapture|AmazonSetErrorCapture]] ( errorCapture ) &mdash; Toggles error dialogs on or off.
+
−
*[[#AmazonSetup|AmazonSetup]] ( sellerId ; accessKeyId ; secretAccessKey ; marketplaceId ) &mdash;
+
 
*[[#AmazonUpdateShipments|AmazonUpdateShipments]] ( file ) &mdash; Post a tab separated list to update the fulfillment status of SKUs.
 
*[[#AmazonUpdateShipments|AmazonUpdateShipments]] ( file ) &mdash; Post a tab separated list to update the fulfillment status of SKUs.
 
*[[#AmazonUploadInventory|AmazonUploadInventory]] ( file ) &mdash; Upload a tab-separated file of inventory items.
 
*[[#AmazonUploadInventory|AmazonUploadInventory]] ( file ) &mdash; Upload a tab-separated file of inventory items.
−
*[[#AmazonVersion|AmazonVersion]] (  ) &mdash;  
+
*[[#AmazonVersion|AmazonVersion]] (  ) &mdash; Returns the string portion of the version number that is returned by {@link #getVersion() }.
 
</div>
 
</div>
 
=Function Detail=
 
=Function Detail=
 
<div id="AmazonGetLowPrice"></div>
 
<div id="AmazonGetLowPrice"></div>
−
==AmazonGetLowPrice ( sku [ ; condition=x ; fulfillmentChannel=Amazon ; ... ] ) ==
+
==AmazonGetLowPrice ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) ==
 
return the lowest price for a particular SKU and condition. Sample usage:
 
return the lowest price for a particular SKU and condition. Sample usage:
  
Line 34: Line 34:
 
<dl></dl></div>
 
<dl></dl></div>
 
<div class="see"><strong>Returns:</strong>  
 
<div class="see"><strong>Returns:</strong>  
 +
</div>
 +
 +
<div id="AmazonGetLowPriceAndShipping"></div>
 +
==AmazonGetLowPriceAndShipping ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) ==
 +
return the lowest price for a particular SKU and condition. Sample usage:
 +
 +
AmazonGetLowPrice("my_sku" ; "condition=New" ; "fulfillmentChannel=Amazon" )
 +
 +
 +
<div class="parameters"><strong>Parameters:</strong>
 +
<dl></dl></div>
 +
<div class="see"><strong>Returns:</strong>
 +
</div>
 +
 +
<div id="AmazonGetLowPriceByASIN"></div>
 +
==AmazonGetLowPriceByASIN ( ASIN { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) ==
 +
return the lowest price for a particular ASIN and condition. Sample usage:
 +
 +
AmazonGetLowPriceByASIN("amazon_isbn" ; "condition=New" ; "fulfillmentChannel=Amazon" )
 +
 +
 +
<div class="parameters"><strong>Parameters:</strong>
 +
<dl></dl></div>
 +
<div class="see"><strong>See also:</strong>  [[#AmazonLookupASIN|AmazonLookupASIN]]
 +
</div><div class="see"><strong>Returns:</strong>
 
</div>
 
</div>
  
Line 41: Line 66:
  
 
<div class="parameters"><strong>Parameters:</strong>
 
<div class="parameters"><strong>Parameters:</strong>
−
<dl><dt><code>sku</code> <dd>
+
<dl><dt><code>sku</code> <dd>The SKU of the product
 
</dl></div>
 
</dl></div>
−
<div class="see"><strong>Returns:</strong>  
+
<div class="see"><strong>Returns:</strong> The price of the item
 
</div>
 
</div>
  
Line 87: Line 112:
 
<div id="AmazonLastError"></div>
 
<div id="AmazonLastError"></div>
 
==AmazonLastError (  ) ==
 
==AmazonLastError (  ) ==
 +
Returns the last Plugin-related error which occurred.
 +
This should be called any time that a plugin function returns "ERROR" to get a user-readable description of the error.
  
−
 
+
<div class="see"><strong>Returns:</strong> Error text, or <code>""</code> if there was no error.
−
 
+
</div>
  
 
<div id="AmazonLicenseInfo"></div>
 
<div id="AmazonLicenseInfo"></div>
 
==AmazonLicenseInfo (  ) ==
 
==AmazonLicenseInfo (  ) ==
 +
Returns some information about the license, if there is one.  Otherwise returns *UNLICENSED* message.
  
 +
<div class="see"><strong>Returns:</strong> license info
 +
</div>
  
−
 
+
<div id="AmazonLookupASIN"></div>
−
 
+
==AmazonLookupASIN ( value { ; "searchBy=ISBN" ; ... } ) ==
−
<div id="AmazonRegister"></div>
+
Looks up an Amazon ASIN by ISBN.
−
==AmazonRegister ( licenseKey ; registeredTo ) ==
+
<h3>Optional Parameters</h3>
−
 
+
<dl>
 +
<dt>searchBy
 +
<dd>One of: ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN
 +
</dl>
  
 
<div class="parameters"><strong>Parameters:</strong>
 
<div class="parameters"><strong>Parameters:</strong>
−
<dl></dl></div>
+
<dl><dt><code>value</code> <dd>ISBN or plain-text search.
−
 
+
−
 
+
−
<div id="AmazonSetErrorCapture"></div>
+
−
==AmazonSetErrorCapture ( errorCapture ) ==
+
−
Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call <code>SMSetErrorCapture</code> with a parameter of <code>true</code>. That will suppress the error dialog from appearing to the user.
+
−
 
+
−
<div class="parameters"><strong>Parameters:</strong>
+
−
<dl><dt><code>errorCapture</code> <dd>set to true to suppress the default popups.
+
 
</dl></div>
 
</dl></div>
−
 
+
<div class="see"><strong>Returns:</strong>  
−
 
+
</div>
−
<div id="AmazonSetup"></div>
+
−
==AmazonSetup ( sellerId ; accessKeyId ; secretAccessKey ; marketplaceId ) ==
+
−
 
+
−
 
+
−
<div class="parameters"><strong>Parameters:</strong>
+
−
<dl></dl></div>
+
−
 
+
  
 
<div id="AmazonUpdateShipments"></div>
 
<div id="AmazonUpdateShipments"></div>
Line 126: Line 144:
 
Post a tab separated list to update the fulfillment status of SKUs.
 
Post a tab separated list to update the fulfillment status of SKUs.
 
A template file for upload can be found [https://sellercentral.amazon.com/gp/help/help.html?ie=UTF8&itemID=13461&language=en_US&ref_=ag_13461_bred_1641 here], on the <strong>Shipping Confirmation Template</strong>
 
A template file for upload can be found [https://sellercentral.amazon.com/gp/help/help.html?ie=UTF8&itemID=13461&language=en_US&ref_=ag_13461_bred_1641 here], on the <strong>Shipping Confirmation Template</strong>
−
link.
+
link.
 
As with updating inventory, Amazon recommends making this call less frequently with larger posts.
 
As with updating inventory, Amazon recommends making this call less frequently with larger posts.
 
After uploading, you can check the status of your upload at [https://sellercentral.amazon.com/gp/transactions/uploadShippingConfirmation.html https://sellercentral.amazon.com/gp/transactions/uploadShippingConfirmation.html]
 
After uploading, you can check the status of your upload at [https://sellercentral.amazon.com/gp/transactions/uploadShippingConfirmation.html https://sellercentral.amazon.com/gp/transactions/uploadShippingConfirmation.html]
Line 155: Line 173:
 
<div id="AmazonVersion"></div>
 
<div id="AmazonVersion"></div>
 
==AmazonVersion (  ) ==
 
==AmazonVersion (  ) ==
 +
Returns the string portion of the version number that is returned by [[#getVersion|getVersion]].

Latest revision as of 18:28, 26 June 2017

Contents

[edit] 360Works Amazon MWS Plugin User Guide

Provides integration with Amazon Merchant Web Services. Read more at <a href="https://developer.amazonservices.com/">https://developer.amazonservices.com/</a>.


[edit] 360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

[edit] Function Summary

  • AmazonGetLowPrice ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) — return the lowest price for a particular SKU and condition.
  • AmazonGetLowPriceAndShipping ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) — return the lowest price for a particular SKU and condition.
  • AmazonGetLowPriceByASIN ( ASIN { ; condition=x ; fulfillmentChannel=Amazon ; ... } ) — return the lowest price for a particular ASIN and condition.
  • AmazonGetMyPrice ( sku ) — Return pricing information for user's own listing.
  • AmazonGetOrderItemValue ( orderId ; orderItemId ; property ) — Fetch a single attribute for an order item.
  • AmazonGetOrders ( lastUpdatedAfter ; lastUpdatedBefore ) — Fetch a list of orderIds which were modified within a date range.
  • AmazonGetOrderValue ( orderId ; property ) — Fetch a single attribute for an order.
  • AmazonLastError ( ) — Returns the last Plugin-related error which occurred.
  • AmazonLicenseInfo ( ) — Returns some information about the license, if there is one.
  • AmazonLookupASIN ( value { ; "searchBy=ISBN" ; ... } ) — Looks up an Amazon ASIN by ISBN.
  • AmazonUpdateShipments ( file ) — Post a tab separated list to update the fulfillment status of SKUs.
  • AmazonUploadInventory ( file ) — Upload a tab-separated file of inventory items.
  • AmazonVersion ( ) — Returns the string portion of the version number that is returned by {@link #getVersion() }.

[edit] Function Detail

[edit] AmazonGetLowPrice ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } )

return the lowest price for a particular SKU and condition. Sample usage: 

AmazonGetLowPrice("my_sku" ; "condition=New" ; "fulfillmentChannel=Amazon" )


Parameters:
Returns:

[edit] AmazonGetLowPriceAndShipping ( sku { ; condition=x ; fulfillmentChannel=Amazon ; ... } )

return the lowest price for a particular SKU and condition. Sample usage: 

AmazonGetLowPrice("my_sku" ; "condition=New" ; "fulfillmentChannel=Amazon" )


Parameters:
Returns:

[edit] AmazonGetLowPriceByASIN ( ASIN { ; condition=x ; fulfillmentChannel=Amazon ; ... } )

return the lowest price for a particular ASIN and condition. Sample usage: 

AmazonGetLowPriceByASIN("amazon_isbn" ; "condition=New" ; "fulfillmentChannel=Amazon" )


Parameters:
See also: AmazonLookupASIN
Returns:

[edit] AmazonGetMyPrice ( sku )

Return pricing information for user's own listing.

Parameters:

sku
The SKU of the product

Returns: The price of the item

[edit] AmazonGetOrderItemValue ( orderId ; orderItemId ; property )

Fetch a single attribute for an order item.

Parameters:

orderId
The order ID to fetch the items from.
orderItemId
The order item ID to fetch the attribute from. This must be the id of an item in the order specified by orderId.
property
One of: asin, sellerSKU, orderItemId, title, quantityOrdered, quantityShipped, itemPrice, shippingPrice, giftWrapPrice, itemTax, shippingTax, giftWrapTax, shippingDiscount, promotionDiscount, promotionIds, codFee, codFeeDiscount, giftMessageText, giftWrapLevel, invoiceData<code> </dl></div>

Returns: The value of the requested property in the specifed order item.

[edit] AmazonGetOrders ( lastUpdatedAfter ; lastUpdatedBefore )

Fetch a list of orderIds which were modified within a date range.

Parameters:

<code>lastUpdatedAfter</code>
the minimum modification timestamp to return orders from.
<code>lastUpdatedBefore</code>
the maximum modification timestamp to return orders from.

Returns: Return-separated list of matching orderIds

[edit] AmazonGetOrderValue ( orderId ; property )

Fetch a single attribute for an order.

<code>ShippingAddress, BuyerName, and BuyerEmail are only returned when the OrderStatus is shipped or partially shipped, or the item is Unshipped and fulfilled by seller.

ItemIds requires a round-trip to the server to fetch the order items.


Parameters:

orderId
The order ID to fetch. Fetching the same order ID twice in a row will not make a round trip to Amazon's server.
property
One of: OrderId, OrderStatus, FulfillmentChannel, LastUpdateDate, ShippingAddress, shipService, shipServiceLevel, BuyerName, BuyerEmail, or ItemIds

Returns: The value of the requested property in the specified Order. For ShippingAddress, XML is returned.

[edit] AmazonLastError ( )

Returns the last Plugin-related error which occurred. This should be called any time that a plugin function returns "ERROR" to get a user-readable description of the error.

Returns: Error text, or "" if there was no error.

[edit] AmazonLicenseInfo ( )

Returns some information about the license, if there is one. Otherwise returns *UNLICENSED* message.

Returns: license info

[edit] AmazonLookupASIN ( value { ; "searchBy=ISBN" ; ... } )

Looks up an Amazon ASIN by ISBN.

Optional Parameters

searchBy
One of: ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN

Parameters:

value
ISBN or plain-text search.

Returns:

[edit] AmazonUpdateShipments ( file )

Post a tab separated list to update the fulfillment status of SKUs. A template file for upload can be found here, on the Shipping Confirmation Template link. As with updating inventory, Amazon recommends making this call less frequently with larger posts. After uploading, you can check the status of your upload at https://sellercentral.amazon.com/gp/transactions/uploadShippingConfirmation.html

Parameters:

file
Data file to upload.

Returns:

[edit] AmazonUploadInventory ( file )

Upload a tab-separated file of inventory items.

Inventory file templates can be downloaded here.


More flat-file template info is here.

Amazon suggests when possible to combine updates into larger, less frequent updates, and upload feeds of the same type no more than once every 20 minutes.

Parameters:

file
a tab-separated file that is consistent with Amazon’s requirements for an Inventory Loader file.

Returns:

[edit] AmazonVersion ( )

Returns the string portion of the version number that is returned by getVersion.

Retrieved from "http://docs.360works.com/index.php?title=360Works_Amazon_MWS_Plugin/Documentation&oldid=2267"
Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox