peddler 3.0.0.beta1 → 4.0.0

data/lib/peddler/apis/vendor_direct_fulfillment_shipping_v1.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def vendor_direct_fulfillment_shipping_v1(...)
+      APIs::VendorDirectFulfillmentShippingV1.new(...)
+    end
+  end
+
+  module APIs
+    # Selling Partner API for Direct Fulfillment Shipping
+    #
+    # The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment
+    # vendor's shipping data.
+    class VendorDirectFulfillmentShippingV1 < API
+      # Returns a list of shipping labels created during the time frame that you specify. You define that time frame
+      # using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to
+      # search must not be more than 7 days.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified, the result
+      #   will contain orders for all warehouses.
+      # @param limit [Integer] The limit to the number of records returned.
+      # @param created_after [String] Shipping labels that became available after this date and time will be included in
+      #   the result. Must be in ISO-8601 date/time format.
+      # @param created_before [String] Shipping labels that became available before this date and time will be included
+      #   in the result. Must be in ISO-8601 date/time format.
+      # @param sort_order [String] Sort ASC or DESC by order creation date.
+      # @param next_token [String] Used for pagination when there are more ship labels than the specified result size
+      #   limit. The token value is returned in the previous API call.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC",
+        next_token: nil, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/shippingLabels"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Creates a shipping label for a purchase order and returns a transactionId for reference.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Request body containing one or more shipping labels data.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_shipping_label_request(body, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/shippingLabels"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Returns a shipping label for the purchaseOrderNumber that you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param purchase_order_number [String] The purchase order number for which you want to return the shipping label.
+      #   It should be the same purchaseOrderNumber as received in the order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_shipping_label(purchase_order_number, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/shippingLabels/#{purchase_order_number}"
+
+        meter(rate_limit).get(path)
+      end
+
+      # Submits one or more shipment confirmations for vendor orders.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Request body containing the shipment confirmations data.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_shipment_confirmations(body, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/shipmentConfirmations"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment
+      # status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their
+      # order, when the package is outside of Amazon Network visibility.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Request body containing the shipment status update data.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_shipment_status_updates(body, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Returns a list of customer invoices created during a time frame that you specify. You define the time frame
+      # using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to
+      # search must be no more than 7 days.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified, the result
+      #   will contain orders for all warehouses.
+      # @param limit [Integer] The limit to the number of records returned
+      # @param created_after [String] Orders that became available after this date and time will be included in the
+      #   result. Must be in ISO-8601 date/time format.
+      # @param created_before [String] Orders that became available before this date and time will be included in the
+      #   result. Must be in ISO-8601 date/time format.
+      # @param sort_order [String] Sort ASC or DESC by order creation date.
+      # @param next_token [String] Used for pagination when there are more orders than the specified result size limit.
+      #   The token value is returned in the previous API call.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/customerInvoices"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Returns a customer invoice based on the purchaseOrderNumber that you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param purchase_order_number [String] Purchase order number of the shipment for which to return the invoice.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_customer_invoice(purchase_order_number, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/customerInvoices/#{purchase_order_number}"
+
+        meter(rate_limit).get(path)
+      end
+
+      # Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search
+      # must not be more than 7 days.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified the result
+      #   will contain orders for all warehouses.
+      # @param limit [Integer] The limit to the number of records returned
+      # @param created_after [String] Packing slips that became available after this date and time will be included in
+      #   the result. Must be in ISO-8601 date/time format.
+      # @param created_before [String] Packing slips that became available before this date and time will be included in
+      #   the result. Must be in ISO-8601 date/time format.
+      # @param sort_order [String] Sort ASC or DESC by packing slip creation date.
+      # @param next_token [String] Used for pagination when there are more packing slips than the specified result size
+      #   limit. The token value is returned in the previous API call.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC",
+        next_token: nil, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/packingSlips"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Returns a packing slip based on the purchaseOrderNumber that you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param purchase_order_number [String] The purchaseOrderNumber for the packing slip you want.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_packing_slip(purchase_order_number, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/v1/packingSlips/#{purchase_order_number}"
+
+        meter(rate_limit).get(path)
+      end
+    end
+  end
+end

data/lib/peddler/{api → apis}/vendor_direct_fulfillment_transactions_2021_12_28.rb

@@ -3,21 +3,29 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def vendor_direct_fulfillment_transactions_2021_12_28(...)
+      APIs::VendorDirectFulfillmentTransactions20211228.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Direct Fulfillment Transaction Status
     #
     # The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct
     # fulfillment vendor's transaction status.
     class VendorDirectFulfillmentTransactions20211228 < API
-      # Returns the status of the transaction indicated by the specified `transactionId`.
+      # Returns the status of the transaction indicated by the specified transactionId.
       #
-      # @param [String] transaction_id Previously returned in the response to the POST request of a specific
+      # @note This operation can make a dynamic sandbox call.
+      # @param transaction_id [String] Previously returned in the response to the POST request of a specific
       #   transaction.
-      # @return [Hash] The API response
-      def get_transaction_status(transaction_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_transaction_status(transaction_id, rate_limit: 10.0)
         path = "/vendor/directFulfillment/transactions/2021-12-28/transactions/#{transaction_id}"
 
-        rate_limit(10.0).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end

data/lib/peddler/{api → apis}/vendor_direct_fulfillment_transactions_v1.rb

@@ -3,21 +3,29 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def vendor_direct_fulfillment_transactions_v1(...)
+      APIs::VendorDirectFulfillmentTransactionsV1.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Direct Fulfillment Transaction Status
     #
     # The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct
     # fulfillment vendor's transaction status.
     class VendorDirectFulfillmentTransactionsV1 < API
-      # Returns the status of the transaction indicated by the specified `transactionId`.
+      # Returns the status of the transaction indicated by the specified transactionId.
       #
-      # @param [String] transaction_id Previously returned in the response to the POST request of a specific
+      # @note This operation can make a static sandbox call.
+      # @param transaction_id [String] Previously returned in the response to the POST request of a specific
       #   transaction.
-      # @return [Hash] The API response
-      def get_transaction_status(transaction_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_transaction_status(transaction_id, rate_limit: 10.0)
         path = "/vendor/directFulfillment/transactions/v1/transactions/#{transaction_id}"
 
-        rate_limit(10.0).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end

data/lib/peddler/apis/vendor_invoices_v1.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def vendor_invoices_v1(...)
+      APIs::VendorInvoicesV1.new(...)
+    end
+  end
+
+  module APIs
+    # Vendor Invoices v1
+    #
+    # The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data.
+    class VendorInvoicesV1 < API
+      # Submit new invoices to Amazon.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body containing the invoice data to submit.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_invoices(body, rate_limit: 10.0)
+        path = "/vendor/payments/v1/invoices"
+
+        meter(rate_limit).post(path, body:)
+      end
+    end
+  end
+end

data/lib/peddler/{api → apis}/vendor_orders_v1.rb

@@ -3,7 +3,13 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def vendor_orders_v1(...)
+      APIs::VendorOrdersV1.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Retail Procurement Orders
     #
     # The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
@@ -14,37 +20,37 @@ module Peddler
       # `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific
       # purchase order.
       #
-      # @param [Integer] limit The limit to the number of records returned. Default value is 100 records.
-      # @param [String] created_after Purchase orders that became available after this time will be included in the
+      # @note This operation can make a static sandbox call.
+      # @param limit [Integer] The limit to the number of records returned. Default value is 100 records.
+      # @param created_after [String] Purchase orders that became available after this time will be included in the
       #   result. Must be in ISO-8601 date/time format.
-      # @param [String] created_before Purchase orders that became available before this time will be included in the
+      # @param created_before [String] Purchase orders that became available before this time will be included in the
       #   result. Must be in ISO-8601 date/time format.
-      # @param [String] sort_order Sort in ascending or descending order by purchase order creation date.
-      # @param [String] next_token Used for pagination when there is more purchase orders than the specified result size
+      # @param sort_order [String] Sort in ascending or descending order by purchase order creation date.
+      # @param next_token [String] Used for pagination when there is more purchase orders than the specified result size
       #   limit. The token value is returned in the previous API call
-      # @param [String] include_details When true, returns purchase orders with complete details. Otherwise, only
+      # @param include_details [String] When true, returns purchase orders with complete details. Otherwise, only
       #   purchase order numbers are returned. Default value is true.
-      # @param [String] changed_after Purchase orders that changed after this timestamp will be included in the result.
+      # @param changed_after [String] Purchase orders that changed after this timestamp will be included in the result.
       #   Must be in ISO-8601 date/time format.
-      # @param [String] changed_before Purchase orders that changed before this timestamp will be included in the
+      # @param changed_before [String] Purchase orders that changed before this timestamp will be included in the
       #   result. Must be in ISO-8601 date/time format.
-      # @param [String] po_item_state Current state of the purchase order item. If this value is Cancelled, this API
+      # @param po_item_state [String] Current state of the purchase order item. If this value is Cancelled, this API
       #   will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as
       #   zero.
-      # @param [String] is_po_changed When true, returns purchase orders which were modified after the order was placed.
+      # @param is_po_changed [String] When true, returns purchase orders which were modified after the order was placed.
       #   Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the
       #   original one. Default value is false.
-      # @param [String] purchase_order_state Filters purchase orders based on the purchase order state.
-      # @param [String] ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This
+      # @param purchase_order_state [String] Filters purchase orders based on the purchase order state.
+      # @param ordering_vendor_code [String] Filters purchase orders based on the specified ordering vendor code. This
       #   value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all
       #   purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client
       #   application are returned.
-      # @return [Hash] The API response
-      def get_purchase_orders(
-        limit: nil, created_after: nil, created_before: nil, sort_order: nil, next_token: nil, include_details: nil,
-        changed_after: nil, changed_before: nil, po_item_state: nil, is_po_changed: nil, purchase_order_state: nil,
-        ordering_vendor_code: nil
-      )
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_purchase_orders(limit: nil, created_after: nil, created_before: nil, sort_order: nil, next_token: nil,
+        include_details: nil, changed_after: nil, changed_before: nil, po_item_state: nil, is_po_changed: nil,
+        purchase_order_state: nil, ordering_vendor_code: nil, rate_limit: 10.0)
         path = "/vendor/orders/v1/purchaseOrders"
         params = {
           "limit" => limit,
@@ -61,69 +67,74 @@ module Peddler
           "orderingVendorCode" => ordering_vendor_code,
         }.compact
 
-        rate_limit(10.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Returns a purchase order based on the `purchaseOrderNumber` value that you specify.
       #
-      # @param [String] purchase_order_number The purchase order identifier for the order that you want. Formatting
+      # @note This operation can make a static sandbox call.
+      # @param purchase_order_number [String] The purchase order identifier for the order that you want. Formatting
       #   Notes: 8-character alpha-numeric code.
-      # @return [Hash] The API response
-      def get_purchase_order(purchase_order_number)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_purchase_order(purchase_order_number, rate_limit: 10.0)
         path = "/vendor/orders/v1/purchaseOrders/#{purchase_order_number}"
 
-        rate_limit(10.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Submits acknowledgements for one or more purchase orders.
       #
-      # @param [Hash] body
-      # @return [Hash] The API response
-      def submit_acknowledgement(body)
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Submits acknowledgements for one or more purchase orders from a vendor.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_acknowledgement(body, rate_limit: 10.0)
         path = "/vendor/orders/v1/acknowledgements"
 
-        rate_limit(10.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Returns purchase order statuses based on the filters that you specify. Date range to search must not be more
       # than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase
       # order status by providing the purchase order number.
       #
-      # @param [Integer] limit The limit to the number of records returned. Default value is 100 records.
-      # @param [String] sort_order Sort in ascending or descending order by purchase order creation date.
-      # @param [String] next_token Used for pagination when there are more purchase orders than the specified result
+      # @note This operation can make a static sandbox call.
+      # @param limit [Integer] The limit to the number of records returned. Default value is 100 records.
+      # @param sort_order [String] Sort in ascending or descending order by purchase order creation date.
+      # @param next_token [String] Used for pagination when there are more purchase orders than the specified result
       #   size limit.
-      # @param [String] created_after Purchase orders that became available after this timestamp will be included in the
+      # @param created_after [String] Purchase orders that became available after this timestamp will be included in the
       #   result. Must be in ISO-8601 date/time format.
-      # @param [String] created_before Purchase orders that became available before this timestamp will be included in
+      # @param created_before [String] Purchase orders that became available before this timestamp will be included in
       #   the result. Must be in ISO-8601 date/time format.
-      # @param [String] updated_after Purchase orders for which the last purchase order update happened after this
+      # @param updated_after [String] Purchase orders for which the last purchase order update happened after this
       #   timestamp will be included in the result. Must be in ISO-8601 date/time format.
-      # @param [String] updated_before Purchase orders for which the last purchase order update happened before this
+      # @param updated_before [String] Purchase orders for which the last purchase order update happened before this
       #   timestamp will be included in the result. Must be in ISO-8601 date/time format.
-      # @param [String] purchase_order_number Provides purchase order status for the specified purchase order number.
-      # @param [String] purchase_order_status Filters purchase orders based on the specified purchase order status. If
+      # @param purchase_order_number [String] Provides purchase order status for the specified purchase order number.
+      # @param purchase_order_status [String] Filters purchase orders based on the specified purchase order status. If
       #   not included in filter, this will return purchase orders for all statuses.
-      # @param [String] item_confirmation_status Filters purchase orders based on their item confirmation status. If the
+      # @param item_confirmation_status [String] Filters purchase orders based on their item confirmation status. If the
       #   item confirmation status is not included in the filter, purchase orders for all confirmation statuses are
       #   included.
-      # @param [String] item_receive_status Filters purchase orders based on the purchase order's item receive status.
+      # @param item_receive_status [String] Filters purchase orders based on the purchase order's item receive status.
       #   If the item receive status is not included in the filter, purchase orders for all receive statuses are
       #   included.
-      # @param [String] ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This
+      # @param ordering_vendor_code [String] Filters purchase orders based on the specified ordering vendor code. This
       #   value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase
       #   orders for all the vendor codes that exist in the vendor group used to authorize API client application are
       #   returned.
-      # @param [String] ship_to_party_id Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by
+      # @param ship_to_party_id [String] Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by
       #   providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order.
       #   If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor
       #   group purchase orders.
-      # @return [Hash] The API response
-      def get_purchase_orders_status(
-        limit: nil, sort_order: nil, next_token: nil, created_after: nil, created_before: nil, updated_after: nil,
-        updated_before: nil, purchase_order_number: nil, purchase_order_status: nil, item_confirmation_status: nil,
-        item_receive_status: nil, ordering_vendor_code: nil, ship_to_party_id: nil
-      )
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_purchase_orders_status(limit: nil, sort_order: nil, next_token: nil, created_after: nil,
+        created_before: nil, updated_after: nil, updated_before: nil, purchase_order_number: nil,
+        purchase_order_status: nil, item_confirmation_status: nil, item_receive_status: nil, ordering_vendor_code: nil,
+        ship_to_party_id: nil, rate_limit: 10.0)
         path = "/vendor/orders/v1/purchaseOrdersStatus"
         params = {
           "limit" => limit,
@@ -141,7 +152,7 @@ module Peddler
           "shipToPartyId" => ship_to_party_id,
         }.compact
 
-        rate_limit(10.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end

data/lib/peddler/apis/vendor_shipments_v1.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def vendor_shipments_v1(...)
+      APIs::VendorShipmentsV1.new(...)
+    end
+  end
+
+  module APIs
+    # Vendor Shipments v1
+    #
+    # The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for
+    # vendors.
+    class VendorShipmentsV1 < API
+      # Submits one or more shipment confirmations for vendor orders.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] A request to submit shipment confirmation.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_shipment_confirmations(body, rate_limit: 10.0)
+        path = "/vendor/shipping/v1/shipmentConfirmations"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Submits one or more shipment request for vendor Orders.
+      #
+      # @param body [Hash] A request to submit shipment request.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def submit_shipments(body, rate_limit: 10.0)
+        cannot_sandbox!
+
+        path = "/vendor/shipping/v1/shipments"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details
+      # related to shipment based on the filter parameters value that you specify.
+      #
+      # @param limit [Integer] The limit to the number of records returned. Default value is 50 records.
+      # @param sort_order [String] Sort in ascending or descending order by purchase order creation date.
+      # @param next_token [String] Used for pagination when there are more shipments than the specified result size
+      #   limit.
+      # @param created_after [String] Get Shipment Details that became available after this timestamp will be included
+      #   in the result. Must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param created_before [String] Get Shipment Details that became available before this timestamp will be included
+      #   in the result. Must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param shipment_confirmed_before [String] Get Shipment Details by passing Shipment confirmed create Date Before.
+      #   Must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param shipment_confirmed_after [String] Get Shipment Details by passing Shipment confirmed create Date After.
+      #   Must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param package_label_created_before [String] Get Shipment Details by passing Package label create Date by buyer.
+      #   Must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param package_label_created_after [String] Get Shipment Details by passing Package label create Date After by
+      #   buyer. Must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param shipped_before [String] Get Shipment Details by passing Shipped Date Before. Must be in
+      #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param shipped_after [String] Get Shipment Details by passing Shipped Date After. Must be in
+      #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param estimated_delivery_before [String] Get Shipment Details by passing Estimated Delivery Date Before. Must
+      #   be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param estimated_delivery_after [String] Get Shipment Details by passing Estimated Delivery Date Before. Must be
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param shipment_delivery_before [String] Get Shipment Details by passing Shipment Delivery Date Before. Must be
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param shipment_delivery_after [String] Get Shipment Details by passing Shipment Delivery Date After. Must be in
+      #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param requested_pick_up_before [String] Get Shipment Details by passing Before Requested pickup date. Must be
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param requested_pick_up_after [String] Get Shipment Details by passing After Requested pickup date. Must be in
+      #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param scheduled_pick_up_before [String] Get Shipment Details by passing Before scheduled pickup date. Must be
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param scheduled_pick_up_after [String] Get Shipment Details by passing After Scheduled pickup date. Must be in
+      #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param current_shipment_status [String] Get Shipment Details by passing Current shipment status.
+      # @param vendor_shipment_identifier [String] Get Shipment Details by passing Vendor Shipment ID
+      # @param buyer_reference_number [String] Get Shipment Details by passing buyer Reference ID
+      # @param buyer_warehouse_code [String] Get Shipping Details based on buyer warehouse code. This value should be
+      #   same as 'shipToParty.partyId' in the Shipment.
+      # @param seller_warehouse_code [String] Get Shipping Details based on vendor warehouse code. This value should be
+      #   same as 'sellingParty.partyId' in the Shipment.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_shipment_details(limit: nil, sort_order: nil, next_token: nil, created_after: nil, created_before: nil,
+        shipment_confirmed_before: nil, shipment_confirmed_after: nil, package_label_created_before: nil,
+        package_label_created_after: nil, shipped_before: nil, shipped_after: nil, estimated_delivery_before: nil,
+        estimated_delivery_after: nil, shipment_delivery_before: nil, shipment_delivery_after: nil,
+        requested_pick_up_before: nil, requested_pick_up_after: nil, scheduled_pick_up_before: nil,
+        scheduled_pick_up_after: nil, current_shipment_status: nil, vendor_shipment_identifier: nil,
+        buyer_reference_number: nil, buyer_warehouse_code: nil, seller_warehouse_code: nil, rate_limit: 10.0)
+        cannot_sandbox!
+
+        path = "/vendor/shipping/v1/shipments"
+        params = {
+          "limit" => limit,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "shipmentConfirmedBefore" => shipment_confirmed_before,
+          "shipmentConfirmedAfter" => shipment_confirmed_after,
+          "packageLabelCreatedBefore" => package_label_created_before,
+          "packageLabelCreatedAfter" => package_label_created_after,
+          "shippedBefore" => shipped_before,
+          "shippedAfter" => shipped_after,
+          "estimatedDeliveryBefore" => estimated_delivery_before,
+          "estimatedDeliveryAfter" => estimated_delivery_after,
+          "shipmentDeliveryBefore" => shipment_delivery_before,
+          "shipmentDeliveryAfter" => shipment_delivery_after,
+          "requestedPickUpBefore" => requested_pick_up_before,
+          "requestedPickUpAfter" => requested_pick_up_after,
+          "scheduledPickUpBefore" => scheduled_pick_up_before,
+          "scheduledPickUpAfter" => scheduled_pick_up_after,
+          "currentShipmentStatus" => current_shipment_status,
+          "vendorShipmentIdentifier" => vendor_shipment_identifier,
+          "buyerReferenceNumber" => buyer_reference_number,
+          "buyerWarehouseCode" => buyer_warehouse_code,
+          "sellerWarehouseCode" => seller_warehouse_code,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+    end
+  end
+end

data/lib/peddler/{api → apis}/vendor_transaction_status_v1.rb

@@ -3,7 +3,13 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def vendor_transaction_status_v1(...)
+      APIs::VendorTransactionStatusV1.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Retail Procurement Transaction Status
     #
     # The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status
@@ -11,13 +17,16 @@ module Peddler
     class VendorTransactionStatusV1 < API
       # Returns the status of the transaction that you specify.
       #
-      # @param [String] transaction_id The GUID provided by Amazon in the 'transactionId' field in response to the post
+      # @param transaction_id [String] The GUID provided by Amazon in the 'transactionId' field in response to the post
       #   request of a specific transaction.
-      # @return [Hash] The API response
-      def get_transaction(transaction_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_transaction(transaction_id, rate_limit: 10.0)
+        cannot_sandbox!
+
         path = "/vendor/transactions/v1/transactions/#{transaction_id}"
 
-        rate_limit(10.0).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end