class Peddler::API::MerchantFulfillmentV0

Selling Partner API for Merchant Fulfillment

The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services.

Public Instance Methods

cancel_shipment(shipment_id, rate_limit: 1.0) click to toggle source

Cancel the shipment indicated by the specified shipment identifier.

@note This operation can make a static sandbox call. @param shipment_id [String] The Amazon-defined shipment identifier for the shipment to cancel. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/merchant_fulfillment_v0.rb, line 48
def cancel_shipment(shipment_id, rate_limit: 1.0)
  path = "/mfn/v0/shipments/#{shipment_id}"

  meter(rate_limit).delete(path)
end
create_shipment(body, rate_limit: 1.0) click to toggle source

Create a shipment with the information provided.

@note This operation can make a static sandbox call. @param body [Hash] Request schema for CreateShipment operation. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/merchant_fulfillment_v0.rb, line 60
def create_shipment(body, rate_limit: 1.0)
  path = "/mfn/v0/shipments"

  meter(rate_limit).post(path, body:)
end
get_additional_seller_inputs(body, rate_limit: 1.0) click to toggle source

Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.

@note This operation can make a static sandbox call. @param body [Hash] Request schema for GetAdditionalSellerInputs operation. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/merchant_fulfillment_v0.rb, line 73
def get_additional_seller_inputs(body, rate_limit: 1.0)
  path = "/mfn/v0/additionalSellerInputs"

  meter(rate_limit).post(path, body:)
end
get_eligible_shipment_services(body, rate_limit: 5.0) click to toggle source

Returns a list of shipping service offers that satisfy the specified shipment request details.

@note This operation can make a static sandbox call. @param body [Hash] Request schema for GetEligibleShipmentServices operation. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/merchant_fulfillment_v0.rb, line 24
def get_eligible_shipment_services(body, rate_limit: 5.0)
  path = "/mfn/v0/eligibleShippingServices"

  meter(rate_limit).post(path, body:)
end
get_shipment(shipment_id, rate_limit: 1.0) click to toggle source

Returns the shipment information for an existing shipment.

@note This operation can make a static sandbox call. @param shipment_id [String] The Amazon-defined shipment identifier for the shipment. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/merchant_fulfillment_v0.rb, line 36
def get_shipment(shipment_id, rate_limit: 1.0)
  path = "/mfn/v0/shipments/#{shipment_id}"

  meter(rate_limit).get(path)
end