360Works Amazon MWS Plugin/Documentation

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>.

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.
• 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() }.

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:

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:

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:

AmazonGetMyPrice ( sku )

Return pricing information for user's own listing.

Parameters:

sku

The SKU of the product

Returns: The price of the item

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 orderIds

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.

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.

AmazonLicenseInfo ( )

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

Returns: license info

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:

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 ( )

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