Class: MWS::Orders::Client
- Inherits:
-
Peddler::Client
- Object
- Peddler::Client
- MWS::Orders::Client
- Defined in:
- lib/mws/orders/client.rb
Overview
With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders.
Instance Attribute Summary
Attributes inherited from Peddler::Client
#auth_token, #body, #marketplace, #merchant_id
Instance Method Summary collapse
-
#get_order(*amazon_order_ids) ⇒ Peddler::XMLParser
Gets one or more orders.
-
#get_service_status ⇒ Peddler::XMLParser
Gets the service status of the API.
-
#list_order_items(amazon_order_id) ⇒ Peddler::XMLParser
Lists order items for an order.
-
#list_order_items_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of order items for an order.
-
#list_orders(*marketplace_id, opts = {}) ⇒ Peddler::XMLParser
Lists orders.
-
#list_orders_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of orders.
Methods inherited from Peddler::Client
Constructor Details
This class inherits a constructor from Peddler::Client
Instance Method Details
#get_order(*amazon_order_ids) ⇒ Peddler::XMLParser
Gets one or more orders
71 72 73 74 75 76 77 |
# File 'lib/mws/orders/client.rb', line 71 def get_order(*amazon_order_ids) operation('GetOrder') .add('AmazonOrderId' => amazon_order_ids) .structure!('AmazonOrderId', 'Id') run end |
#get_service_status ⇒ Peddler::XMLParser
Gets the service status of the API
107 108 109 110 |
# File 'lib/mws/orders/client.rb', line 107 def get_service_status operation('GetServiceStatus') run end |
#list_order_items(amazon_order_id) ⇒ Peddler::XMLParser
Lists order items for an order
84 85 86 87 88 89 |
# File 'lib/mws/orders/client.rb', line 84 def list_order_items(amazon_order_id) operation('ListOrderItems') .add('AmazonOrderId' => amazon_order_id) run end |
#list_order_items_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of order items for an order
96 97 98 99 100 101 |
# File 'lib/mws/orders/client.rb', line 96 def list_order_items_by_next_token(next_token) operation('ListOrderItemsByNextToken') .add('NextToken' => next_token) run end |
#list_orders(*marketplace_id, opts = {}) ⇒ Peddler::XMLParser
When calling this operation, you must specify a time frame using either created_after or last_updated_after. When requesting orders by “Unshipped” status you must also request “PartiallyShipped” orders.
Lists orders
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/mws/orders/client.rb', line 34 def list_orders(*marketplace_id) marketplace_id = marketplace_id.dup opts = (marketplace_id) if opts.key?(:tfm_shipment_status) opts['TFMShipmentStatus'] = opts.delete(:tfm_shipment_status) end operation('ListOrders') .add(opts) .add('MarketplaceId' => marketplace_id) .structure!('OrderStatus', 'Status') .structure!('FulfillmentChannel', 'Channel') .structure!('MarketplaceId', 'Id') .structure!('PaymentMethod') .structure!('TFMShipmentStatus', 'Status') require_start_time! run end |
#list_orders_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of orders
59 60 61 62 63 64 |
# File 'lib/mws/orders/client.rb', line 59 def list_orders_by_next_token(next_token) operation('ListOrdersByNextToken') .add('NextToken' => next_token) run end |