Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Module @sp-api-sdk/aplus-content-api-2020-11-01 - v4.2.0

    @sp-api-sdk/aplus-content-api-2020-11-01

    npm version XO code style

    With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ Content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.

    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/aplus-content-api-2020-11-01
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {AplusContentApiClient} from '@sp-api-sdk/aplus-content-api-2020-11-01'

    // `clientId` and `clientSecret` default to the `LWA_CLIENT_ID` and
    // `LWA_CLIENT_SECRET` environment variables.
    const auth = new SellingPartnerApiAuth({
    refreshToken: await getRefreshTokenForSeller(sellerId),
    })

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

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

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

        ╚⊙ ⊙╝
      ╚═(███)═╝
     ╚═(███)═╝
    ╚═(███)═╝
     ╚═(███)═╝
      ╚═(███)═╝
       ╚═(███)═╝
    
    AplusContentApi
    AplusContentApiClient
    AplusContentApiCreateContentDocumentRequest
    AplusContentApiCreateMediaRequest
    AplusContentApiGetContentDocumentRequest
    AplusContentApiGetMediaRequest
    AplusContentApiListContentDocumentAsinRelationsRequest
    AplusContentApiPostContentDocumentApprovalSubmissionRequest
    AplusContentApiPostContentDocumentAsinRelationsRequest
    AplusContentApiPostContentDocumentSuspendSubmissionRequest
    AplusContentApiSearchContentDocumentsRequest
    AplusContentApiSearchContentPublishRecordsRequest
    AplusContentApiUpdateContentDocumentRequest
    AplusContentApiUpdateMediaRequest
    AplusContentApiValidateContentDocumentAsinRelationsRequest
    AplusPaginatedResponseAllOf
    AplusResponse
    AsinImage
    AsinImages
    AsinMetadata
    BrandStoryAboutModule
    BrandStoryFourAsinModule
    BrandStoryImageWithLogoModule
    BrandStoryMediaAssetModule
    BrandStoryQuestionsModule
    ComparisonFields
    ComparisonMetrics
    ComparisonProduct
    ComparisonProducts
    ComparisonRow
    ContentDocument
    ContentMetadata
    ContentMetadataRecord
    ContentModule
    ContentRecord
    CreateMediaRequest
    Decorator
    Description
    ErrorList
    Faq
    Faqs
    GetContentDocumentResponseAllOf
    ImageCarouselPanel
    ImageCarouselPanels
    ImageColumn
    ImageColumns
    ImageComponent
    ImageCropSpecification
    ImageDimensions
    ImageHotSpot
    ImageHotSpots
    ImageOffsets
    ImageTextHotSpot
    ImageTextHotSpots
    IntegerWithUnits
    Issue
    ListContentDocumentAsinRelationsResponseAllOf
    MediaAllOf
    MediaInfo
    MediaInput
    MetricValueItem
    ModelError
    ParagraphComponent
    PlainTextItem
    PostContentDocumentAsinRelationsRequest
    PostContentDocumentRequest
    PostContentDocumentResponseAllOf
    PremiumComparisonCarouselModule
    PremiumComparisonScrollerModule
    PremiumDualImageTextModule
    PremiumFaqModule
    PremiumFourColumnImagesModule
    PremiumFullBackgroundImageModule
    PremiumFullBackgroundTextModule
    PremiumHeroVideoModule
    PremiumHotspotImageModule
    PremiumHotspotImageTextModule
    PremiumImageCarouselModule
    PremiumImageTextModule
    PremiumNavigationCarouselModule
    PremiumRegimenCarouselModule
    PremiumTechSpecsModule
    PremiumTextModule
    PremiumThreeColumnComparisonModule
    PremiumVideoImageCarouselModule
    PremiumVideoTextModule
    PublishRecord
    QuestionAnswerPair
    QuestionAnswerPairs
    RegimenCarouselPanel
    RegimenCarouselPanels
    RelatedMedia
    RelatedMediaInput
    SearchContentDocumentsResponseAllOf
    SearchContentPublishRecordsResponseAllOf
    StandardCompanyLogoModule
    StandardComparisonProductBlock
    StandardComparisonTableModule
    StandardFourImageTextModule
    StandardFourImageTextQuadrantModule
    StandardHeaderImageTextModule
    StandardHeaderTextListBlock
    StandardImageCaptionBlock
    StandardImageSidebarModule
    StandardImageTextBlock
    StandardImageTextCaptionBlock
    StandardImageTextOverlayModule
    StandardMultipleImageTextModule
    StandardProductDescriptionModule
    StandardSingleImageHighlightsModule
    StandardSingleImageSpecsDetailModule
    StandardSingleSideImageModule
    StandardTechSpecsModule
    StandardTextBlock
    StandardTextListBlock
    StandardTextModule
    StandardTextPairBlock
    StandardThreeImageTextModule
    TechSpec
    TechSpecs
    TextComponent
    TextItem
    ThreeColumnComparisonProduct
    ThreeColumnComparisonRow
    UpdateMediaRequest
    VideoComponent
    VideoImageCarouselPanel
    VideoImageCarouselPanels
    AplusPaginatedResponse
    AsinBadge
    AssociationType
    ColorType
    ContentBadge
    ContentModuleType
    ContentStatus
    ContentType
    CreateMediaResponse
    DecoratorType
    GetContentDocumentIncludedDataSetEnum
    GetContentDocumentResponse
    GetMediaResponse
    IssueSeverityEnum
    ListContentDocumentAsinRelationsIncludedDataSetEnum
    ListContentDocumentAsinRelationsResponse
    Media
    MediaStatus
    MediaType
    PositionType
    PostContentDocumentApprovalSubmissionResponse
    PostContentDocumentAsinRelationsResponse
    PostContentDocumentResponse
    PostContentDocumentSuspendSubmissionResponse
    SearchContentDocumentsResponse
    SearchContentPublishRecordsResponse
    UpdateMediaResponse
    ValidateContentDocumentAsinRelationsResponse
    AsinBadge
    AssociationType
    clientRateLimits
    ColorType
    ContentBadge
    ContentModuleType
    ContentStatus
    ContentType
    DecoratorType
    GetContentDocumentIncludedDataSetEnum
    IssueSeverityEnum
    ListContentDocumentAsinRelationsIncludedDataSetEnum
    MediaStatus
    MediaType
    PositionType
    AplusContentApiAxiosParamCreator
    AplusContentApiFactory
    AplusContentApiFp