Class: Peddler::API::FBAInboundEligibilityV1

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

Overview

Selling Partner API for FBA Inbound Eligibilty

With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon's fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon's fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon's fulfillment centers.

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

#get_item_eligibility_preview(asin, program, marketplace_ids: nil, rate_limit: 1.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility.

Parameters:

  • marketplace_ids (Array<String>) (defaults to: nil) —

    The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.

  • asin (String) —

    The ASIN of the item for which you want an eligibility preview.

  • program (String) —

    The program that you want to check eligibility against.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/peddler/api/fba_inbound_eligibility_v1.rb', line 33

def get_item_eligibility_preview(asin, program, marketplace_ids: nil, rate_limit: 1.0)
  path = "/fba/inbound/v1/eligibility/itemPreview"
  params = {
    "marketplaceIds" => marketplace_ids,
    "asin" => asin,
    "program" => program,
  }.compact

  meter(rate_limit).get(path, params:)
end