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

    Module @sp-api-sdk/supply-sources-api-2020-07-01 - v2.1.9

    supply-sources-api-2020-07-01

    npm version XO code style

    Manage configurations and capabilities of seller supply sources.

    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/supply-sources-api-2020-07-01
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {SupplySourcesApiClient} from '@sp-api-sdk/supply-sources-api-2020-07-01'

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

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

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

    const client = new SupplySourcesApiClient({
    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 SupplySourcesApiClient({
    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

    SupplySourcesApi
    SupplySourcesApiClient

    Interfaces

    Address
    AddressWithContact
    ContactDetails
    ContactDetailsPrimary
    CreateSupplySourceRequest
    CreateSupplySourceResponse
    CurbsidePickupConfiguration
    DeliveryChannel
    Duration
    ErrorList
    GetSupplySourcesResponse
    InStorePickupConfiguration
    ModelError
    OperatingHour
    OperatingHoursByDay
    OperationalConfiguration
    OutboundCapability
    ParkingConfiguration
    ParkingWithAddressConfigurationAllOf
    PickupChannel
    ReturnLocation
    ServicesCapability
    SupplySource
    SupplySourceCapabilities
    SupplySourceConfiguration
    SupplySourceListInner
    SupplySourcesApiArchiveSupplySourceRequest
    SupplySourcesApiCreateSupplySourceRequest
    SupplySourcesApiGetSupplySourceRequest
    SupplySourcesApiGetSupplySourcesRequest
    SupplySourcesApiUpdateSupplySourceRequest
    SupplySourcesApiUpdateSupplySourceStatusRequest
    ThroughputCap
    ThroughputConfig
    UpdateSupplySourceRequest
    UpdateSupplySourceStatusRequest

    Type Aliases

    ParkingCostType
    ParkingSpotIdentificationType
    ParkingWithAddressConfiguration
    SupplySourceStatus
    SupplySourceStatusReadOnly
    ThroughputUnit
    TimeUnit

    Variables

    clientRateLimits
    ParkingCostType
    ParkingSpotIdentificationType
    SupplySourceStatus
    SupplySourceStatusReadOnly
    ThroughputUnit
    TimeUnit

    Functions

    SupplySourcesApiAxiosParamCreator
    SupplySourcesApiFactory
    SupplySourcesApiFp