Contents

# MWS Orders

**MWS Orders** is a fully-featured Ruby interface to the [Amazon Marketplace
Web Service (MWS) Orders API][1].

## Usage

Instantiate a client:

```ruby
client = MWS::Orders::Client.new('GB', 'aws_key', 'aws_secret', 'seller_id')
```

[API methods are available on the client][2].

### Orders

List orders created or updated during a time frame you specify:

```ruby
# See the API for all available parameters.
client.list_orders(
  created_after: 1.week.ago,
  order_status: %w(Pending Unshipped)
)
```

List the next page of orders:

```ruby
client.list_orders_by_next_token
```

Get one or more orders based on their order numbers:

```ruby
client.get_order('123-1234567-1234567')
```

All above queries will return an enumerable list of orders.

### Order Items

List order items based on an order number you specify:

```ruby
client.list_order_items('123-1234567-1234567')
```

List the next page of order items:

```ruby
client.list_order_items_by_next_token
```

All above queries will return an enumerable list of order items.

### Service Status

Check the operational status of the API:

```ruby
client.get_service_status
```

### Naming Conventions

Request and response attribute names follow Amazon's naming conventions with a
few exceptions, where some Railsism has insidiuously crept in—e.g.
`shipped_at` instead of `ShipDate`.

[1]: http://docs.developer.amazonservices.com/en_UK/orders/index.html
[2]: https://github.com/papercavalier/mws-orders/blob/master/lib/mws/orders/client.rb

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
mws-orders-0.0.2	README.md
mws-orders-0.0.1	README.md