360Works Amazon MWS Plugin/Documentation
From 360Works Product Documentation Wiki
(Difference between revisions)
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
||
| Line 26: | Line 26: | ||
==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: | ||
| − | + | ||
| − | AmazonGetLowPrice("my_sku" ; "condition=New" ; "fulfillmentChannel=Amazon" ) | + | AmazonGetLowPrice("my_sku" ; "condition=New" ; "fulfillmentChannel=Amazon" ) |
| − | + | ||
<div class="parameters"><strong>Parameters:</strong> | <div class="parameters"><strong>Parameters:</strong> | ||
| Line 71: | Line 71: | ||
==AmazonGetOrderValue ( orderId ; property ) == | ==AmazonGetOrderValue ( orderId ; property ) == | ||
Fetch a single attribute for an order. | Fetch a single attribute for an order. | ||
| − | |||
| − | |||
<code>ShippingAddress</code>, <code>BuyerName</code>, and <code>BuyerEmail</code> are only returned when the OrderStatus is <code>shipped</code> or <code>partially shipped</code>, or the item is Unshipped and fulfilled by seller. | <code>ShippingAddress</code>, <code>BuyerName</code>, and <code>BuyerEmail</code> are only returned when the OrderStatus is <code>shipped</code> or <code>partially shipped</code>, or the item is Unshipped and fulfilled by seller. | ||
| − | |||
| − | |||
<code>ItemIds</code> requires a round-trip to the server to fetch the order items. | <code>ItemIds</code> requires a round-trip to the server to fetch the order items. | ||
| Line 83: | Line 79: | ||
<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>BuyerName</code>, <code>BuyerEmail</code>, or <code>ItemIds</code> | + | <dt><code>property</code> <dd>One of: <code>OrderId</code>, <code>OrderStatus</code>, <code>FulfillmentChannel</code>, <code>LastUpdateDate</code>, <code>ShippingAddress</code>, <code>shipmentService</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 119: | Line 115: | ||
==AmazonUpdateShipments ( file ) == | ==AmazonUpdateShipments ( file ) == | ||
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 139: | Line 129: | ||
==AmazonUploadInventory ( file ) == | ==AmazonUploadInventory ( file ) == | ||
Upload a tab-separated file of inventory items. | Upload a tab-separated file of inventory items. | ||
| − | |||
| − | |||
Inventory file templates can be downloaded [https://sellercentral.amazon.com/gp/help/ here]. | Inventory file templates can be downloaded [https://sellercentral.amazon.com/gp/help/ here]. | ||
| − | |||
| − | |||
| Line 159: | Line 145: | ||
<div id="AmazonVersion"></div> | <div id="AmazonVersion"></div> | ||
==AmazonVersion ( ) == | ==AmazonVersion ( ) == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 16:54, 15 April 2013
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 ) —
- 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" )
Parameters:
Returns:
AmazonGetMyPrice ( sku )
Return pricing information for user's own listing.
Parameters:
sku
Returns:
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.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 orderIdsAmazonGetOrderValue ( orderId ; property )
Fetch a single attribute for an order.
<code>ShippingAddress
BuyerName, andBuyerEmailare only returned when the OrderStatus isshippedorpartially shipped, or the item is Unshipped and fulfilled by seller.ItemIdsrequires 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,shipmentService,shipServiceLevel,BuyerName,BuyerEmail, orItemIds
Returns: The value of the requested property in the specified Order. For ShippingAddress, XML is returned.AmazonLastError ( )
AmazonLicenseInfo ( )
AmazonRegister ( licenseKey ; registeredTo )
Parameters:
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 ( ) ==
