Class: MWS::Orders::Client

Inherits:
Peddler::Client show all
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, #merchant_id, #path, #primary_marketplace_id, #version

Instance Method Summary collapse

Methods inherited from Peddler::Client

#aws_endpoint, #defaults, #error_handler, #headers, #initialize, #marketplace, #marketplace_id, #marketplace_id=, on_error, #on_error, #operation, path, #run, version

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

Parameters:

  • amazon_order_id (String) —

    one or more amazon_order_ids

Returns:

See Also:



65
66
67
68
69
70
71
 
# File 'lib/mws/orders/client.rb', line 65

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

Returns:

See Also:



101
102
103
104
 
# File 'lib/mws/orders/client.rb', line 101

def get_service_status
  operation('GetServiceStatus')
  run
end

#list_order_items(amazon_order_id) ⇒ Peddler::XMLParser

Lists order items for an order

Parameters:

  • amazon_order_id (String)

Returns:

See Also:



78
79
80
81
82
83
 
# File 'lib/mws/orders/client.rb', line 78

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

Parameters:

  • next_token (String)

Returns:

See Also:



90
91
92
93
94
95
 
# File 'lib/mws/orders/client.rb', line 90

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

  run
end

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

Note:

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

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:

See Also:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/mws/orders/client.rb', line 31

def list_orders(opts = {})
  opts[:marketplace_id] ||= primary_marketplace_id
  if opts.key?(:tfm_shipment_status)
    opts['TFMShipmentStatus'] = opts.delete(:tfm_shipment_status)
  end
  operation('ListOrders')
    .add(opts)
    .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

Parameters:

  • next_token (String)

Returns:

See Also:



53
54
55
56
57
58
 
# File 'lib/mws/orders/client.rb', line 53

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

  run
end