Class: Peddler::APIs::MerchantFulfillmentV0

Inherits:

Peddler::API

• Object
• Peddler::API
• Peddler::APIs::MerchantFulfillmentV0

Defined in:

lib/peddler/apis/merchant_fulfillment_v0.rb,
lib/peddler/apis/merchant_fulfillment_v0/item.rb,
lib/peddler/apis/merchant_fulfillment_v0/error.rb,
lib/peddler/apis/merchant_fulfillment_v0/label.rb,
lib/peddler/apis/merchant_fulfillment_v0/length.rb,
lib/peddler/apis/merchant_fulfillment_v0/weight.rb,
lib/peddler/apis/merchant_fulfillment_v0/address.rb,
lib/peddler/apis/merchant_fulfillment_v0/benefits.rb,
lib/peddler/apis/merchant_fulfillment_v0/shipment.rb,
lib/peddler/apis/merchant_fulfillment_v0/item_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/rate_item.rb,
lib/peddler/apis/merchant_fulfillment_v0/constraint.rb,
lib/peddler/apis/merchant_fulfillment_v0/error_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/constraints.rb,
lib/peddler/apis/merchant_fulfillment_v0/file_contents.rb,
lib/peddler/apis/merchant_fulfillment_v0/liquid_volume.rb,
lib/peddler/apis/merchant_fulfillment_v0/excluded_benefit.rb,
lib/peddler/apis/merchant_fulfillment_v0/label_dimensions.rb,
lib/peddler/apis/merchant_fulfillment_v0/shipping_service.rb,
lib/peddler/apis/merchant_fulfillment_v0/additional_inputs.rb,
lib/peddler/apis/merchant_fulfillment_v0/excluded_benefits.rb,
lib/peddler/apis/merchant_fulfillment_v0/included_benefits.rb,
lib/peddler/apis/merchant_fulfillment_v0/item_level_fields.rb,
lib/peddler/apis/merchant_fulfillment_v0/label_format_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/package_dimensions.rb,
lib/peddler/apis/merchant_fulfillment_v0/label_customization.rb,
lib/peddler/apis/merchant_fulfillment_v0/label_format_option.rb,
lib/peddler/apis/merchant_fulfillment_v0/adjustment_item_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_shipment_response.rb,
lib/peddler/apis/merchant_fulfillment_v0/restricted_set_values.rb,
lib/peddler/apis/merchant_fulfillment_v0/shipping_service_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/additional_inputs_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/item_level_fields_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/transparency_code_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/additional_seller_input.rb,
lib/peddler/apis/merchant_fulfillment_v0/create_shipment_request.rb,
lib/peddler/apis/merchant_fulfillment_v0/dangerous_goods_details.rb,
lib/peddler/apis/merchant_fulfillment_v0/seller_input_definition.rb,
lib/peddler/apis/merchant_fulfillment_v0/additional_seller_inputs.rb,
lib/peddler/apis/merchant_fulfillment_v0/cancel_shipment_response.rb,
lib/peddler/apis/merchant_fulfillment_v0/create_shipment_response.rb,
lib/peddler/apis/merchant_fulfillment_v0/shipment_request_details.rb,
lib/peddler/apis/merchant_fulfillment_v0/shipping_offering_filter.rb,
lib/peddler/apis/merchant_fulfillment_v0/shipping_service_options.rb,
lib/peddler/apis/merchant_fulfillment_v0/rejected_shipping_service.rb,
lib/peddler/apis/merchant_fulfillment_v0/label_format_option_request.rb,
lib/peddler/apis/merchant_fulfillment_v0/additional_seller_inputs_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/excluded_benefit_reason_codes.rb,
lib/peddler/apis/merchant_fulfillment_v0/rejected_shipping_service_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/temporarily_unavailable_carrier.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_format_options_for_label.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_shipping_service_options.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_additional_seller_inputs_result.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_delivery_experience_option.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_additional_seller_inputs_request.rb,
lib/peddler/apis/merchant_fulfillment_v0/temporarily_unavailable_carrier_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_carrier_will_pick_up_option.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_additional_seller_inputs_response.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_eligible_shipment_services_result.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_eligible_shipment_services_request.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_format_options_for_label_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/get_eligible_shipment_services_response.rb,
lib/peddler/apis/merchant_fulfillment_v0/terms_and_conditions_not_accepted_carrier.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_delivery_experience_options_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/available_carrier_will_pick_up_options_list.rb,
lib/peddler/apis/merchant_fulfillment_v0/terms_and_conditions_not_accepted_carrier_list.rb,
sig/peddler/apis/merchant_fulfillment_v0.rbs

Overview

Selling Partner API for Merchant Fulfillment

With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon's Buy Shipping Services.

See Also:

• https://github.com/amzn/selling-partner-api-models/blob/main/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json

Defined Under Namespace

Classes: AdditionalInputs, AdditionalInputsList, AdditionalSellerInput, AdditionalSellerInputs, AdditionalSellerInputsList, Address, AdjustmentItemList, AvailableCarrierWillPickUpOption, AvailableCarrierWillPickUpOptionsList, AvailableDeliveryExperienceOption, AvailableDeliveryExperienceOptionsList, AvailableFormatOptionsForLabel, AvailableFormatOptionsForLabelList, AvailableShippingServiceOptions, Benefits, CancelShipmentResponse, Constraint, Constraints, CreateShipmentRequest, CreateShipmentResponse, DangerousGoodsDetails, Error, ErrorList, ExcludedBenefit, ExcludedBenefitReasonCodes, ExcludedBenefits, FileContents, GetAdditionalSellerInputsRequest, GetAdditionalSellerInputsResponse, GetAdditionalSellerInputsResult, GetEligibleShipmentServicesRequest, GetEligibleShipmentServicesResponse, GetEligibleShipmentServicesResult, GetShipmentResponse, IncludedBenefits, Item, ItemLevelFields, ItemLevelFieldsList, ItemList, Label, LabelCustomization, LabelDimensions, LabelFormatList, LabelFormatOption, LabelFormatOptionRequest, Length, LiquidVolume, PackageDimensions, RateItem, RejectedShippingService, RejectedShippingServiceList, RestrictedSetValues, SellerInputDefinition, Shipment, ShipmentRequestDetails, ShippingOfferingFilter, ShippingService, ShippingServiceList, ShippingServiceOptions, TemporarilyUnavailableCarrier, TemporarilyUnavailableCarrierList, TermsAndConditionsNotAcceptedCarrier, TermsAndConditionsNotAcceptedCarrierList, TransparencyCodeList, Weight

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary

• #cancel_shipment(shipment_id, rate_limit: 1.0) ⇒ Peddler::Response

  Cancel the shipment indicated by the specified shipment identifier.

• #create_shipment(body, rate_limit: 2.0) ⇒ Peddler::Response

  Create a shipment with the information provided.

• #get_additional_seller_inputs(body, rate_limit: 1.0) ⇒ Peddler::Response

  Gets a list of additional seller inputs required for a ship method.

• #get_eligible_shipment_services(body, rate_limit: 6.0) ⇒ Peddler::Response

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

• #get_shipment(shipment_id, rate_limit: 1.0) ⇒ Peddler::Response

  Returns the shipment information for an existing shipment.

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_shipment(shipment_id, rate_limit: 1.0) ⇒ Peddler::Response

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

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

Returns:

• (Peddler::Response) —

  The API response

# File 'lib/peddler/apis/merchant_fulfillment_v0.rb', line 44

def cancel_shipment(shipment_id, rate_limit: 1.0)
  path = "/mfn/v0/shipments/#{percent_encode(shipment_id)}"
  parser = -> { CancelShipmentResponse }
  delete(path, rate_limit:, parser:)
end

#create_shipment(body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Create a shipment with the information provided.

Parameters:

• body (Hash) —

  The request schema for the CreateShipment operation.

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

  Requests per second

• (Hash[untyped, untyped])
• rate_limit: (Float) (defaults to: 2.0)

Returns:

• (Peddler::Response) —

  The API response

# File 'lib/peddler/apis/merchant_fulfillment_v0.rb', line 56

def create_shipment(body, rate_limit: 2.0)
  path = "/mfn/v0/shipments"
  parser = -> { CreateShipmentResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_additional_seller_inputs(body, rate_limit: 1.0) ⇒ Peddler::Response

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) —

  The request schema for the GetAdditionalSellerInputs operation.

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

  Requests per second

• (Hash[untyped, untyped])
• rate_limit: (Float) (defaults to: 1.0)

Returns:

• (Peddler::Response) —

  The API response

# File 'lib/peddler/apis/merchant_fulfillment_v0.rb', line 69

def get_additional_seller_inputs(body, rate_limit: 1.0)
  path = "/mfn/v0/additionalSellerInputs"
  parser = -> { GetAdditionalSellerInputsResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_eligible_shipment_services(body, rate_limit: 6.0) ⇒ Peddler::Response

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) —

  The request schema for the GetEligibleShipmentServices operation.

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

  Requests per second

• (Hash[untyped, untyped])
• rate_limit: (Float) (defaults to: 6.0)

Returns:

• (Peddler::Response) —

  The API response

# File 'lib/peddler/apis/merchant_fulfillment_v0.rb', line 20

def get_eligible_shipment_services(body, rate_limit: 6.0)
  path = "/mfn/v0/eligibleShippingServices"
  parser = -> { GetEligibleShipmentServicesResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_shipment(shipment_id, rate_limit: 1.0) ⇒ Peddler::Response

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

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

Returns:

• (Peddler::Response) —

  The API response

# File 'lib/peddler/apis/merchant_fulfillment_v0.rb', line 32

def get_shipment(shipment_id, rate_limit: 1.0)
  path = "/mfn/v0/shipments/#{percent_encode(shipment_id)}"
  parser = -> { GetShipmentResponse }
  get(path, rate_limit:, parser:)
end