Class: Peddler::API::MerchantFulfillmentV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/api/merchant_fulfillment_v0.rb

Overview

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.

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #endpoint_uri, #http, #initialize, #meter, #must_sandbox!, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_shipment(shipment_id, rate_limit: 1.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Cancel the shipment indicated by the specified shipment identifier.

Parameters:

  • shipment_id (String) —

    The Amazon-defined shipment identifier for the shipment to cancel.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

Returns:

  • (Hash) —

    The API response



49
50
51
52
53
 
# File 'lib/peddler/api/merchant_fulfillment_v0.rb', line 49

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) ⇒ Hash

Note:

This operation can make a static sandbox call.

Create a shipment with the information provided.

Parameters:

  • body (Hash) —

    Request schema for CreateShipment operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

Returns:

  • (Hash) —

    The API response



61
62
63
64
65
 
# File 'lib/peddler/api/merchant_fulfillment_v0.rb', line 61

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) ⇒ Hash

Note:

This operation can make a static sandbox call.

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

Parameters:

  • body (Hash) —

    Request schema for GetAdditionalSellerInputs operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

Returns:

  • (Hash) —

    The API response



74
75
76
77
78
 
# File 'lib/peddler/api/merchant_fulfillment_v0.rb', line 74

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) ⇒ Hash

Note:

This operation can make a static sandbox call.

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

Parameters:

  • body (Hash) —

    Request schema for GetEligibleShipmentServices operation.

  • rate_limit (Float) (defaults to: 5.0) —

    Requests per second

Returns:

  • (Hash) —

    The API response



25
26
27
28
29
 
# File 'lib/peddler/api/merchant_fulfillment_v0.rb', line 25

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) ⇒ Hash

Note:

This operation can make a static sandbox call.

Returns the shipment information for an existing shipment.

Parameters:

  • shipment_id (String) —

    The Amazon-defined shipment identifier for the shipment.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

Returns:

  • (Hash) —

    The API response



37
38
39
40
41
 
# File 'lib/peddler/api/merchant_fulfillment_v0.rb', line 37

def get_shipment(shipment_id, rate_limit: 1.0)
  path = "/mfn/v0/shipments/#{shipment_id}"

  meter(rate_limit).get(path)
end