/** * Selling Partner API for FBA Inbound Eligibilty * With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon\'s fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon\'s fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon\'s fulfillment centers. * * 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 getItemEligibilityPreview operation. * @export * @interface GetItemEligibilityPreviewResponse */ export interface GetItemEligibilityPreviewResponse { /** * * @type {ItemEligibilityPreview} * @memberof GetItemEligibilityPreviewResponse */ payload?: ItemEligibilityPreview; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetItemEligibilityPreviewResponse */ errors?: Array; } /** * The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes. * @export * @interface ItemEligibilityPreview */ export interface ItemEligibilityPreview { /** * The ASIN for which eligibility was determined. * @type {string} * @memberof ItemEligibilityPreview */ asin: string; /** * The marketplace for which eligibility was determined. * @type {string} * @memberof ItemEligibilityPreview */ marketplaceId?: string; /** * The program for which eligibility was determined. * @type {string} * @memberof ItemEligibilityPreview */ program: ItemEligibilityPreviewProgramEnum | 'INBOUND' | 'COMMINGLING'; /** * Indicates if the item is eligible for the program. * @type {boolean} * @memberof ItemEligibilityPreview */ isEligibleForProgram: boolean; /** * Potential Ineligibility Reason Codes. * @type {Array} * @memberof ItemEligibilityPreview */ ineligibilityReasonList?: Array<(ItemEligibilityPreviewIneligibilityReasonListEnum | 'FBA_INB_0004' | 'FBA_INB_0006' | 'FBA_INB_0007' | 'FBA_INB_0008' | 'FBA_INB_0009' | 'FBA_INB_0010' | 'FBA_INB_0011' | 'FBA_INB_0012' | 'FBA_INB_0013' | 'FBA_INB_0014' | 'FBA_INB_0015' | 'FBA_INB_0016' | 'FBA_INB_0017' | 'FBA_INB_0018' | 'FBA_INB_0019' | 'FBA_INB_0034' | 'FBA_INB_0035' | 'FBA_INB_0036' | 'FBA_INB_0037' | 'FBA_INB_0038' | 'FBA_INB_0050' | 'FBA_INB_0051' | 'FBA_INB_0053' | 'FBA_INB_0055' | 'FBA_INB_0056' | 'FBA_INB_0059' | 'FBA_INB_0065' | 'FBA_INB_0066' | 'FBA_INB_0067' | 'FBA_INB_0068' | 'FBA_INB_0095' | 'FBA_INB_0097' | 'FBA_INB_0098' | 'FBA_INB_0099' | 'FBA_INB_0100' | 'FBA_INB_0103' | 'FBA_INB_0104' | 'FBA_INB_0197' | 'UNKNOWN_INB_ERROR_CODE')>; } /** * @export * @enum {string} */ export declare enum ItemEligibilityPreviewProgramEnum { Inbound = "INBOUND", Commingling = "COMMINGLING" } /** * @export * @enum {string} */ export declare enum ItemEligibilityPreviewIneligibilityReasonListEnum { FbaInb0004 = "FBA_INB_0004", FbaInb0006 = "FBA_INB_0006", FbaInb0007 = "FBA_INB_0007", FbaInb0008 = "FBA_INB_0008", FbaInb0009 = "FBA_INB_0009", FbaInb0010 = "FBA_INB_0010", FbaInb0011 = "FBA_INB_0011", FbaInb0012 = "FBA_INB_0012", FbaInb0013 = "FBA_INB_0013", FbaInb0014 = "FBA_INB_0014", FbaInb0015 = "FBA_INB_0015", FbaInb0016 = "FBA_INB_0016", FbaInb0017 = "FBA_INB_0017", FbaInb0018 = "FBA_INB_0018", FbaInb0019 = "FBA_INB_0019", FbaInb0034 = "FBA_INB_0034", FbaInb0035 = "FBA_INB_0035", FbaInb0036 = "FBA_INB_0036", FbaInb0037 = "FBA_INB_0037", FbaInb0038 = "FBA_INB_0038", FbaInb0050 = "FBA_INB_0050", FbaInb0051 = "FBA_INB_0051", FbaInb0053 = "FBA_INB_0053", FbaInb0055 = "FBA_INB_0055", FbaInb0056 = "FBA_INB_0056", FbaInb0059 = "FBA_INB_0059", FbaInb0065 = "FBA_INB_0065", FbaInb0066 = "FBA_INB_0066", FbaInb0067 = "FBA_INB_0067", FbaInb0068 = "FBA_INB_0068", FbaInb0095 = "FBA_INB_0095", FbaInb0097 = "FBA_INB_0097", FbaInb0098 = "FBA_INB_0098", FbaInb0099 = "FBA_INB_0099", FbaInb0100 = "FBA_INB_0100", FbaInb0103 = "FBA_INB_0103", FbaInb0104 = "FBA_INB_0104", FbaInb0197 = "FBA_INB_0197", UnknownInbErrorCode = "UNKNOWN_INB_ERROR_CODE" } /** * 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 information that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * FbaInboundApi - axios parameter creator * @export */ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configuration) => { /** * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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 {string} asin The ASIN of the item for which you want an eligibility preview. * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against. * @param {Array} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemEligibilityPreview: (asin: string, program: "INBOUND" | "COMMINGLING", marketplaceIds?: Array, options?: any) => Promise; }; /** * FbaInboundApi - functional programming interface * @export */ export declare const FbaInboundApiFp: (configuration?: Configuration) => { /** * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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 {string} asin The ASIN of the item for which you want an eligibility preview. * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against. * @param {Array} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemEligibilityPreview(asin: string, program: "INBOUND" | "COMMINGLING", marketplaceIds?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FbaInboundApi - factory interface * @export */ export declare const FbaInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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 {string} asin The ASIN of the item for which you want an eligibility preview. * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against. * @param {Array} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemEligibilityPreview(asin: string, program: "INBOUND" | "COMMINGLING", marketplaceIds?: Array, options?: any): AxiosPromise; }; /** * Request parameters for getItemEligibilityPreview operation in FbaInboundApi. * @export * @interface FbaInboundApiGetItemEligibilityPreviewRequest */ export interface FbaInboundApiGetItemEligibilityPreviewRequest { /** * The ASIN of the item for which you want an eligibility preview. * @type {string} * @memberof FbaInboundApiGetItemEligibilityPreview */ readonly asin: string; /** * The program that you want to check eligibility against. * @type {'INBOUND' | 'COMMINGLING'} * @memberof FbaInboundApiGetItemEligibilityPreview */ readonly program: 'INBOUND' | 'COMMINGLING'; /** * The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND. * @type {Array} * @memberof FbaInboundApiGetItemEligibilityPreview */ readonly marketplaceIds?: Array; } /** * FbaInboundApi - object-oriented interface * @export * @class FbaInboundApi * @extends {BaseAPI} */ export declare class FbaInboundApi extends BaseAPI { /** * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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 {FbaInboundApiGetItemEligibilityPreviewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FbaInboundApi */ getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: any): Promise>; }