peddler 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7eb80f7f028b5464f42c29cb72ce60e2eda123d
-  data.tar.gz: 8a814e73f8695da5b01b0e14d62732beec970cd6
+  metadata.gz: b95e55aea4d9f7f44675d59cbbec0dfc2dc72155
+  data.tar.gz: 75074f1a3a288aefe5cb452dfa8b20fe521bc28f
 SHA512:
-  metadata.gz: d736136aed3d96ebc1fc61be23638350ba84e82a7473e8ce62bf3f8086cac12e3640539895b3c25f41f739c41d7d76ff3a5193d38636932c323351967d5d9701
-  data.tar.gz: c03d025e24a676ab7150f685eef1db93b183f942f2b7259ba44e51f394dd77d195d335bbe92f2f8fd79ca9cc626a7be02ba8673d0ad0ec5911cc03ce58eed682
+  metadata.gz: ebdd605e71a49b34b84a3825da5cd01814ca37c8ad2eea6ad2743da14396eea4824caa0a8c968ae83d2153138acd2a75853be7f0251e73f0a13bf7f3551a8dee
+  data.tar.gz: 7813fd21aa2039e3bd9692eac635dab4b8c73965f22df28d0cd57b822177feb20f6b8792dc4cfd97d3b5bcda6a871452c2bd04ddd736e7f1f0dae9e6a658a5fe

data/README.md

@@ -32,10 +32,10 @@ client = MWS.orders
 Each client requires valid MWS credentials. You can set these globally in the shell.
 
 ```bash
-export MWS_MARKETPLACE_ID=foo
-export MWS_MERCHANT_ID=bar
-export AWS_ACCESS_KEY_ID=baz
-export AWS_SECRET_ACCESS_KEY=qux
+export MWS_MARKETPLACE_ID=YOUR_MARKETPLACE_ID
+export MWS_MERCHANT_ID=YOUR_MERCHANT_OR_SELLER_ID
+export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
+export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
 ```
 
 You can now instantiate a client.
@@ -44,23 +44,29 @@ You can now instantiate a client.
 client = MWS.orders
 ```
 
-Alternatively, you can set some or all credentials when or after creating the client.
+Alternatively, if you do not rely on environment variables, you can set some or all credentials when or after creating the client.
 
 ```ruby
 client = MWS.orders(
-  primary_marketplace_id: "foo",
-  merchant_id: "bar",
-  aws_access_key_id: "baz",
-  aws_secret_access_key: "qux"
+  primary_marketplace_id: "Your Marketplace ID",
+  merchant_id: "Your Merchant or Seller ID",
+  aws_access_key_id: "Your AWS Access Key ID",
+  aws_secret_access_key: "Your AWS Secret Access Key",
 )
-client.primary_marketplace_id = "bar"
+
+client.primary_marketplace_id = "Another Marketplace ID"
 ```
 
-If you are creating a client for another seller, pass the latter's `MWSAuthToken` to the client.
+If you are creating a [client for another seller](https://developer.amazonservices.com/gp/mws/faq.html#developForSeller), pass the latter's Merchant (Seller) ID and Marketplace ID along with the `MWSAuthToken` they obtained for you.
 
 ```ruby
-client = MWS.orders
-client.auth_token = "corge"
+client = MWS.orders(
+  primary_marketplace_id: "Seller's Marketplace ID",
+  merchant_id: "Seller's Merchant or Seller ID",
+  aws_access_key_id: "Your AWS Access Key ID",
+  aws_secret_access_key: "Your AWS Secret Access Key",
+  auth_token: "Seller's MWS Authorisation Token"
+)
 ```
 
 Once you have a client with valid credentials, you should be able to make requests to the API. Clients map operation names in a flat structure. Methods have positional arguments for required input and keyword arguments for optional parameters. Both method and argument names are underscored but otherwise identical to the names of the corresponding operations and parameters documented in the API.
@@ -107,37 +113,43 @@ end
 
 With the MWS Cart Information API, you can retrieve shopping carts that your Amazon Webstore customers have created. The Cart Information API enables you to programmatically integrate Amazon Webstore cart information with your CRM systems, marketing applications, and other systems that require cart data.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/CartInformation/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=cartinformation&section=cartinformation)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/CartInformation/Client)
 
 ### Customer Information
 
 With the MWS Customer Information API, you can retrieve information from the customer accounts of your Amazon Webstore customers. This customer information includes customer name, contact information, customer account type, and associated Amazon Webstore marketplaces. The Customer Information API enables you to programmatically integrate Amazon Webstore customer account information with your CRM systems, marketing applications, and other systems that require customer data.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/CustomerInformation/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=customerinformation&section=customerinformation)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/CustomerInformation/Client)
 
 ### 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.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Feeds/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=bde&section=feeds)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Feeds/Client)
 
 ### 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.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Finances/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=finances&section=finances)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Finances/Client)
 
 ### Fulfillment Inbound Shipment
 
 With the MWS Fulfillment Inbound Shipment API, you can create and update inbound shipments of inventory in the Amazon Fulfillment Network. You can also also request lists of inbound shipments or inbound shipment items based on criteria that you specify.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=inbound)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client)
 
 ### Fulfillment Inventory
 
 The MWS Fulfillment Inventory API can help you stay up-to-date on the availability of your inventory in the Amazon Fulfillment Network. The Fulfillment Inventory API reports real-time availability information for your Amazon Fulfillment Network inventory regardless of whether you are selling your inventory on Amazon's retail web site or through other retail channels.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=inventory)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client)
 
 ### Fulfillment Outbound Shipment
 
@@ -145,7 +157,8 @@ The MWS Fulfillment Outbound Shipment API enables you to fulfill orders placed t
 
 Support for creating and cancelling fulfillment orders has been implemented, but the rest of the API is not supported yet.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=outbound)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client)
 
 ### Off Amazon Payments
 
@@ -157,46 +170,55 @@ You can switch the client to the sandbox environment:
 client = MWS.off_amazon_payments.sandbox
 ```
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/OffAmazonPayments/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=offamazonpayments&section=offamazonpayments)
+- [Official Ruby client](https://github.com/amzn/login-and-pay-with-amazon-sdk-ruby)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/OffAmazonPayments/Client)
 
 ### Orders
 
 With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Orders/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=orders&section=orders)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Orders/Client)
 
 ### Products
 
 The MWS Products API helps you get information to match your products to existing product listings on Amazon Marketplace websites and to make sourcing and pricing decisions for listing those products on Amazon Marketplace websites.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Products/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=products&section=products)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Products/Client)
 
 ### Recommendations
 
 The Recommendations API enables you to programmatically retrieve Amazon Selling Coach recommendations by recommendation category. A recommendation is an actionable, timely, and personalized opportunity to increase your sales and performance.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=recommendations&section=recommendations)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client)
 
 ### Reports
 
 The Reports API lets you request reports about your inventory and orders.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Reports/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=bde&section=reports)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Reports/Client)
 
 ### Sellers
 
 The Sellers API lets sellers retrieve information about their seller account, such as the marketplaces they participate in.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Sellers/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=sellers&section=sellers)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Sellers/Client)
 
 ### Subscriptions
 
 The Amazon MWS Subscriptions API section enables you to subscribe to receive notifications that are relevant to your business with Amazon. With the operations in the Subscriptions API section, you can register to receive important information from Amazon without having to poll the Amazon MWS service. Instead, the information is sent directly to you when an event occurs to which you are subscribed.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=subscriptions&section=subscriptions)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)
 
 ### Webstore
 
 With the Webstore API section of Amazon Marketplace Web Service (Amazon MWS), you can get “Email Me When Available” subscription information for items listed on your Amazon Webstore. The Webstore API section can help you plan your inventory replenishment cycle by enabling you to query for items that your customers subscribed to when they clicked the Email Me When Available button on your Webstore. The Webstore API section can also return information about the notifications that were sent to your customers when out-of-stock items came back in stock. This information, when combined with sales information that your Webstore tracks, can help you determine how many notifications were converted into sales.
 
-[Read more](http://www.rubydoc.info/gems/peddler/MWS/Webstore/Client)
+- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=webstore&section=webstore)
+- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Webstore/Client)

data/lib/mws.rb

@@ -6,6 +6,7 @@ require 'mws/finances'
 require 'mws/fulfillment_inbound_shipment'
 require 'mws/fulfillment_inventory'
 require 'mws/fulfillment_outbound_shipment'
+require 'mws/merchant_fulfillment'
 require 'mws/off_amazon_payments'
 require 'mws/orders'
 require 'mws/products'
@@ -15,6 +16,7 @@ require 'mws/sellers'
 require 'mws/subscriptions'
 require 'mws/webstore'
 
+# The various Amazon MWS API sections.
 module MWS
   class << self
     extend Forwardable

data/lib/mws/cart_information/client.rb

@@ -16,14 +16,14 @@ module MWS
     # @note In addition to registering for Amazon MWS, you must also request
     #   authorization to use the Cart Information API section.
     class Client < ::Peddler::Client
-      version "2014-03-01"
+      version '2014-03-01'
       path "/CartInformation/#{version}"
 
       # Lists shopping carts
       #
       # @see http://docs.developer.amazonservices.com/en_US/cart_info/CartInfo_ListCarts.html
-      # @param date_range_start [String, #iso8601]
-      # @param opts [Hash]
+      # @param [String, #iso8601] date_range_start
+      # @param [Hash] opts
       # @option opts [String] :marketplace_id
       # @option opts [String, #iso8601] :date_range_end
       # @return [Peddler::XMLParser]
@@ -37,7 +37,7 @@ module MWS
       # Lists the next page of shopping carts
       #
       # @see http://docs.developer.amazonservices.com/en_US/cart_info/CartInfo_ListCartsByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_carts_by_next_token(next_token)
         operation('ListCartsByNextToken')
@@ -49,8 +49,9 @@ module MWS
       # Returns shopping carts based on specified values
       #
       # @see http://docs.developer.amazonservices.com/en_US/cart_info/CartInfo_GetCarts.html
-      # @param marketplace_id [String]
-      # @param cart_id_list [Array<String>]
+      # @overload get_carts(marketplace_id, *cart_ids)
+      #   @param [String] marketplace_id
+      #   @param [String] cart_id one or more cart_ids
       # @return [Peddler::XMLParser]
       def get_carts(marketplace_id, *cart_id_list)
         operation('GetCarts')

data/lib/mws/customer_information/client.rb

@@ -18,13 +18,13 @@ module MWS
     # @note In addition to registering for Amazon MWS, you must request
     #   authorization to use the Customer Information API.
     class Client < ::Peddler::Client
-      version "2014-03-01"
+      version '2014-03-01'
       path "/CustomerInformation/#{version}"
 
       # Lists customer accounts based on search criteria that you specify
       #
       # @see http://docs.developer.amazonservices.com/en_US/customer_info/CustomerInfo_ListCustomers.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [String] :marketplace_id
       # @option opts [String, #iso8601] :date_range_start
       # @option opts [String, #iso8601] :date_range_end
@@ -40,7 +40,7 @@ module MWS
       # Lists the next page of customer accounts
       #
       # @see http://docs.developer.amazonservices.com/en_US/customer_info/CustomerInfo_ListCustomersByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_customers_by_next_token(next_token)
         operation('ListCustomersByNextToken')
@@ -53,9 +53,9 @@ module MWS
       # specify
       #
       # @see http://docs.developer.amazonservices.com/en_US/customer_info/CustomerInfo_GetCustomersForCustomerId.html
-      # @overload get_customers_for_customer_id(*customer_id_list, opts = {})
-      #   @param customer_id_list [Array<String>]
-      #   @param opts [Hash]
+      # @overload get_customers_for_customer_id(*customer_ids, opts = {})
+      #   @param [String] customer_id one or more customer_ids
+      #   @param [Hash] opts
       #   @option opts [String] :marketplace_id
       # @return [Peddler::XMLParser]
       def get_customers_for_customer_id(*customer_id_list)

data/lib/mws/feeds/client.rb

@@ -12,9 +12,9 @@ module MWS
       # @note Feed size is limited to 2,147,483,647 bytes (2^31 -1) per feed.
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_SubmitFeed.html
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html
-      # @param feed_content [String] an XML or flat file feed
-      # @param feed_type [String] the feed type
-      # @param opts [Hash]
+      # @param [String] feed_content an XML or flat file feed
+      # @param [String] feed_type the feed type
+      # @param [Hash] opts
       # @option opts [Array<String>, String] :marketplace_id_list
       # @option opts [Boolean] :purge_and_replace
       # @return [Peddler::XMLParser]
@@ -31,7 +31,7 @@ module MWS
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_GetFeedSubmissionList.html
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [Array<String>, String] :feed_submission_id_list
       # @option opts [Integer] :max_count
       # @option opts [Array<String>, String] :feed_type_list
@@ -52,7 +52,7 @@ module MWS
       # Lists the next page of feed submissions
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_GetFeedSubmissionListByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def get_feed_submission_list_by_next_token(next_token)
         operation('GetFeedSubmissionListByNextToken')
@@ -65,7 +65,7 @@ module MWS
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_GetFeedSubmissionCount.html
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [Array<String>, String] :feed_type_list
       # @option opts [Array<String>, String] :feed_processing_status_list
       # @option opts [String, #iso8601] :submitted_from_date
@@ -84,7 +84,7 @@ module MWS
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_CancelFeedSubmissions.html
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [Array<String>, String] :feed_submission_id_list
       # @option opts [Array<String>, String] :feed_type_list
       # @option opts [String, #iso8601] :submitted_from_date
@@ -102,7 +102,7 @@ module MWS
       # Gets the processing report for a feed and its Content-MD5 header
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_GetFeedSubmissionResult.html
-      # @param feed_submission_id [Integer, String]
+      # @param [Integer, String] feed_submission_id
       # @return [Peddler::XMLParser] if the report is in XML format
       # @return [Peddler::CSVParser] if the report is a flat file
       def get_feed_submission_result(feed_submission_id)

data/lib/mws/finances/client.rb

@@ -5,13 +5,13 @@ module MWS
     # With the MWS Finances API you can retrieve financial transactions for your
     # seller account.
     class Client < ::Peddler::Client
-      version "2015-05-01"
+      version '2015-05-01'
       path "/Finances/#{version}"
 
       # Lists financial events
       #
       # @see http://docs.developer.amazonservices.com/en_US/finances/Finances_ListFinancialEvents.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [Integer] :max_results_per_page
       # @option opts [String] :amazon_order_id
       # @option opts [String] :financial_event_group_id
@@ -26,7 +26,7 @@ module MWS
       # Lists the next page of financial events
       #
       # @see http://docs.developer.amazonservices.com/en_US/finances/Finances_ListFinancialEventGroupsByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_financial_events_by_next_token(next_token)
         operation('ListFinancialEventsByNextToken')
@@ -38,8 +38,8 @@ module MWS
       # Lists financial event groups
       #
       # @see http://docs.developer.amazonservices.com/en_US/finances/Finances_ListFinancialEventGroups.html
-      # @param financial_event_group_started_after [String, #iso8601]
-      # @param opts [Hash]
+      # @param [String, #iso8601] financial_event_group_started_after
+      # @param [Hash] opts
       # @option opts [Integer] :max_results_per_page
       # @option opts [String, #iso8601] :financial_event_group_started_before
       # @return [Peddler::XMLParser]
@@ -54,7 +54,7 @@ module MWS
       # Lists the next page of financial event groups
       #
       # @see http://docs.developer.amazonservices.com/en_US/finances/Finances_ListFinancialEventGroupsByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_financial_event_groups_by_next_token(next_token)
         operation('ListFinancialEventGroupsByNextToken')

data/lib/mws/fulfillment_inbound_shipment/client.rb

@@ -7,15 +7,15 @@ module MWS
     # also request lists of inbound shipments or inbound shipment items based on
     # criteria that you specify.
     class Client < ::Peddler::Client
-      version "2010-10-01"
+      version '2010-10-01'
       path "/FulfillmentInboundShipment/#{version}"
 
       # Returns the information required to create an inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_CreateInboundShipmentPlan.html
-      # @param ship_from_address [Struct, Hash]
-      # @param inbound_shipment_plan_request_items [Array<Struct, Hash>]
-      # @param opts [Hash]
+      # @param [Struct, Hash] ship_from_address
+      # @param [Array<Struct, Hash>] inbound_shipment_plan_request_items
+      # @param [Hash] opts
       # @option opts [String] :label_prep_preference
       # @return [Peddler::XMLParser]
       def create_inbound_shipment_plan(ship_from_address, inbound_shipment_plan_request_items, opts = {})
@@ -32,48 +32,36 @@ module MWS
       # Creates an inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_CreateInboundShipment.html
-      # @param shipment_id [String]
-      # @param inbound_shipment_header [Struct, Hash]
-      # @param opts [Hash]
+      # @param [String] shipment_id
+      # @param [Struct, Hash] inbound_shipment_header
+      # @param [Hash] opts
       # @option opts [Array<Struct, Hash>] :inbound_shipment_items
       # @return [Peddler::XMLParser]
       def create_inbound_shipment(shipment_id, inbound_shipment_header, opts = {})
-        operation('CreateInboundShipment')
-          .add(opts.update(
-                 'ShipmentId' => shipment_id,
-                 'InboundShipmentHeader' => inbound_shipment_header
-          ))
-          .structure!('InboundShipmentItems', 'member')
-
+        build_inbound_shipment_operation('CreateInboundShipment', shipment_id, inbound_shipment_header, opts)
         run
       end
 
       # Updates an existing inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_UpdateInboundShipment.html
-      # @param shipment_id [String]
-      # @param inbound_shipment_header [Struct, Hash]
-      # @param opts [Hash]
+      # @param [String] shipment_id
+      # @param [Struct, Hash] inbound_shipment_header
+      # @param [Hash] opts
       # @option opts [Array<Struct, Hash>] :inbound_shipment_items
       # @return [Peddler::XMLParser]
       def update_inbound_shipment(shipment_id, inbound_shipment_header, opts = {})
-        operation('UpdateInboundShipment')
-          .add(opts.update(
-                 'ShipmentId' => shipment_id,
-                 'InboundShipmentHeader' => inbound_shipment_header
-          ))
-          .structure!('InboundShipmentItems', 'member')
-
+        build_inbound_shipment_operation('UpdateInboundShipment', shipment_id, inbound_shipment_header, opts)
         run
       end
 
       # Sends transportation information to Amazon about an inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_PutTransportContent.html
-      # @param shipment_id [String]
-      # @param is_partnered [Boolean]
-      # @param shipment_type [String]
-      # @param transport_details [Struct, Hash]
+      # @param [String] shipment_id
+      # @param [Boolean] is_partnered
+      # @param [String] shipment_type
+      # @param [Struct, Hash] transport_details
       # @return [Peddler::XMLParser]
       def put_transport_content(shipment_id, is_partnered, shipment_type, transport_details)
         operation('PutTransportContent')
@@ -91,7 +79,7 @@ module MWS
       # Requests an estimate of the shipping cost for an inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_EstimateTransportRequest.html
-      # @param shipment_id [String]
+      # @param [String] shipment_id
       # @return [Peddler::XMLParser]
       def estimate_transport_request(shipment_id)
         operation('EstimateTransportRequest').add('ShipmentId' => shipment_id)
@@ -101,7 +89,7 @@ module MWS
       # Returns current transportation information about an inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetTransportContent.html
-      # @param shipment_id [String]
+      # @param [String] shipment_id
       # @return [Peddler::XMLParser]
       def get_transport_content(shipment_id)
         operation('GetTransportContent').add('ShipmentId' => shipment_id)
@@ -112,7 +100,7 @@ module MWS
       # request that the Amazon-partnered carrier ship your inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_ConfirmTransportRequest.html
-      # @param shipment_id [String]
+      # @param [String] shipment_id
       # @return [Peddler::XMLParser]
       def confirm_transport_request(shipment_id)
         operation('ConfirmTransportRequest').add('ShipmentId' => shipment_id)
@@ -123,7 +111,7 @@ module MWS
       # an Amazon-partnered carrier
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_VoidTransportRequest.html
-      # @param shipment_id [String]
+      # @param [String] shipment_id
       # @return [Peddler::XMLParser]
       def void_transport_request(shipment_id)
         operation('VoidTransportRequest').add('ShipmentId' => shipment_id)
@@ -134,9 +122,9 @@ module MWS
       # shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetPackageLabels.html
-      # @param shipment_id [String]
-      # @param page_type [String]
-      # @param opts [Hash]
+      # @param [String] shipment_id
+      # @param [String] page_type
+      # @param [Hash] opts
       # @option opts [Integer] :number_of_packages
       # @return [Peddler::XMLParser]
       def get_package_labels(shipment_id, page_type, opts = {})
@@ -153,7 +141,7 @@ module MWS
       # shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetBillOfLading.html
-      # @param shipment_id [String]
+      # @param [String] shipment_id
       # @return [Peddler::XMLParser]
       def get_bill_of_lading(shipment_id)
         operation('GetBillOfLading').add('ShipmentId' => shipment_id)
@@ -163,7 +151,7 @@ module MWS
       # Returns a list of inbound shipments based on criteria that you specify
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_ListInboundShipments.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [Array<String>] :shipment_status_list
       # @option opts [Array<String>] :shipment_id_list
       # @option opts [String, #iso8601] :last_updated_after
@@ -181,7 +169,7 @@ module MWS
       # Returns the next page of inbound shipments
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_ListInboundShipmentsByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_inbound_shipments_by_next_token(next_token)
         operation('ListInboundShipmentsByNextToken')
@@ -194,7 +182,7 @@ module MWS
       # items that were updated within a specified time frame
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_ListInboundShipmentItems.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [String] :shipment_id
       # @option opts [String, #iso8601] :last_updated_after
       # @option opts [String, #iso8601] :last_updated_before
@@ -207,7 +195,7 @@ module MWS
       # Returns the next page of inbound shipment items
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_ListInboundShipmentItemsByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_inbound_shipment_items_by_next_token(next_token)
         operation('ListInboundShipmentItemsByNextToken')
@@ -224,6 +212,19 @@ module MWS
         operation('GetServiceStatus')
         run
       end
+
+      private
+
+      def build_inbound_shipment_operation(operation_name, shipment_id, inbound_shipment_header, opts)
+        operation(operation_name)
+          .add(
+            opts.update(
+              'ShipmentId' => shipment_id,
+              'InboundShipmentHeader' => inbound_shipment_header
+            )
+          )
+          .structure!('InboundShipmentItems', 'member')
+      end
     end
   end
 end