@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
345 lines (334 loc) • 19 kB
text/typescript
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
import * as axios from 'axios';
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
/**
* 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.
*/
interface AWSv4Configuration {
options?: {
region?: string;
service?: string;
};
credentials?: {
accessKeyId?: string;
secretAccessKey?: string;
sessionToken?: string;
};
}
interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
awsv4?: AWSv4Configuration;
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
declare class Configuration {
/**
* parameter for apiKey security
* @param name security name
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*/
username?: string;
/**
* parameter for basic security
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* parameter for aws4 signature security
* @param {Object} AWS4Signature - AWS4 Signature security
* @param {string} options.region - aws region
* @param {string} options.service - name of the service.
* @param {string} credentials.accessKeyId - aws access key id
* @param {string} credentials.secretAccessKey - aws access key
* @param {string} credentials.sessionToken - aws session token
* @memberof Configuration
*/
awsv4?: AWSv4Configuration;
/**
* override base path
*/
basePath?: string;
/**
* override server index
*/
serverIndex?: number;
/**
* base options for axios calls
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param?: ConfigurationParameters);
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
isJsonMime(mime: string): boolean;
}
/**
* 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.
*/
interface RequestArgs {
url: string;
options: RawAxiosRequestConfig;
}
declare class BaseAPI {
protected basePath: string;
protected axios: AxiosInstance;
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}
/**
* 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.
*/
/**
* The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.
*/
interface ItemEligibilityPreview {
/**
* The ASIN for which eligibility was determined.
*/
'asin': string;
/**
* The marketplace for which eligibility was determined.
*/
'marketplaceId'?: string;
/**
* The program for which eligibility was determined.
*/
'program': ItemEligibilityPreviewProgramEnum;
/**
* Indicates if the item is eligible for the program.
*/
'isEligibleForProgram': boolean;
/**
* Potential Ineligibility Reason Codes.
*/
'ineligibilityReasonList'?: Array<ItemEligibilityPreviewIneligibilityReasonListEnum>;
}
declare const ItemEligibilityPreviewProgramEnum: {
readonly Inbound: "INBOUND";
readonly Commingling: "COMMINGLING";
};
type ItemEligibilityPreviewProgramEnum = typeof ItemEligibilityPreviewProgramEnum[keyof typeof ItemEligibilityPreviewProgramEnum];
declare const ItemEligibilityPreviewIneligibilityReasonListEnum: {
readonly FbaInb0004: "FBA_INB_0004";
readonly FbaInb0006: "FBA_INB_0006";
readonly FbaInb0007: "FBA_INB_0007";
readonly FbaInb0008: "FBA_INB_0008";
readonly FbaInb0009: "FBA_INB_0009";
readonly FbaInb0010: "FBA_INB_0010";
readonly FbaInb0011: "FBA_INB_0011";
readonly FbaInb0012: "FBA_INB_0012";
readonly FbaInb0013: "FBA_INB_0013";
readonly FbaInb0014: "FBA_INB_0014";
readonly FbaInb0015: "FBA_INB_0015";
readonly FbaInb0016: "FBA_INB_0016";
readonly FbaInb0017: "FBA_INB_0017";
readonly FbaInb0018: "FBA_INB_0018";
readonly FbaInb0019: "FBA_INB_0019";
readonly FbaInb0034: "FBA_INB_0034";
readonly FbaInb0035: "FBA_INB_0035";
readonly FbaInb0036: "FBA_INB_0036";
readonly FbaInb0037: "FBA_INB_0037";
readonly FbaInb0038: "FBA_INB_0038";
readonly FbaInb0050: "FBA_INB_0050";
readonly FbaInb0051: "FBA_INB_0051";
readonly FbaInb0053: "FBA_INB_0053";
readonly FbaInb0055: "FBA_INB_0055";
readonly FbaInb0056: "FBA_INB_0056";
readonly FbaInb0059: "FBA_INB_0059";
readonly FbaInb0065: "FBA_INB_0065";
readonly FbaInb0066: "FBA_INB_0066";
readonly FbaInb0067: "FBA_INB_0067";
readonly FbaInb0068: "FBA_INB_0068";
readonly FbaInb0095: "FBA_INB_0095";
readonly FbaInb0097: "FBA_INB_0097";
readonly FbaInb0098: "FBA_INB_0098";
readonly FbaInb0099: "FBA_INB_0099";
readonly FbaInb0100: "FBA_INB_0100";
readonly FbaInb0103: "FBA_INB_0103";
readonly FbaInb0104: "FBA_INB_0104";
readonly FbaInb0197: "FBA_INB_0197";
readonly FbaInb0342: "FBA_INB_0342";
readonly FbaInb0465: "FBA_INB_0465";
readonly UnknownInbErrorCode: "UNKNOWN_INB_ERROR_CODE";
};
type ItemEligibilityPreviewIneligibilityReasonListEnum = typeof ItemEligibilityPreviewIneligibilityReasonListEnum[keyof typeof ItemEligibilityPreviewIneligibilityReasonListEnum];
/**
* 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.
*/
/**
* The response schema for the getItemEligibilityPreview operation.
*/
interface GetItemEligibilityPreviewResponse {
'payload'?: ItemEligibilityPreview;
/**
* A list of error responses returned when a request is unsuccessful.
*/
'errors'?: Array<Error>;
}
/**
* 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.
*/
/**
* Error response returned when the request is unsuccessful.
*/
interface ModelError {
/**
* An error code that identifies the type of error that occurred.
*/
'code': string;
/**
* A message that describes the error condition in a human-readable form.
*/
'message'?: string;
/**
* Additional information that can help the caller understand or fix the issue.
*/
'details'?: string;
}
/**
* FbaInboundEligibilityApi - axios parameter creator
*/
declare const FbaInboundEligibilityApiAxiosParamCreator: (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>;
};
/**
* FbaInboundEligibilityApi - functional programming interface
*/
declare const FbaInboundEligibilityApiFp: (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>>;
};
/**
* FbaInboundEligibilityApi - factory interface
*/
declare const FbaInboundEligibilityApiFactory: (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 {FbaInboundEligibilityApiGetItemEligibilityPreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemEligibilityPreview(requestParameters: FbaInboundEligibilityApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetItemEligibilityPreviewResponse>;
};
/**
* Request parameters for getItemEligibilityPreview operation in FbaInboundEligibilityApi.
*/
interface FbaInboundEligibilityApiGetItemEligibilityPreviewRequest {
/**
* The ASIN of the item for which you want an eligibility preview.
*/
readonly asin: string;
/**
* The program that you want to check eligibility against.
*/
readonly program: GetItemEligibilityPreviewProgramEnum;
/**
* The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
*/
readonly marketplaceIds?: Array<string>;
}
/**
* FbaInboundEligibilityApi - object-oriented interface
*/
declare class FbaInboundEligibilityApi 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 {FbaInboundEligibilityApiGetItemEligibilityPreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemEligibilityPreview(requestParameters: FbaInboundEligibilityApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetItemEligibilityPreviewResponse, any, {}>>;
}
declare const GetItemEligibilityPreviewProgramEnum: {
readonly Inbound: "INBOUND";
readonly Commingling: "COMMINGLING";
};
type GetItemEligibilityPreviewProgramEnum = typeof GetItemEligibilityPreviewProgramEnum[keyof typeof GetItemEligibilityPreviewProgramEnum];
declare const clientRateLimits: RateLimit[];
declare class FbaInboundEligibilityApiClient extends FbaInboundEligibilityApi {
constructor(configuration: ClientConfiguration);
}
export { FbaInboundEligibilityApi, FbaInboundEligibilityApiAxiosParamCreator, FbaInboundEligibilityApiClient, FbaInboundEligibilityApiFactory, FbaInboundEligibilityApiFp, type FbaInboundEligibilityApiGetItemEligibilityPreviewRequest, GetItemEligibilityPreviewProgramEnum, type GetItemEligibilityPreviewResponse, type ItemEligibilityPreview, ItemEligibilityPreviewIneligibilityReasonListEnum, ItemEligibilityPreviewProgramEnum, type ModelError, clientRateLimits };