/** * The Selling Partner API for Sellers * The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * The response schema for the `getAccount` operation. * @export * @interface Account */ export interface Account { /** * List of marketplace participations. * @type {Array} * @memberof Account */ marketplaceParticipationList: Array; /** * The type of business registered for the seller account. * @type {string} * @memberof Account */ businessType: AccountBusinessTypeEnum | 'CHARITY' | 'CRAFTSMAN' | 'NATURAL_PERSON_COMPANY' | 'PUBLIC_LISTED' | 'PRIVATE_LIMITED' | 'SOLE_PROPRIETORSHIP' | 'STATE_OWNED' | 'INDIVIDUAL'; /** * The selling plan details. * @type {string} * @memberof Account */ sellingPlan: AccountSellingPlanEnum | 'PROFESSIONAL' | 'INDIVIDUAL'; /** * * @type {Business} * @memberof Account */ business?: Business; /** * * @type {PrimaryContact} * @memberof Account */ primaryContact?: PrimaryContact; } /** * @export * @enum {string} */ export declare enum AccountBusinessTypeEnum { Charity = "CHARITY", Craftsman = "CRAFTSMAN", NaturalPersonCompany = "NATURAL_PERSON_COMPANY", PublicListed = "PUBLIC_LISTED", PrivateLimited = "PRIVATE_LIMITED", SoleProprietorship = "SOLE_PROPRIETORSHIP", StateOwned = "STATE_OWNED", Individual = "INDIVIDUAL" } /** * @export * @enum {string} */ export declare enum AccountSellingPlanEnum { Professional = "PROFESSIONAL", Individual = "INDIVIDUAL" } /** * Represents an address * @export * @interface Address */ export interface Address { /** * Street address information. * @type {string} * @memberof Address */ addressLine1: string; /** * Additional street address information. * @type {string} * @memberof Address */ addressLine2?: string; /** * The country code in two-character ISO 3166-1 alpha-2 format. * @type {string} * @memberof Address */ countryCode: string; /** * The state or province code. * @type {string} * @memberof Address */ stateOrProvinceCode?: string; /** * The city. * @type {string} * @memberof Address */ city?: string; /** * The postal code. * @type {string} * @memberof Address */ postalCode?: string; } /** * Information about the Seller\'s business. These fields may be omitted if the Seller is registered as an individual. * @export * @interface Business */ export interface Business { /** * The registered business name. * @type {string} * @memberof Business */ name: string; /** * * @type {Address} * @memberof Business */ registeredBusinessAddress: Address; /** * The seller\'s company registration number, if applicable. This field will be absent for individual sellers and sole proprietorships. * @type {string} * @memberof Business */ companyRegistrationNumber?: string; /** * The seller\'s company tax identification number, if applicable. This field will be present for certain business types only, such as sole proprietorships. * @type {string} * @memberof Business */ companyTaxIdentificationNumber?: string; /** * The non-Latin script version of the registered business name, if applicable. * @type {string} * @memberof Business */ nonLatinName?: string; } /** * The response schema for the `getAccount` operation. * @export * @interface GetAccountResponse */ export interface GetAccountResponse { /** * * @type {Account} * @memberof GetAccountResponse */ payload?: Account; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetAccountResponse */ errors?: Array; } /** * The response schema for the `getMarketplaceParticipations` operation. * @export * @interface GetMarketplaceParticipationsResponse */ export interface GetMarketplaceParticipationsResponse { /** * List of marketplace participations. * @type {Array} * @memberof GetMarketplaceParticipationsResponse */ payload?: Array; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetMarketplaceParticipationsResponse */ errors?: Array; } /** * Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items. * @export * @interface Marketplace */ export interface Marketplace { /** * The encrypted marketplace value. * @type {string} * @memberof Marketplace */ id: string; /** * Marketplace name. * @type {string} * @memberof Marketplace */ name: string; /** * The ISO 3166-1 alpha-2 format country code of the marketplace. * @type {string} * @memberof Marketplace */ countryCode: string; /** * The ISO 4217 format currency code of the marketplace. * @type {string} * @memberof Marketplace */ defaultCurrencyCode: string; /** * The ISO 639-1 format language code of the marketplace. * @type {string} * @memberof Marketplace */ defaultLanguageCode: string; /** * The domain name of the marketplace. * @type {string} * @memberof Marketplace */ domainName: string; } /** * * @export * @interface MarketplaceParticipation */ export interface MarketplaceParticipation { /** * * @type {Marketplace} * @memberof MarketplaceParticipation */ marketplace: Marketplace; /** * * @type {Participation} * @memberof MarketplaceParticipation */ participation: Participation; /** * The name of the seller\'s store as displayed in the marketplace. * @type {string} * @memberof MarketplaceParticipation */ storeName: string; } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition in a human-readable form. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * Detailed information that is specific to a seller in a marketplace. * @export * @interface Participation */ export interface Participation { /** * If true, the seller participates in the marketplace. * @type {boolean} * @memberof Participation */ isParticipating: boolean; /** * If true, the seller has suspended listings. * @type {boolean} * @memberof Participation */ hasSuspendedListings: boolean; } /** * Information about the seller\'s primary contact. * @export * @interface PrimaryContact */ export interface PrimaryContact { /** * The full name of the seller\'s primary contact. * @type {string} * @memberof PrimaryContact */ name: string; /** * * @type {Address} * @memberof PrimaryContact */ address: Address; /** * The non-Latin script version of the primary contact\'s name, if applicable. * @type {string} * @memberof PrimaryContact */ nonLatinName?: string; } /** * SellersApi - axios parameter creator * @export */ export declare const SellersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccount: (options?: any) => Promise; /** * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketplaceParticipations: (options?: any) => Promise; }; /** * SellersApi - functional programming interface * @export */ export declare const SellersApiFp: (configuration?: Configuration) => { /** * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccount(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketplaceParticipations(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SellersApi - factory interface * @export */ export declare const SellersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccount(options?: any): AxiosPromise; /** * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketplaceParticipations(options?: any): AxiosPromise; }; /** * SellersApi - object-oriented interface * @export * @class SellersApi * @extends {BaseAPI} */ export declare class SellersApi extends BaseAPI { /** * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SellersApi */ getAccount(options?: any): Promise>; /** * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SellersApi */ getMarketplaceParticipations(options?: any): Promise>; }