Difference between revisions of "360Works Amazon MWS Plugin/Documentation"
WikiEditTask (talk | contribs) m (Auto-upload documentation) |
WikiEditTask (talk | contribs) m (Auto-upload documentation) |
||
| Line 17: | Line 17: | ||
*[[#AmazonLicenseInfo|AmazonLicenseInfo]] ( ) — | *[[#AmazonLicenseInfo|AmazonLicenseInfo]] ( ) — | ||
*[[#AmazonRegister|AmazonRegister]] ( licenseKey ; registeredTo ) — | *[[#AmazonRegister|AmazonRegister]] ( licenseKey ; registeredTo ) — | ||
| + | *[[#AmazonSetErrorCapture|AmazonSetErrorCapture]] ( errorCapture ) — Toggles error dialogs on or off. | ||
*[[#AmazonSetup|AmazonSetup]] ( sellerId ; accessKeyId ; secretAccessKey ; marketplaceId ) — | *[[#AmazonSetup|AmazonSetup]] ( sellerId ; accessKeyId ; secretAccessKey ; marketplaceId ) — | ||
*[[#AmazonUpdateShipments|AmazonUpdateShipments]] ( file ) — Post a tab separated list to update the fulfillment status of SKUs. | *[[#AmazonUpdateShipments|AmazonUpdateShipments]] ( file ) — Post a tab separated list to update the fulfillment status of SKUs. | ||
| Line 79: | Line 80: | ||
<div class="parameters"><strong>Parameters:</strong> | <div class="parameters"><strong>Parameters:</strong> | ||
<dl><dt><code>orderId</code> <dd>The order ID to fetch. Fetching the same order ID twice in a row will not make a round trip to Amazon's server. | <dl><dt><code>orderId</code> <dd>The order ID to fetch. Fetching the same order ID twice in a row will not make a round trip to Amazon's server. | ||
| − | <dt><code>property</code> <dd>One of: <code>OrderId</code>, <code>OrderStatus</code>, <code>FulfillmentChannel</code>, <code>LastUpdateDate</code>, <code>ShippingAddress</code>, <code> | + | <dt><code>property</code> <dd>One of: <code>OrderId</code>, <code>OrderStatus</code>, <code>FulfillmentChannel</code>, <code>LastUpdateDate</code>, <code>ShippingAddress</code>, <code>shipService</code>, <code>shipServiceLevel</code>, <code>BuyerName</code>, <code>BuyerEmail</code>, or <code>ItemIds</code> |
</dl></div> | </dl></div> | ||
<div class="see"><strong>Returns:</strong> The value of the requested property in the specified Order. For ShippingAddress, XML is returned. | <div class="see"><strong>Returns:</strong> The value of the requested property in the specified Order. For ShippingAddress, XML is returned. | ||
| Line 102: | Line 103: | ||
<div class="parameters"><strong>Parameters:</strong> | <div class="parameters"><strong>Parameters:</strong> | ||
<dl></dl></div> | <dl></dl></div> | ||
| + | |||
| + | |||
| + | <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> | ||
Revision as of 20:53, 4 March 2014
360Works Amazon MWS Plugin User Guide
360Works Plugin Setup Guides
See Plugins_101 for Error reporting, installation, registration, and more.
Function Summary
- AmazonGetLowPrice ( sku [ ; condition=x ; fulfillmentChannel=Amazon ; ... ] ) — return the lowest price for a particular SKU 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 ( ) —
- AmazonLicenseInfo ( ) —
- AmazonRegister ( licenseKey ; registeredTo ) —
- AmazonSetErrorCapture ( errorCapture ) — Toggles error dialogs on or off.
- AmazonSetup ( sellerId ; accessKeyId ; secretAccessKey ; marketplaceId ) —
- 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 ( ) —
Function Detail
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" )
AmazonGetMyPrice ( sku )
Return pricing information for user's own listing.
sku
AmazonGetOrderItemValue ( orderId ; orderItemId ; property )
Fetch a single attribute for an order item.
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
Returns: The value of the requested property in the specifed order item.
AmazonGetOrders ( lastUpdatedAfter ; lastUpdatedBefore )
Fetch a list of orderIds which were modified within a date range.
Parameters:
lastUpdatedAfter - the minimum modification timestamp to return orders from.
lastUpdatedBefore - the maximum modification timestamp to return orders from.
Returns: Return-separated list of matching orderIds
AmazonGetOrderValue ( orderId ; property )
Fetch a single attribute for an order.
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.
AmazonLastError ( )
AmazonLicenseInfo ( )
AmazonRegister ( licenseKey ; registeredTo )
Parameters:
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 SMSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.
Parameters:
errorCapture - set to true to suppress the default popups.
AmazonSetup ( sellerId ; accessKeyId ; secretAccessKey ; marketplaceId )
Parameters:
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:
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:
AmazonVersion ( )