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

    Module @sp-api-sdk/aplus-content-api-2020-11-01 - v3.1.9

    aplus-content-api-2020-11-01

    npm version XO code style

    Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add 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'

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

    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

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

    Classes

    AplusContentApi
    AplusContentApiClient

    Interfaces

    AplusContentApiCreateContentDocumentRequest
    AplusContentApiGetContentDocumentRequest
    AplusContentApiListContentDocumentAsinRelationsRequest
    AplusContentApiPostContentDocumentApprovalSubmissionRequest
    AplusContentApiPostContentDocumentAsinRelationsRequest
    AplusContentApiPostContentDocumentSuspendSubmissionRequest
    AplusContentApiSearchContentDocumentsRequest
    AplusContentApiSearchContentPublishRecordsRequest
    AplusContentApiUpdateContentDocumentRequest
    AplusContentApiValidateContentDocumentAsinRelationsRequest
    AplusPaginatedResponseAllOf
    AplusResponse
    AsinMetadata
    ContentDocument
    ContentMetadata
    ContentMetadataRecord
    ContentModule
    ContentRecord
    Decorator
    ErrorList
    GetContentDocumentResponseAllOf
    ImageComponent
    ImageCropSpecification
    ImageDimensions
    ImageOffsets
    IntegerWithUnits
    ListContentDocumentAsinRelationsResponseAllOf
    ModelError
    ParagraphComponent
    PlainTextItem
    PostContentDocumentAsinRelationsRequest
    PostContentDocumentRequest
    PostContentDocumentResponseAllOf
    PublishRecord
    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
    TextComponent
    TextItem

    Type Aliases

    AplusPaginatedResponse
    AsinBadge
    ColorType
    ContentBadge
    ContentModuleType
    ContentStatus
    ContentType
    DecoratorType
    GetContentDocumentIncludedDataSetEnum
    GetContentDocumentResponse
    ListContentDocumentAsinRelationsIncludedDataSetEnum
    ListContentDocumentAsinRelationsResponse
    PositionType
    PostContentDocumentApprovalSubmissionResponse
    PostContentDocumentAsinRelationsResponse
    PostContentDocumentResponse
    PostContentDocumentSuspendSubmissionResponse
    SearchContentDocumentsResponse
    SearchContentPublishRecordsResponse
    ValidateContentDocumentAsinRelationsResponse

    Variables

    AsinBadge
    clientRateLimits
    ColorType
    ContentBadge
    ContentModuleType
    ContentStatus
    ContentType
    DecoratorType
    GetContentDocumentIncludedDataSetEnum
    ListContentDocumentAsinRelationsIncludedDataSetEnum
    PositionType

    Functions

    AplusContentApiAxiosParamCreator
    AplusContentApiFactory
    AplusContentApiFp