@sp-api-sdk/fba-inbound-eligibility-api-v1
Version:
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
109 lines (108 loc) • 8.74 kB
TypeScript
/**
* 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 type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { GetItemEligibilityPreviewResponse } from '../models';
/**
* 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 {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
* @param {Array<string>} [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: GetItemEligibilityPreviewProgramEnum, marketplaceIds?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* 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 {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
* @param {Array<string>} [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: GetItemEligibilityPreviewProgramEnum, marketplaceIds?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetItemEligibilityPreviewResponse>>;
};
/**
* 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 {FbaInboundApiGetItemEligibilityPreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetItemEligibilityPreviewResponse>;
};
/**
* 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: GetItemEligibilityPreviewProgramEnum;
/**
* The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
* @type {Array<string>}
* @memberof FbaInboundApiGetItemEligibilityPreview
*/
readonly marketplaceIds?: Array<string>;
}
/**
* 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?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetItemEligibilityPreviewResponse, any>>;
}
/**
* @export
*/
export declare const GetItemEligibilityPreviewProgramEnum: {
readonly Inbound: "INBOUND";
readonly Commingling: "COMMINGLING";
};
export type GetItemEligibilityPreviewProgramEnum = typeof GetItemEligibilityPreviewProgramEnum[keyof typeof GetItemEligibilityPreviewProgramEnum];