Class ProfileOperation

Hierarchy

Constructors

constructor

Methods

getBrands getProfile listProfiles registerBrand registerProfile updateProfiles create

Constructors

constructor

Methods

getBrands

  • Gets an array of Brand data objects for the Brand associated with the profile ID passed in the header. For more information about Brands, see Brand Services.

    Returns

    Returns Promise<{ brandEntityId: string; brandId: string; brandRegistryName: string }[]>

getProfile

  • Retrieves a single profile specified by identifier.

    Returns

    Parameters

    • profileId: number

    Returns Promise<{ accountInfo: ({ marketplaceStringId: string; id: string; type: "seller" | "vendor" | "agency"; }) & { name: undefined | string; subType: undefined | "KDP_AUTHOR" | "AMAZON_ATTRIBUTION" }; countryCode: AmazonMarketplaceAdvertisingCountryCode; currencyCode: AmazonMarketplaceAdvertisingCurrency; profileId: number; timezone: AmazonMarketplaceAdvertisingTimeZone } & { dailyBudget: undefined | number }>

listProfiles

  • Retrieves one or more profiles associated with the authorization passed in the request header.

    Returns

    Returns Promise<({ accountInfo: ({ marketplaceStringId: string; id: string; type: "seller" | "vendor" | "agency"; }) & { name: undefined | string; subType: undefined | "KDP_AUTHOR" | "AMAZON_ATTRIBUTION" }; countryCode: AmazonMarketplaceAdvertisingCountryCode; currencyCode: AmazonMarketplaceAdvertisingCurrency; profileId: number; timezone: AmazonMarketplaceAdvertisingTimeZone } & { dailyBudget: undefined | number })[]>

registerBrand

  • Registers a brand in the sandbox environment. If this call is made to a production endpoint an error is returned.

    Returns

    Parameters

    • registerBrand: { brand: string; countryCode: AmazonMarketplaceAdvertisingCountryCode }
      • brand: string

        REQUIRED. Brand name.

      • countryCode: AmazonMarketplaceAdvertisingCountryCode

        The country in which you wish to register the profile. Can be one of: US, CA, UK, DE, FR, IT, ES, JP, AU

    Returns Promise<{ code: string; description: string; profileId: number }>

registerProfile

  • Registers a profile in the sandbox environment. If this call is made to a production endpoint an error is returned.

    Returns

    Parameters

    • countryCode: AmazonMarketplaceAdvertisingCountryCode = AmazonMarketplaceAdvertisingCountryCode.US

    Returns Promise<{ status: "SUCCESS" | "IN_PROGRESS"; statusDetails: string } & { profileId: undefined | number }>

updateProfiles

  • Updates one or more profiles.

    Returns

    Parameters

    • profiles: Partial<{ accountInfo: ({ marketplaceStringId: string; id: string; type: "seller" | "vendor" | "agency"; }) & { name: undefined | string; subType: undefined | "KDP_AUTHOR" | "AMAZON_ATTRIBUTION" }; countryCode: AmazonMarketplaceAdvertisingCountryCode; currencyCode: AmazonMarketplaceAdvertisingCurrency; profileId: number; timezone: AmazonMarketplaceAdvertisingTimeZone } & { dailyBudget: undefined | number }>[]

    Returns Promise<({ code: string; profileId: number } & { details: undefined | string })[]>

Static create

Settings

Member Visibility

Theme