import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common'; import * as axios from 'axios'; import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios'; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); 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 | ((name: string) => string) | ((name: string) => Promise); /** * 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 | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * 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 Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace. */ declare const BarcodeInstruction: { readonly RequiresFnskuLabel: "RequiresFNSKULabel"; readonly CanUseOriginalBarcode: "CanUseOriginalBarcode"; readonly MustProvideSellerSku: "MustProvideSellerSKU"; }; type BarcodeInstruction = typeof BarcodeInstruction[keyof typeof BarcodeInstruction]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Item preparation instructions. */ declare const PrepGuidance: { readonly ConsultHelpDocuments: "ConsultHelpDocuments"; readonly NoAdditionalPrepRequired: "NoAdditionalPrepRequired"; readonly SeePrepInstructionsList: "SeePrepInstructionsList"; }; type PrepGuidance = typeof PrepGuidance[keyof typeof PrepGuidance]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Preparation instructions for shipping an item to Amazon\'s fulfillment network. For more information about preparing items for shipment to Amazon\'s fulfillment network, see the Seller Central Help for your marketplace. */ declare const PrepInstruction: { readonly Polybagging: "Polybagging"; readonly BubbleWrapping: "BubbleWrapping"; readonly Taping: "Taping"; readonly BlackShrinkWrapping: "BlackShrinkWrapping"; readonly Labeling: "Labeling"; readonly HangGarment: "HangGarment"; readonly SetCreation: "SetCreation"; readonly Boxing: "Boxing"; readonly RemoveFromHanger: "RemoveFromHanger"; readonly Debundle: "Debundle"; readonly SuffocationStickering: "SuffocationStickering"; readonly CapSealing: "CapSealing"; readonly SetStickering: "SetStickering"; readonly BlankStickering: "BlankStickering"; readonly ShipsInProductPackaging: "ShipsInProductPackaging"; readonly NoPrep: "NoPrep"; }; type PrepInstruction = typeof PrepInstruction[keyof typeof PrepInstruction]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Item preparation instructions to help with item sourcing decisions. */ interface ASINPrepInstructions { /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN'?: string; 'BarcodeInstruction'?: BarcodeInstruction; 'PrepGuidance'?: PrepGuidance; /** * A list of preparation instructions to help with item sourcing decisions. */ 'PrepInstructionList'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Specific details to identify a place. */ interface Address { /** * Name of the individual or business. */ 'Name': string; /** * The street address information. */ 'AddressLine1': string; /** * Additional street address information, if required. */ 'AddressLine2'?: string; /** * The district or county. */ 'DistrictOrCounty'?: string; /** * The city. */ 'City': string; /** * The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan. */ 'StateOrProvinceCode': string; /** * The country code in two-character ISO 3166-1 alpha-2 format. */ 'CountryCode': string; /** * The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan. */ 'PostalCode': string; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The currency code. */ declare const CurrencyCode: { readonly Usd: "USD"; readonly Gbp: "GBP"; }; type CurrencyCode = typeof CurrencyCode[keyof typeof CurrencyCode]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The monetary value. */ interface Amount { 'CurrencyCode': CurrencyCode; /** * Number format that supports decimal. */ 'Value': number; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The fees for Amazon to prep goods for shipment. */ interface AmazonPrepFeesDetails { 'PrepInstruction'?: PrepInstruction; 'FeePerUnit'?: Amount; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Download URL for the bill of lading. */ interface BillOfLadingDownloadURL { /** * URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds */ 'DownloadURL'?: string; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The manual processing fee per unit and total fee for a shipment. */ interface BoxContentsFeeDetails { /** * The item quantity. */ 'TotalUnits'?: number; 'FeePerUnit'?: Amount; 'TotalFee'?: Amount; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Where the seller provided box contents information for a shipment. */ declare const BoxContentsSource: { readonly None: "NONE"; readonly Feed: "FEED"; readonly _2DBarcode: "2D_BARCODE"; readonly Interactive: "INTERACTIVE"; }; type BoxContentsSource = typeof BoxContentsSource[keyof typeof BoxContentsSource]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The reason that the ASIN is invalid. */ declare const ErrorReason: { readonly DoesNotExist: "DoesNotExist"; readonly InvalidAsin: "InvalidASIN"; }; type ErrorReason = typeof ErrorReason[keyof typeof ErrorReason]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 getBillOfLading operation. */ interface GetBillOfLadingResponse { 'payload'?: BillOfLadingDownloadURL; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Download URL for a label */ interface LabelDownloadURL { /** * URL to download the label for the package. Note: The URL will only be valid for 15 seconds */ 'DownloadURL'?: string; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 getLabels operation. */ interface GetLabelsResponse { 'payload'?: LabelDownloadURL; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Contains details about an invalid ASIN */ interface InvalidASIN { /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN'?: string; 'ErrorReason'?: ErrorReason; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Contains detail about an invalid SKU */ interface InvalidSKU { /** * The seller SKU of the item. */ 'SellerSKU'?: string; 'ErrorReason'?: ErrorReason; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon\'s fulfillment network. */ interface SKUPrepInstructions { /** * The seller SKU of the item. */ 'SellerSKU'?: string; /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN'?: string; 'BarcodeInstruction'?: BarcodeInstruction; 'PrepGuidance'?: PrepGuidance; /** * A list of preparation instructions to help with item sourcing decisions. */ 'PrepInstructionList'?: Array; /** * A list of preparation instructions and fees for Amazon to prep goods for shipment. */ 'AmazonPrepFeesDetailsList'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Result for the get prep instructions operation */ interface GetPrepInstructionsResult { /** * A list of SKU labeling requirements and item preparation instructions. */ 'SKUPrepInstructionsList'?: Array; /** * A list of invalid SKU values and the reason they are invalid. */ 'InvalidSKUList'?: Array; /** * A list of item preparation instructions. */ 'ASINPrepInstructionsList'?: Array; /** * A list of invalid ASIN values and the reasons they are invalid. */ 'InvalidASINList'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 getPrepInstructions operation. */ interface GetPrepInstructionsResponse { 'payload'?: GetPrepInstructionsResult; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates who will prepare the item. */ declare const PrepOwner: { readonly Amazon: "AMAZON"; readonly Seller: "SELLER"; }; type PrepOwner = typeof PrepOwner[keyof typeof PrepOwner]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Preparation instructions and who is responsible for the preparation. */ interface PrepDetails { 'PrepInstruction': PrepInstruction; 'PrepOwner': PrepOwner; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation. */ interface InboundShipmentItem { /** * A shipment identifier originally returned by the createInboundShipmentPlan operation. */ 'ShipmentId'?: string; /** * The seller SKU of the item. */ 'SellerSKU': string; /** * Amazon\'s fulfillment network SKU of the item. */ 'FulfillmentNetworkSKU'?: string; /** * The item quantity. */ 'QuantityShipped': number; /** * The item quantity. */ 'QuantityReceived'?: number; /** * The item quantity. */ 'QuantityInCase'?: number; /** * Type containing date in string format */ 'ReleaseDate'?: string; /** * A list of preparation instructions and who is responsible for that preparation. */ 'PrepDetailsList'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Result for the get shipment items operation */ interface GetShipmentItemsResult { /** * A list of inbound shipment item information. */ 'ItemData'?: Array; /** * When present and not empty, pass this string token in the next request to return the next response page. */ 'NextToken'?: string; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 getShipmentItems operation. */ interface GetShipmentItemsResponse { 'payload'?: GetShipmentItemsResult; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The type of label preparation that is required for the inbound shipment. */ declare const LabelPrepType: { readonly NoLabel: "NO_LABEL"; readonly SellerLabel: "SELLER_LABEL"; readonly AmazonLabel: "AMAZON_LABEL"; }; type LabelPrepType = typeof LabelPrepType[keyof typeof LabelPrepType]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED. */ declare const ShipmentStatus: { readonly Working: "WORKING"; readonly Shipped: "SHIPPED"; readonly Receiving: "RECEIVING"; readonly Cancelled: "CANCELLED"; readonly Deleted: "DELETED"; readonly Closed: "CLOSED"; readonly Error: "ERROR"; readonly InTransit: "IN_TRANSIT"; readonly Delivered: "DELIVERED"; readonly CheckedIn: "CHECKED_IN"; }; type ShipmentStatus = typeof ShipmentStatus[keyof typeof ShipmentStatus]; /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Information about the seller\'s inbound shipments. Returned by the listInboundShipments operation. */ interface InboundShipmentInfo { /** * The shipment identifier submitted in the request. */ 'ShipmentId'?: string; /** * The name for the inbound shipment. */ 'ShipmentName'?: string; 'ShipFromAddress': Address; /** * An Amazon fulfillment center identifier created by Amazon. */ 'DestinationFulfillmentCenterId'?: string; 'ShipmentStatus'?: ShipmentStatus; 'LabelPrepType'?: LabelPrepType; /** * Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed. */ 'AreCasesRequired': boolean; /** * Type containing date in string format */ 'ConfirmedNeedByDate'?: string; 'BoxContentsSource'?: BoxContentsSource; 'EstimatedBoxContentsFee'?: BoxContentsFeeDetails; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Result for the get shipments operation */ interface GetShipmentsResult { /** * A list of inbound shipment information. */ 'ShipmentData'?: Array; /** * When present and not empty, pass this string token in the next request to return the next response page. */ 'NextToken'?: string; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 getShipments operation. */ interface GetShipmentsResponse { 'payload'?: GetShipmentsResult; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } /** * Selling Partner API for Fulfillment Inbound * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network. * * The version of the OpenAPI document: v0 * * * 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 occured. */ 'code': string; /** * A message that describes the error condition in a human-readable form. */ 'message': string; /** * Additional details that can help the caller understand or fix the issue. */ 'details'?: string; } /** * FulfillmentInboundApi - axios parameter creator */ declare const FulfillmentInboundApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBillOfLading: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation. * @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. * @param {GetLabelsLabelTypeEnum} labelType The type of labels requested. * @param {number} [numberOfPackages] The number of packages in the shipment. * @param {Array} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code. * @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet. * @param {number} [pageSize] The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000. * @param {number} [pageStartIndex] The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels: (shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. * @param {Array} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response. * @param {Array} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrepInstructions: (shipToCountryCode: string, sellerSKUList?: Array, aSINList?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored. * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItems: (queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipmentId A shipment identifier used for selecting items in a specific inbound shipment. * @param {string} [marketplaceId] Deprecated. Do not use. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItemsByShipmentId: (shipmentId: string, marketplaceId?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored. * @param {Array} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. * @param {Array} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipments: (queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array, shipmentIdList?: Array, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * FulfillmentInboundApi - functional programming interface */ declare const FulfillmentInboundApiFp: (configuration?: Configuration) => { /** * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBillOfLading(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation. * @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. * @param {GetLabelsLabelTypeEnum} labelType The type of labels requested. * @param {number} [numberOfPackages] The number of packages in the shipment. * @param {Array} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code. * @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet. * @param {number} [pageSize] The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000. * @param {number} [pageStartIndex] The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels(shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. * @param {Array} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response. * @param {Array} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrepInstructions(shipToCountryCode: string, sellerSKUList?: Array, aSINList?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored. * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItems(queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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} shipmentId A shipment identifier used for selecting items in a specific inbound shipment. * @param {string} [marketplaceId] Deprecated. Do not use. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItemsByShipmentId(shipmentId: string, marketplaceId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored. * @param {Array} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. * @param {Array} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipments(queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array, shipmentIdList?: Array, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FulfillmentInboundApi - factory interface */ declare const FulfillmentInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getBillOfLading operation in FulfillmentInboundApi. */ interface FulfillmentInboundApiGetBillOfLadingRequest { /** * A shipment identifier originally returned by the createInboundShipmentPlan operation. */ readonly shipmentId: string; } /** * Request parameters for getLabels operation in FulfillmentInboundApi. */ interface FulfillmentInboundApiGetLabelsRequest { /** * A shipment identifier originally returned by the createInboundShipmentPlan operation. */ readonly shipmentId: string; /** * The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. */ readonly pageType: GetLabelsPageTypeEnum; /** * The type of labels requested. */ readonly labelType: GetLabelsLabelTypeEnum; /** * The number of packages in the shipment. */ readonly numberOfPackages?: number; /** * A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code. */ readonly packageLabelsToPrint?: Array; /** * The number of pallets in the shipment. This returns four identical labels for each pallet. */ readonly numberOfPallets?: number; /** * The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000. */ readonly pageSize?: number; /** * The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. */ readonly pageStartIndex?: number; } /** * Request parameters for getPrepInstructions operation in FulfillmentInboundApi. */ interface FulfillmentInboundApiGetPrepInstructionsRequest { /** * The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. */ readonly shipToCountryCode: string; /** * A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response. */ readonly sellerSKUList?: Array; /** * A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. */ readonly aSINList?: Array; } /** * Request parameters for getShipmentItems operation in FulfillmentInboundApi. */ interface FulfillmentInboundApiGetShipmentItemsRequest { /** * Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. */ readonly queryType: GetShipmentItemsQueryTypeEnum; /** * A marketplace identifier. Specifies the marketplace where the product would be stored. */ readonly marketplaceId: string; /** * A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. */ readonly lastUpdatedAfter?: string; /** * A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. */ readonly lastUpdatedBefore?: string; /** * A string token returned in the response to your previous request. */ readonly nextToken?: string; } /** * Request parameters for getShipmentItemsByShipmentId operation in FulfillmentInboundApi. */ interface FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest { /** * A shipment identifier used for selecting items in a specific inbound shipment. */ readonly shipmentId: string; /** * Deprecated. Do not use. */ readonly marketplaceId?: string; } /** * Request parameters for getShipments operation in FulfillmentInboundApi. */ interface FulfillmentInboundApiGetShipmentsRequest { /** * Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. */ readonly queryType: GetShipmentsQueryTypeEnum; /** * A marketplace identifier. Specifies the marketplace where the product would be stored. */ readonly marketplaceId: string; /** * A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. */ readonly shipmentStatusList?: Array; /** * A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. */ readonly shipmentIdList?: Array; /** * A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. */ readonly lastUpdatedAfter?: string; /** * A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. */ readonly lastUpdatedBefore?: string; /** * A string token returned in the response to your previous request. */ readonly nextToken?: string; } /** * FulfillmentInboundApi - object-oriented interface */ declare class FulfillmentInboundApi extends BaseAPI { /** * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise>; } declare const GetLabelsPageTypeEnum: { readonly PackageLabelLetter2: "PackageLabel_Letter_2"; readonly PackageLabelLetter4: "PackageLabel_Letter_4"; readonly PackageLabelLetter6: "PackageLabel_Letter_6"; readonly PackageLabelLetter6CarrierLeft: "PackageLabel_Letter_6_CarrierLeft"; readonly PackageLabelA42: "PackageLabel_A4_2"; readonly PackageLabelA44: "PackageLabel_A4_4"; readonly PackageLabelPlainPaper: "PackageLabel_Plain_Paper"; readonly PackageLabelPlainPaperCarrierBottom: "PackageLabel_Plain_Paper_CarrierBottom"; readonly PackageLabelThermal: "PackageLabel_Thermal"; readonly PackageLabelThermalUnified: "PackageLabel_Thermal_Unified"; readonly PackageLabelThermalNonPcp: "PackageLabel_Thermal_NonPCP"; readonly PackageLabelThermalNoCarrierRotation: "PackageLabel_Thermal_No_Carrier_Rotation"; }; type GetLabelsPageTypeEnum = typeof GetLabelsPageTypeEnum[keyof typeof GetLabelsPageTypeEnum]; declare const GetLabelsLabelTypeEnum: { readonly Barcode2D: "BARCODE_2D"; readonly Unique: "UNIQUE"; readonly Pallet: "PALLET"; }; type GetLabelsLabelTypeEnum = typeof GetLabelsLabelTypeEnum[keyof typeof GetLabelsLabelTypeEnum]; declare const GetShipmentItemsQueryTypeEnum: { readonly DateRange: "DATE_RANGE"; readonly NextToken: "NEXT_TOKEN"; }; type GetShipmentItemsQueryTypeEnum = typeof GetShipmentItemsQueryTypeEnum[keyof typeof GetShipmentItemsQueryTypeEnum]; declare const GetShipmentsQueryTypeEnum: { readonly Shipment: "SHIPMENT"; readonly DateRange: "DATE_RANGE"; readonly NextToken: "NEXT_TOKEN"; }; type GetShipmentsQueryTypeEnum = typeof GetShipmentsQueryTypeEnum[keyof typeof GetShipmentsQueryTypeEnum]; declare const GetShipmentsShipmentStatusListEnum: { readonly Working: "WORKING"; readonly ReadyToShip: "READY_TO_SHIP"; readonly Shipped: "SHIPPED"; readonly Receiving: "RECEIVING"; readonly Cancelled: "CANCELLED"; readonly Deleted: "DELETED"; readonly Closed: "CLOSED"; readonly Error: "ERROR"; readonly InTransit: "IN_TRANSIT"; readonly Delivered: "DELIVERED"; readonly CheckedIn: "CHECKED_IN"; }; type GetShipmentsShipmentStatusListEnum = typeof GetShipmentsShipmentStatusListEnum[keyof typeof GetShipmentsShipmentStatusListEnum]; declare const clientRateLimits: RateLimit[]; declare class FulfillmentInboundApiClient extends FulfillmentInboundApi { constructor(configuration: ClientConfiguration); } export { type ASINPrepInstructions, type Address, type AmazonPrepFeesDetails, type Amount, BarcodeInstruction, type BillOfLadingDownloadURL, type BoxContentsFeeDetails, BoxContentsSource, CurrencyCode, ErrorReason, FulfillmentInboundApi, FulfillmentInboundApiAxiosParamCreator, FulfillmentInboundApiClient, FulfillmentInboundApiFactory, FulfillmentInboundApiFp, type FulfillmentInboundApiGetBillOfLadingRequest, type FulfillmentInboundApiGetLabelsRequest, type FulfillmentInboundApiGetPrepInstructionsRequest, type FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, type FulfillmentInboundApiGetShipmentItemsRequest, type FulfillmentInboundApiGetShipmentsRequest, type GetBillOfLadingResponse, GetLabelsLabelTypeEnum, GetLabelsPageTypeEnum, type GetLabelsResponse, type GetPrepInstructionsResponse, type GetPrepInstructionsResult, GetShipmentItemsQueryTypeEnum, type GetShipmentItemsResponse, type GetShipmentItemsResult, GetShipmentsQueryTypeEnum, type GetShipmentsResponse, type GetShipmentsResult, GetShipmentsShipmentStatusListEnum, type InboundShipmentInfo, type InboundShipmentItem, type InvalidASIN, type InvalidSKU, type LabelDownloadURL, LabelPrepType, type ModelError, type PrepDetails, PrepGuidance, PrepInstruction, PrepOwner, type SKUPrepInstructions, ShipmentStatus, clientRateLimits };