Selling Partner API SDK for JavaScript
    Preparing search index...

    Module @sp-api-sdk/fba-inbound-eligibility-api-v1 - v4.1.0

    fba-inbound-eligibility-api-v1

    npm version XO code style

    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.

    Bizon

    Learn more about this Selling Partner API by visiting the official documentation.

    Also, see the generated documentation for this API client.

    npm install @sp-api-sdk/fba-inbound-eligibility-api-v1
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {FbaInboundEligibilityApiClient} from '@sp-api-sdk/fba-inbound-eligibility-api-v1'

    const auth = new SellingPartnerApiAuth({
    clientId: process.env.LWA_CLIENT_ID,
    clientSecret: process.env.LWA_CLIENT_SECRET,
    refreshToken: 'Atzr|…',
    })

    const client = new FbaInboundEligibilityApiClient({
    auth,
    region: 'eu',
    })

    In order to retry rate limited requests (HTTP 429), you can configure the API client as such:

    const client = new FbaInboundEligibilityApiClient({
    auth,
    region: 'eu',
    rateLimiting: {
    retry: true,
    // Optionally specify a callback that will be called on every retry.
    onRetry: (retryInfo) => {
    console.log(retryInfo)
    },
    },
    })

    The rate limits used for each route are specified in the API documentation.

    You can enable logging for both SP-API requests and responses by configuring the logging.request and logging.response properties.

    const client = new FbaInboundEligibilityApiClient({
    auth,
    region: 'eu',
    logging: {
    request: {
    logger: console.debug
    },
    response: {
    logger: console.debug
    },
    error: true,
    },
    })

    Specifying true will use the default options, specifying an object will allow you to override the default options.
    This uses axios-logger under the hood.
    By default, if enabled, the request and response loggers will use console.info and the error logger will use console.error.

    MIT

        ╚⊙ ⊙╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝

    Classes

    FbaInboundEligibilityApi
    FbaInboundEligibilityApiClient

    Interfaces

    FbaInboundEligibilityApiGetItemEligibilityPreviewRequest
    GetItemEligibilityPreviewResponse
    ItemEligibilityPreview
    ModelError

    Type Aliases

    GetItemEligibilityPreviewProgramEnum
    ItemEligibilityPreviewIneligibilityReasonListEnum
    ItemEligibilityPreviewProgramEnum

    Variables

    clientRateLimits
    GetItemEligibilityPreviewProgramEnum
    ItemEligibilityPreviewIneligibilityReasonListEnum
    ItemEligibilityPreviewProgramEnum

    Functions

    FbaInboundEligibilityApiAxiosParamCreator
    FbaInboundEligibilityApiFactory
    FbaInboundEligibilityApiFp