README.md in peddler-2.0.0 vs README.md in peddler-2.0.3
- old
+ new
@@ -4,11 +4,11 @@
[![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 an [application developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper).
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.
@@ -46,13 +46,13 @@
```
If you are creating a [client for another seller](https://developer.amazonservices.com/gp/mws/faq.html#developForSeller), pass an MWS Auth Token as well.
```ruby
-client = MWS.orders(marketplace: "ATVPDKIKX0DER",
- merchant_id: "123",
- auth_token: "123")
+MWS.orders(marketplace: "ATVPDKIKX0DER",
+ merchant_id: "123",
+ auth_token: "123")
```
You won't be able to create a client for another seller if you are in different regions.
If you are working with sellers across multiple regions, a single set of credentials will not be enough. In that case, you can skip using global environment variables and pass your AWS credentials when creating the client.
@@ -120,11 +120,11 @@
puts error.response.mws_quota_remaining
# 0
end
```
-[Read Amazon's tips on how to avoid throttling](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Throttling.html).
+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.
@@ -138,19 +138,20 @@
response = client.problem_method
puts response.mws_request_id
puts response.mws_timestamp
```
-You can access the same attributes on `error.response`. See example in <a href="#throttling">above</a>.
+You can access the same attributes on `error.response`. See <a href="#throttling">above example</a>.
## The APIs
### 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§ion=feeds)
- [Peddler API docs](http://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.