Class: MWS::Orders

Inherits:

Peddler::Client

• Object
• Peddler::Client
• MWS::Orders

Defined in:

lib/mws/orders.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.

Constant Summary

Constants inherited from Peddler::Client

Peddler::Client::BadMarketplaceId, Peddler::Client::HOSTS

Instance Attribute Summary

Attributes inherited from Peddler::Client

#body, #marketplace_id, #merchant_id

Instance Method Summary

• #get_order(*amazon_order_ids) ⇒ Peddler::Parser

  Gets one or more orders.

• #get_service_status ⇒ Object

  Gets the service status of the API.

• #list_order_items(amazon_order_id) ⇒ Peddler::Parser

  Lists order items for an order.

• #list_order_items_by_next_token(next_token) ⇒ Peddler::Parser

  Lists the next page of order items for an order.

• #list_orders(opts = {}) ⇒ Peddler::Parser

  Lists orders.

• #list_orders_by_next_token(next_token) ⇒ Peddler::Parser

  Lists the next page of orders.

Methods inherited from Peddler::Client

#aws_endpoint, #headers, inherited, #operation, path, #run

Instance Method Details

#get_order(*amazon_order_ids) ⇒ Peddler::Parser

Gets one or more orders

Parameters:

• amazon_order_ids (Array<String>)

Returns:

• (Peddler::Parser)

See Also:

• http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_GetOrder.html

# File 'lib/mws/orders.rb', line 58

def get_order(*amazon_order_ids)
  operation('GetOrder')
    .add('AmazonOrderId' => amazon_order_ids)
    .structure!('AmazonOrderId', 'Id')

  run
end

#get_service_status ⇒ Object

Gets the service status of the API

Returns:

• Peddler::Parser

See Also:

• http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/MWS_GetServiceStatus.html

# File 'lib/mws/orders.rb', line 95

def get_service_status
  operation('GetServiceStatus')
  run
end

#list_order_items(amazon_order_id) ⇒ Peddler::Parser

Lists order items for an order

Parameters:

• amazon_order_id (String)

Returns:

• (Peddler::Parser)

See Also:

• http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItems.html

# File 'lib/mws/orders.rb', line 71

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::Parser

Lists the next page of order items for an order

Parameters:

• next_token (String)

Returns:

• (Peddler::Parser)

• false if there are no more pages

See Also:

• http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItemsByNextToken.html

# File 'lib/mws/orders.rb', line 84

def list_order_items_by_next_token(next_token)
  operation('ListOrderItemsByNextToken')
    .add('NextToken' => next_token)

  run
end

#list_orders(opts = {}) ⇒ Peddler::Parser

Lists orders

Parameters:

• opts (Hash) (defaults to: {})

Options Hash (opts):

• :created_after (String, #iso8601)
• :created_before (String, #iso8601)
• :last_updated_after (String, #iso8601)
• :last_updated_before (String, #iso8601)
• :order_status (Array<String>, String)
• :marketplace_id (Array<String>, String)
• :fulfillment_channel (Array<String>, String)
• :payment_method (Array<String>, String)
• :buyer_email (String)
• :seller_order_id (String)
• :max_results_per_page (String)
• :tfm_shipment_status (String)

Returns:

• (Peddler::Parser)

See Also:

• http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrders.html

# File 'lib/mws/orders.rb', line 26

def list_orders(opts = {})
  opts[:marketplace_id] ||= marketplace_id
  opts['TFMShipmentStatus'] = opts.delete(:tfm_shipment_status) if opts.has_key?(:tfm_shipment_status)

  operation('ListOrders')
    .add(opts)
    .structure!('OrderStatus', 'Status')
    .structure!('MarketplaceId', 'Id')
    .structure!('PaymentMethod')
    .structure!('TFMShipmentStatus', 'Status')

  run
end

#list_orders_by_next_token(next_token) ⇒ Peddler::Parser

Lists the next page of orders

Parameters:

• next_token (String)

Returns:

• (Peddler::Parser)

• false if there are no more pages

See Also:

• http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrdersByNextToken.html

# File 'lib/mws/orders.rb', line 46

def list_orders_by_next_token(next_token)
  operation('ListOrdersByNextToken')
    .add('NextToken' => next_token)

  run
end