README.md in peddler-2.1.1 vs README.md in peddler-2.3.0

- old
+ new

@@ -1,14 +1,14 @@ # Peddler -[![Build Status](https://travis-ci.org/hakanensari/peddler.svg)](https://travis-ci.org/hakanensari/peddler) +[![Build](https://github.com/hakanensari/peddler/workflows/build/badge.svg)](https://github.com/hakanensari/peddler/actions) [![Maintainability](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/maintainability)](https://codeclimate.com/github/hakanensari/peddler/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/test_coverage)](https://codeclimate.com/github/hakanensari/peddler/test_coverage) **Peddler** is a Ruby interface to the [Amazon MWS API](https://developer.amazonservices.com/), a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more. -To use Amazon MWS, you must have an eligible seller account and register as an [application developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper). +To use Amazon MWS, you must have an eligible seller account and [register as a developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper). You can then access your own selling account using its merchant ID—note that Amazon also refers to this as seller ID or merchant token in different places. Amazon has [multiple regions](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html). Each region requires application developers to register individually. Some MWS API sections may require additional authorisation from Amazon. ![Peddler](http://f.cl.ly/items/1G1N0A0a0v3a3h241c1Q/peddler.jpg) @@ -118,11 +118,11 @@ Read [tips on how to avoid throttling](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Throttling.html). ### Debugging -If you are having trouble with a request, read the [Amazon documentation](https://developer.amazonservices.com/gp/mws/docs.html). [Peddler's source](http://www.rubydoc.info/github/hakanensari/peddler) also links individual operations to their corresponding entries in the Amazon docs. +If you are having trouble with a request, read the [Amazon documentation](https://developer.amazonservices.com/gp/mws/docs.html). [Peddler's source](https://www.rubydoc.info/github/hakanensari/peddler) also links individual operations to their corresponding entries in the Amazon docs. Note that some optional keywords have default values. To introspect requests, set the `EXCON_DEBUG` environment variable to `1` or similar truthy value. Peddler will then log request and response internals to stdout. @@ -136,105 +136,107 @@ You can access the same attributes on `error.response`. See <a href="#throttling">above example</a>. ## The APIs +### Easy Ship + +With the Easy Ship API, you can build applications that help sellers in India manage and ship their Amazon Easy Ship orders. Your Amazon Easy Ship applications can get available pickup slots; schedule, reschedule, and cancel pickups; and print labels, invoices, and warranties. + +- [Amazon references](https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/EasyShip/Client) + ### Feeds The MWS Feeds API lets you upload inventory and order data to Amazon. You can also use this API to get information about the processing of feeds. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=bde&section=feeds) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Feeds/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/feeds/Feeds_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Feeds/Client) - [XML schema docs](https://sellercentral.amazon.com/gp/help/help-page.html?itemID=1611) ### Finances The MWS Finances API enables you to obtain financial information relevant to your business with Amazon. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=finances&section=finances) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Finances/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/finances/Finances_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Finances/Client) ### Fulfillment Inbound Shipment With the MWS Fulfillment Inbound Shipment API, you can create and update inbound shipments of inventory in the Amazon Fulfillment Network. You can also also request lists of inbound shipments or inbound shipment items based on criteria that you specify. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=inbound) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client) ### Fulfillment Inventory The MWS Fulfillment Inventory API can help you stay up-to-date on the availability of your inventory in the Amazon Fulfillment Network. The Fulfillment Inventory API reports real-time availability information for your Amazon Fulfillment Network inventory regardless of whether you are selling your inventory on Amazon's retail web site or through other retail channels. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=inventory) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_inventory/FBAInventory_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client) ### Fulfillment Outbound Shipment The MWS Fulfillment Outbound Shipment API enables you to fulfill orders placed through channels other than Amazon's retail web site, using your inventory in the Amazon Fulfillment Network. You can request previews of potential fulfillment orders that return estimated shipping fees and shipping dates based on shipping speed. You can get detailed item-level, shipment-level, and order-level information for any existing fulfillment order that you specify. You can also request lists of existing fulfillment orders based on when they were fulfilled and by the fulfillment method associated with them. Support for creating and cancelling fulfillment orders has been implemented, but the rest of the API is not supported yet. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=outbound) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client) ### Merchant Fulfillment The Merchant Fulfillment API provides programmatic access to Amazon’s fulfillment shipping services for sellers, including competitive rates with Amazon-partnered carriers. Sellers can find out what shipping services are available by submitting information about a proposed fulfillment shipment, such as package size and weight; shipment origin and destination; and delivery date requirements. Sellers can choose from the shipping service options returned by Amazon, and then receive shipping labels for fulfilling their orders. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=merchantfulfillment&section=merchantfulfillment) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/MerchantFulfillment/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/MerchantFulfillment/Client) -### Off Amazon Payments - -The MWS Off-Amazon Payments API helps you to process payments for purchases made by buyers on your website using the Login and Pay with Amazon service. This API enables you to programmatically retrieve shipping and payment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refund payments, enabling a variety of payments scenarios. - -You can switch the client to the sandbox environment: - -```ruby -client = MWS.off_amazon_payments.sandbox -``` - -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=offamazonpayments&section=offamazonpayments) -- [Official Ruby client](https://github.com/amzn/login-and-pay-with-amazon-sdk-ruby) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/OffAmazonPayments/Client) - ### Orders With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=orders&section=orders) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Orders/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Orders/Client) ### Products The MWS Products API helps you get information to match your products to existing product listings on Amazon Marketplace websites and to make sourcing and pricing decisions for listing those products on Amazon Marketplace websites. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=products&section=products) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Products/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/products/Products_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Products/Client) ### Recommendations The Recommendations API enables you to programmatically retrieve Amazon Selling Coach recommendations by recommendation category. A recommendation is an actionable, timely, and personalized opportunity to increase your sales and performance. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=recommendations&section=recommendations) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client) ### Reports The Reports API lets you request reports about your inventory and orders. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=bde&section=reports) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Reports/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/reports/Reports_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Reports/Client) ### Sellers The Sellers API lets sellers retrieve information about their seller account, such as the marketplaces they participate in. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=sellers&section=sellers) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Sellers/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Sellers/Client) +### Shipment Invoicing + +With the Shipment Invoicing API section (in conjunction with the FBAOutboundShipmentStatus notification), you can integrate invoicing into Amazon’s shipping process for a seller’s Fulfillment by Amazon (FBA) orders. + +This functionality is available only in the Brazil marketplace. + +- [Amazon references](https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/ShipmentInvoicing/Client) + ### Subscriptions The Amazon MWS Subscriptions API section enables you to subscribe to receive notifications that are relevant to your business with Amazon. With the operations in the Subscriptions API section, you can register to receive important information from Amazon without having to poll the Amazon MWS service. Instead, the information is sent directly to you when an event occurs to which you are subscribed. -- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=subscriptions&section=subscriptions) -- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client) +- [Amazon references](https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_Overview.html) +- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)