UNPKG

@scaleleap/selling-partner-api-sdk

Version:

📦 A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API

1,724 lines (1,723 loc) • 178 kB
/** * 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. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * Reasons why a given ASIN is not recommended for shipment to Amazon\'s fulfillment network. * @export * @interface ASINInboundGuidance */ export interface ASINInboundGuidance { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof ASINInboundGuidance */ ASIN: string; /** * * @type {InboundGuidance} * @memberof ASINInboundGuidance */ InboundGuidance: InboundGuidance | 'InboundNotRecommended' | 'InboundOK'; /** * A list of inbound guidance reason information. * @type {Array<GuidanceReason>} * @memberof ASINInboundGuidance */ GuidanceReasonList?: Array<(GuidanceReason | 'SlowMovingASIN' | 'NoApplicableGuidance')>; } /** * Item preparation instructions to help with item sourcing decisions. * @export * @interface ASINPrepInstructions */ export interface ASINPrepInstructions { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof ASINPrepInstructions */ ASIN?: string; /** * * @type {BarcodeInstruction} * @memberof ASINPrepInstructions */ BarcodeInstruction?: BarcodeInstruction | 'RequiresFNSKULabel' | 'CanUseOriginalBarcode' | 'MustProvideSellerSKU'; /** * * @type {PrepGuidance} * @memberof ASINPrepInstructions */ PrepGuidance?: PrepGuidance | 'ConsultHelpDocuments' | 'NoAdditionalPrepRequired' | 'SeePrepInstructionsList'; /** * A list of preparation instructions to help with item sourcing decisions. * @type {Array<PrepInstruction>} * @memberof ASINPrepInstructions */ PrepInstructionList?: Array<(PrepInstruction | 'Polybagging' | 'BubbleWrapping' | 'Taping' | 'BlackShrinkWrapping' | 'Labeling' | 'HangGarment' | 'SetCreation' | 'Boxing' | 'RemoveFromHanger' | 'Debundle' | 'SuffocationStickering' | 'CapSealing' | 'SetStickering' | 'BlankStickering' | 'ShipsInProductPackaging' | 'NoPrep')>; } /** * Specific details to identify a place. * @export * @interface Address */ export interface Address { /** * Name of the individual or business. * @type {string} * @memberof Address */ Name: string; /** * The street address information. * @type {string} * @memberof Address */ AddressLine1: string; /** * Additional street address information, if required. * @type {string} * @memberof Address */ AddressLine2?: string; /** * The district or county. * @type {string} * @memberof Address */ DistrictOrCounty?: string; /** * The city. * @type {string} * @memberof Address */ 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. * @type {string} * @memberof Address */ StateOrProvinceCode: string; /** * The country code in two-character ISO 3166-1 alpha-2 format. * @type {string} * @memberof Address */ 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. * @type {string} * @memberof Address */ PostalCode: string; } /** * The fees for Amazon to prep goods for shipment. * @export * @interface AmazonPrepFeesDetails */ export interface AmazonPrepFeesDetails { /** * * @type {PrepInstruction} * @memberof AmazonPrepFeesDetails */ PrepInstruction?: PrepInstruction | 'Polybagging' | 'BubbleWrapping' | 'Taping' | 'BlackShrinkWrapping' | 'Labeling' | 'HangGarment' | 'SetCreation' | 'Boxing' | 'RemoveFromHanger' | 'Debundle' | 'SuffocationStickering' | 'CapSealing' | 'SetStickering' | 'BlankStickering' | 'ShipsInProductPackaging' | 'NoPrep'; /** * * @type {Amount} * @memberof AmazonPrepFeesDetails */ FeePerUnit?: Amount; } /** * The monetary value. * @export * @interface Amount */ export interface Amount { /** * * @type {CurrencyCode} * @memberof Amount */ CurrencyCode: CurrencyCode | 'USD' | 'GBP'; /** * Number format that supports decimal. * @type {number} * @memberof Amount */ Value: number; } /** * Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace. * @export * @enum {string} */ export declare enum BarcodeInstruction { RequiresFnskuLabel = "RequiresFNSKULabel", CanUseOriginalBarcode = "CanUseOriginalBarcode", MustProvideSellerSku = "MustProvideSellerSKU" } /** * Download URL for the bill of lading. * @export * @interface BillOfLadingDownloadURL */ export interface BillOfLadingDownloadURL { /** * URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds * @type {string} * @memberof BillOfLadingDownloadURL */ DownloadURL?: string; } /** * The manual processing fee per unit and total fee for a shipment. * @export * @interface BoxContentsFeeDetails */ export interface BoxContentsFeeDetails { /** * The item quantity. * @type {number} * @memberof BoxContentsFeeDetails */ TotalUnits?: number; /** * * @type {Amount} * @memberof BoxContentsFeeDetails */ FeePerUnit?: Amount; /** * * @type {Amount} * @memberof BoxContentsFeeDetails */ TotalFee?: Amount; } /** * Where the seller provided box contents information for a shipment. * @export * @enum {string} */ export declare enum BoxContentsSource { None = "NONE", Feed = "FEED", _2DBarcode = "2D_BARCODE", Interactive = "INTERACTIVE" } /** * Common container for transport result * @export * @interface CommonTransportResult */ export interface CommonTransportResult { /** * * @type {TransportResult} * @memberof CommonTransportResult */ TransportResult?: TransportResult; } /** * The condition of the item. * @export * @enum {string} */ export declare enum Condition { NewItem = "NewItem", NewWithWarranty = "NewWithWarranty", NewOem = "NewOEM", NewOpenBox = "NewOpenBox", UsedLikeNew = "UsedLikeNew", UsedVeryGood = "UsedVeryGood", UsedGood = "UsedGood", UsedAcceptable = "UsedAcceptable", UsedPoor = "UsedPoor", UsedRefurbished = "UsedRefurbished", CollectibleLikeNew = "CollectibleLikeNew", CollectibleVeryGood = "CollectibleVeryGood", CollectibleGood = "CollectibleGood", CollectibleAcceptable = "CollectibleAcceptable", CollectiblePoor = "CollectiblePoor", RefurbishedWithWarranty = "RefurbishedWithWarranty", Refurbished = "Refurbished", Club = "Club" } /** * The response schema for the confirmPreorder operation. * @export * @interface ConfirmPreorderResponse */ export interface ConfirmPreorderResponse { /** * * @type {ConfirmPreorderResult} * @memberof ConfirmPreorderResponse */ payload?: ConfirmPreorderResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof ConfirmPreorderResponse */ errors?: Array<Error>; } /** * Result for confirm preorder operation * @export * @interface ConfirmPreorderResult */ export interface ConfirmPreorderResult { /** * Type containing date in string format * @type {string} * @memberof ConfirmPreorderResult */ ConfirmedNeedByDate?: string; /** * Type containing date in string format * @type {string} * @memberof ConfirmPreorderResult */ ConfirmedFulfillableDate?: string; } /** * The response schema for the confirmTransport operation. * @export * @interface ConfirmTransportResponse */ export interface ConfirmTransportResponse { /** * * @type {CommonTransportResult} * @memberof ConfirmTransportResponse */ payload?: CommonTransportResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof ConfirmTransportResponse */ errors?: Array<Error>; } /** * Contact information for the person in the seller\'s organization who is responsible for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. * @export * @interface Contact */ export interface Contact { /** * The name of the contact person. * @type {string} * @memberof Contact */ Name: string; /** * The phone number of the contact person. * @type {string} * @memberof Contact */ Phone: string; /** * The email address of the contact person. * @type {string} * @memberof Contact */ Email: string; /** * The fax number of the contact person. * @type {string} * @memberof Contact */ Fax?: string; } /** * The request schema for the createInboundShipmentPlan operation. * @export * @interface CreateInboundShipmentPlanRequest */ export interface CreateInboundShipmentPlanRequest { /** * * @type {Address} * @memberof CreateInboundShipmentPlanRequest */ ShipFromAddress: Address; /** * * @type {LabelPrepPreference} * @memberof CreateInboundShipmentPlanRequest */ LabelPrepPreference: LabelPrepPreference | 'SELLER_LABEL' | 'AMAZON_LABEL_ONLY' | 'AMAZON_LABEL_PREFERRED'; /** * The two-character country code for the country where the inbound shipment is to be sent. Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error. Values: ShipToCountryCode values for North America: * CA – Canada * MX - Mexico * US - United States ShipToCountryCode values for MCI sellers in Europe: * DE – Germany * ES – Spain * FR – France * GB – United Kingdom * IT – Italy Default: The country code for the seller\'s home marketplace. * @type {string} * @memberof CreateInboundShipmentPlanRequest */ ShipToCountryCode?: string; /** * The two-character country code, followed by a dash and then up to three characters that represent the subdivision of the country where the inbound shipment is to be sent. For example, \"IN-MH\". In full ISO 3166-2 format. Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error. * @type {string} * @memberof CreateInboundShipmentPlanRequest */ ShipToCountrySubdivisionCode?: string; /** * List of inbound shipment plan requests * @type {Array<InboundShipmentPlanRequestItem>} * @memberof CreateInboundShipmentPlanRequest */ InboundShipmentPlanRequestItems: Array<InboundShipmentPlanRequestItem>; } /** * The response schema for the createInboundShipmentPlan operation. * @export * @interface CreateInboundShipmentPlanResponse */ export interface CreateInboundShipmentPlanResponse { /** * * @type {CreateInboundShipmentPlanResult} * @memberof CreateInboundShipmentPlanResponse */ payload?: CreateInboundShipmentPlanResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof CreateInboundShipmentPlanResponse */ errors?: Array<Error>; } /** * Result for the create inbound shipment operation * @export * @interface CreateInboundShipmentPlanResult */ export interface CreateInboundShipmentPlanResult { /** * A list of inbound shipment plan information * @type {Array<InboundShipmentPlan>} * @memberof CreateInboundShipmentPlanResult */ InboundShipmentPlans?: Array<InboundShipmentPlan>; } /** * The currency code. * @export * @enum {string} */ export declare enum CurrencyCode { Usd = "USD", Gbp = "GBP" } /** * The dimension values and unit of measurement. * @export * @interface Dimensions */ export interface Dimensions { /** * Number format that supports decimal. * @type {number} * @memberof Dimensions */ Length: number; /** * Number format that supports decimal. * @type {number} * @memberof Dimensions */ Width: number; /** * Number format that supports decimal. * @type {number} * @memberof Dimensions */ Height: number; /** * * @type {UnitOfMeasurement} * @memberof Dimensions */ Unit: UnitOfMeasurement | 'inches' | 'centimeters'; } /** * The reason that the ASIN is invalid. * @export * @enum {string} */ export declare enum ErrorReason { DoesNotExist = "DoesNotExist", InvalidAsin = "InvalidASIN" } /** * The response schema for the estimateTransport operation. * @export * @interface EstimateTransportResponse */ export interface EstimateTransportResponse { /** * * @type {CommonTransportResult} * @memberof EstimateTransportResponse */ payload?: CommonTransportResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof EstimateTransportResponse */ errors?: Array<Error>; } /** * The response schema for the getBillOfLading operation. * @export * @interface GetBillOfLadingResponse */ export interface GetBillOfLadingResponse { /** * * @type {BillOfLadingDownloadURL} * @memberof GetBillOfLadingResponse */ payload?: BillOfLadingDownloadURL; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetBillOfLadingResponse */ errors?: Array<Error>; } /** * Result for the get inbound guidance operation * @export * @interface GetInboundGuidanceResult */ export interface GetInboundGuidanceResult { /** * A list of SKU inbound guidance information. * @type {Array<SKUInboundGuidance>} * @memberof GetInboundGuidanceResult */ SKUInboundGuidanceList?: Array<SKUInboundGuidance>; /** * A list of invalid SKU values and the reason they are invalid. * @type {Array<InvalidSKU>} * @memberof GetInboundGuidanceResult */ InvalidSKUList?: Array<InvalidSKU>; /** * A list of ASINs and their associated inbound guidance. * @type {Array<ASINInboundGuidance>} * @memberof GetInboundGuidanceResult */ ASINInboundGuidanceList?: Array<ASINInboundGuidance>; /** * A list of invalid ASIN values and the reasons they are invalid. * @type {Array<InvalidASIN>} * @memberof GetInboundGuidanceResult */ InvalidASINList?: Array<InvalidASIN>; } /** * The response schema for the getLabels operation. * @export * @interface GetLabelsResponse */ export interface GetLabelsResponse { /** * * @type {LabelDownloadURL} * @memberof GetLabelsResponse */ payload?: LabelDownloadURL; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetLabelsResponse */ errors?: Array<Error>; } /** * The response schema for the getPreorderInfo operation. * @export * @interface GetPreorderInfoResponse */ export interface GetPreorderInfoResponse { /** * * @type {GetPreorderInfoResult} * @memberof GetPreorderInfoResponse */ payload?: GetPreorderInfoResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetPreorderInfoResponse */ errors?: Array<Error>; } /** * Result for the get preorder info operation * @export * @interface GetPreorderInfoResult */ export interface GetPreorderInfoResult { /** * Indicates whether the shipment contains items that have been enabled for pre-order. For more information about enabling items for pre-order, see the Seller Central Help. * @type {boolean} * @memberof GetPreorderInfoResult */ ShipmentContainsPreorderableItems?: boolean; /** * Indicates whether this shipment has been confirmed for pre-order. * @type {boolean} * @memberof GetPreorderInfoResult */ ShipmentConfirmedForPreorder?: boolean; /** * Type containing date in string format * @type {string} * @memberof GetPreorderInfoResult */ NeedByDate?: string; /** * Type containing date in string format * @type {string} * @memberof GetPreorderInfoResult */ ConfirmedFulfillableDate?: string; } /** * The response schema for the getPrepInstructions operation. * @export * @interface GetPrepInstructionsResponse */ export interface GetPrepInstructionsResponse { /** * * @type {GetPrepInstructionsResult} * @memberof GetPrepInstructionsResponse */ payload?: GetPrepInstructionsResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetPrepInstructionsResponse */ errors?: Array<Error>; } /** * Result for the get prep instructions operation * @export * @interface GetPrepInstructionsResult */ export interface GetPrepInstructionsResult { /** * A list of SKU labeling requirements and item preparation instructions. * @type {Array<SKUPrepInstructions>} * @memberof GetPrepInstructionsResult */ SKUPrepInstructionsList?: Array<SKUPrepInstructions>; /** * A list of invalid SKU values and the reason they are invalid. * @type {Array<InvalidSKU>} * @memberof GetPrepInstructionsResult */ InvalidSKUList?: Array<InvalidSKU>; /** * A list of item preparation instructions. * @type {Array<ASINPrepInstructions>} * @memberof GetPrepInstructionsResult */ ASINPrepInstructionsList?: Array<ASINPrepInstructions>; /** * A list of invalid ASIN values and the reasons they are invalid. * @type {Array<InvalidASIN>} * @memberof GetPrepInstructionsResult */ InvalidASINList?: Array<InvalidASIN>; } /** * The response schema for the getShipmentItems operation. * @export * @interface GetShipmentItemsResponse */ export interface GetShipmentItemsResponse { /** * * @type {GetShipmentItemsResult} * @memberof GetShipmentItemsResponse */ payload?: GetShipmentItemsResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetShipmentItemsResponse */ errors?: Array<Error>; } /** * Result for the get shipment items operation * @export * @interface GetShipmentItemsResult */ export interface GetShipmentItemsResult { /** * A list of inbound shipment item information. * @type {Array<InboundShipmentItem>} * @memberof GetShipmentItemsResult */ ItemData?: Array<InboundShipmentItem>; /** * When present and not empty, pass this string token in the next request to return the next response page. * @type {string} * @memberof GetShipmentItemsResult */ NextToken?: string; } /** * The response schema for the getShipments operation. * @export * @interface GetShipmentsResponse */ export interface GetShipmentsResponse { /** * * @type {GetShipmentsResult} * @memberof GetShipmentsResponse */ payload?: GetShipmentsResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetShipmentsResponse */ errors?: Array<Error>; } /** * Result for the get shipments operation * @export * @interface GetShipmentsResult */ export interface GetShipmentsResult { /** * A list of inbound shipment information. * @type {Array<InboundShipmentInfo>} * @memberof GetShipmentsResult */ ShipmentData?: Array<InboundShipmentInfo>; /** * When present and not empty, pass this string token in the next request to return the next response page. * @type {string} * @memberof GetShipmentsResult */ NextToken?: string; } /** * The response schema for the getTransportDetails operation. * @export * @interface GetTransportDetailsResponse */ export interface GetTransportDetailsResponse { /** * * @type {GetTransportDetailsResult} * @memberof GetTransportDetailsResponse */ payload?: GetTransportDetailsResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof GetTransportDetailsResponse */ errors?: Array<Error>; } /** * Result for the get transport details operation * @export * @interface GetTransportDetailsResult */ export interface GetTransportDetailsResult { /** * * @type {TransportContent} * @memberof GetTransportDetailsResult */ TransportContent?: TransportContent; } /** * A reason for the current inbound guidance for an item. * @export * @enum {string} */ export declare enum GuidanceReason { SlowMovingAsin = "SlowMovingASIN", NoApplicableGuidance = "NoApplicableGuidance" } /** * Specific inbound guidance for an item. * @export * @enum {string} */ export declare enum InboundGuidance { InboundNotRecommended = "InboundNotRecommended", InboundOk = "InboundOK" } /** * Inbound shipment information used to create and update inbound shipments. * @export * @interface InboundShipmentHeader */ export interface InboundShipmentHeader { /** * The name for the shipment. Use a naming convention that helps distinguish between shipments over time, such as the date the shipment was created. * @type {string} * @memberof InboundShipmentHeader */ ShipmentName: string; /** * * @type {Address} * @memberof InboundShipmentHeader */ ShipFromAddress: Address; /** * The identifier for the fulfillment center to which the shipment will be shipped. Get this value from the InboundShipmentPlan object in the response returned by the createInboundShipmentPlan operation. * @type {string} * @memberof InboundShipmentHeader */ DestinationFulfillmentCenterId: string; /** * Indicates whether or not an inbound shipment contains case-packed boxes. Note: A shipment must contain either all case-packed boxes or all individually packed boxes. Possible values: true - All boxes in the shipment must be case packed. false - All boxes in the shipment must be individually packed. Note: If AreCasesRequired = true for an inbound shipment, then the value of QuantityInCase must be greater than zero for every item in the shipment. Otherwise the service returns an error. * @type {boolean} * @memberof InboundShipmentHeader */ AreCasesRequired?: boolean; /** * * @type {ShipmentStatus} * @memberof InboundShipmentHeader */ ShipmentStatus: ShipmentStatus | 'WORKING' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'; /** * * @type {LabelPrepPreference} * @memberof InboundShipmentHeader */ LabelPrepPreference: LabelPrepPreference | 'SELLER_LABEL' | 'AMAZON_LABEL_ONLY' | 'AMAZON_LABEL_PREFERRED'; /** * * @type {IntendedBoxContentsSource} * @memberof InboundShipmentHeader */ IntendedBoxContentsSource?: IntendedBoxContentsSource | 'NONE' | 'FEED' | '2D_BARCODE'; } /** * Information about the seller\'s inbound shipments. Returned by the listInboundShipments operation. * @export * @interface InboundShipmentInfo */ export interface InboundShipmentInfo { /** * The shipment identifier submitted in the request. * @type {string} * @memberof InboundShipmentInfo */ ShipmentId?: string; /** * The name for the inbound shipment. * @type {string} * @memberof InboundShipmentInfo */ ShipmentName?: string; /** * * @type {Address} * @memberof InboundShipmentInfo */ ShipFromAddress: Address; /** * An Amazon fulfillment center identifier created by Amazon. * @type {string} * @memberof InboundShipmentInfo */ DestinationFulfillmentCenterId?: string; /** * * @type {ShipmentStatus} * @memberof InboundShipmentInfo */ ShipmentStatus?: ShipmentStatus | 'WORKING' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'; /** * * @type {LabelPrepType} * @memberof InboundShipmentInfo */ LabelPrepType?: LabelPrepType | 'NO_LABEL' | 'SELLER_LABEL' | 'AMAZON_LABEL'; /** * 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. * @type {boolean} * @memberof InboundShipmentInfo */ AreCasesRequired: boolean; /** * Type containing date in string format * @type {string} * @memberof InboundShipmentInfo */ ConfirmedNeedByDate?: string; /** * * @type {BoxContentsSource} * @memberof InboundShipmentInfo */ BoxContentsSource?: BoxContentsSource | 'NONE' | 'FEED' | '2D_BARCODE' | 'INTERACTIVE'; /** * * @type {BoxContentsFeeDetails} * @memberof InboundShipmentInfo */ EstimatedBoxContentsFee?: BoxContentsFeeDetails; } /** * Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation. * @export * @interface InboundShipmentItem */ export interface InboundShipmentItem { /** * A shipment identifier originally returned by the createInboundShipmentPlan operation. * @type {string} * @memberof InboundShipmentItem */ ShipmentId?: string; /** * The seller SKU of the item. * @type {string} * @memberof InboundShipmentItem */ SellerSKU: string; /** * Amazon\'s fulfillment network SKU of the item. * @type {string} * @memberof InboundShipmentItem */ FulfillmentNetworkSKU?: string; /** * The item quantity. * @type {number} * @memberof InboundShipmentItem */ QuantityShipped: number; /** * The item quantity. * @type {number} * @memberof InboundShipmentItem */ QuantityReceived?: number; /** * The item quantity. * @type {number} * @memberof InboundShipmentItem */ QuantityInCase?: number; /** * Type containing date in string format * @type {string} * @memberof InboundShipmentItem */ ReleaseDate?: string; /** * A list of preparation instructions and who is responsible for that preparation. * @type {Array<PrepDetails>} * @memberof InboundShipmentItem */ PrepDetailsList?: Array<PrepDetails>; } /** * Inbound shipment information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation. * @export * @interface InboundShipmentPlan */ export interface InboundShipmentPlan { /** * A shipment identifier originally returned by the createInboundShipmentPlan operation. * @type {string} * @memberof InboundShipmentPlan */ ShipmentId: string; /** * An Amazon fulfillment center identifier created by Amazon. * @type {string} * @memberof InboundShipmentPlan */ DestinationFulfillmentCenterId: string; /** * * @type {Address} * @memberof InboundShipmentPlan */ ShipToAddress: Address; /** * * @type {LabelPrepType} * @memberof InboundShipmentPlan */ LabelPrepType: LabelPrepType | 'NO_LABEL' | 'SELLER_LABEL' | 'AMAZON_LABEL'; /** * A list of inbound shipment plan item information. * @type {Array<InboundShipmentPlanItem>} * @memberof InboundShipmentPlan */ Items: Array<InboundShipmentPlanItem>; /** * * @type {BoxContentsFeeDetails} * @memberof InboundShipmentPlan */ EstimatedBoxContentsFee?: BoxContentsFeeDetails; } /** * Item information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation. * @export * @interface InboundShipmentPlanItem */ export interface InboundShipmentPlanItem { /** * The seller SKU of the item. * @type {string} * @memberof InboundShipmentPlanItem */ SellerSKU: string; /** * Amazon\'s fulfillment network SKU of the item. * @type {string} * @memberof InboundShipmentPlanItem */ FulfillmentNetworkSKU: string; /** * The item quantity. * @type {number} * @memberof InboundShipmentPlanItem */ Quantity: number; /** * A list of preparation instructions and who is responsible for that preparation. * @type {Array<PrepDetails>} * @memberof InboundShipmentPlanItem */ PrepDetailsList?: Array<PrepDetails>; } /** * Item information for creating an inbound shipment plan. Submitted with a call to the createInboundShipmentPlan operation. * @export * @interface InboundShipmentPlanRequestItem */ export interface InboundShipmentPlanRequestItem { /** * The seller SKU of the item. * @type {string} * @memberof InboundShipmentPlanRequestItem */ SellerSKU: string; /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof InboundShipmentPlanRequestItem */ ASIN: string; /** * * @type {Condition} * @memberof InboundShipmentPlanRequestItem */ Condition: Condition | 'NewItem' | 'NewWithWarranty' | 'NewOEM' | 'NewOpenBox' | 'UsedLikeNew' | 'UsedVeryGood' | 'UsedGood' | 'UsedAcceptable' | 'UsedPoor' | 'UsedRefurbished' | 'CollectibleLikeNew' | 'CollectibleVeryGood' | 'CollectibleGood' | 'CollectibleAcceptable' | 'CollectiblePoor' | 'RefurbishedWithWarranty' | 'Refurbished' | 'Club'; /** * The item quantity. * @type {number} * @memberof InboundShipmentPlanRequestItem */ Quantity: number; /** * The item quantity. * @type {number} * @memberof InboundShipmentPlanRequestItem */ QuantityInCase?: number; /** * A list of preparation instructions and who is responsible for that preparation. * @type {Array<PrepDetails>} * @memberof InboundShipmentPlanRequestItem */ PrepDetailsList?: Array<PrepDetails>; } /** * The request schema for an inbound shipment. * @export * @interface InboundShipmentRequest */ export interface InboundShipmentRequest { /** * * @type {InboundShipmentHeader} * @memberof InboundShipmentRequest */ InboundShipmentHeader: InboundShipmentHeader; /** * A list of inbound shipment item information. * @type {Array<InboundShipmentItem>} * @memberof InboundShipmentRequest */ InboundShipmentItems: Array<InboundShipmentItem>; /** * A marketplace identifier. Specifies the marketplace where the product would be stored. * @type {string} * @memberof InboundShipmentRequest */ MarketplaceId: string; } /** * The response schema for this operation. * @export * @interface InboundShipmentResponse */ export interface InboundShipmentResponse { /** * * @type {InboundShipmentResult} * @memberof InboundShipmentResponse */ payload?: InboundShipmentResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array<Error>} * @memberof InboundShipmentResponse */ errors?: Array<Error>; } /** * Result of an inbound shipment operation * @export * @interface InboundShipmentResult */ export interface InboundShipmentResult { /** * The shipment identifier submitted in the request. * @type {string} * @memberof InboundShipmentResult */ ShipmentId: string; } /** * How the seller intends to provide box contents information for a shipment. Leaving this field blank is equivalent to selecting `NONE`, which will incur a fee if the seller does not provide box contents information. * @export * @enum {string} */ export declare enum IntendedBoxContentsSource { None = "NONE", Feed = "FEED", _2DBarcode = "2D_BARCODE" } /** * Contains details about an invalid ASIN * @export * @interface InvalidASIN */ export interface InvalidASIN { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof InvalidASIN */ ASIN?: string; /** * * @type {ErrorReason} * @memberof InvalidASIN */ ErrorReason?: ErrorReason | 'DoesNotExist' | 'InvalidASIN'; } /** * Contains detail about an invalid SKU * @export * @interface InvalidSKU */ export interface InvalidSKU { /** * The seller SKU of the item. * @type {string} * @memberof InvalidSKU */ SellerSKU?: string; /** * * @type {ErrorReason} * @memberof InvalidSKU */ ErrorReason?: ErrorReason | 'DoesNotExist' | 'InvalidASIN'; } /** * Download URL for a label * @export * @interface LabelDownloadURL */ export interface LabelDownloadURL { /** * URL to download the label for the package. Note: The URL will only be valid for 15 seconds * @type {string} * @memberof LabelDownloadURL */ DownloadURL?: string; } /** * The preference for label preparation for an inbound shipment. * @export * @enum {string} */ export declare enum LabelPrepPreference { SellerLabel = "SELLER_LABEL", AmazonLabelOnly = "AMAZON_LABEL_ONLY", AmazonLabelPreferred = "AMAZON_LABEL_PREFERRED" } /** * The type of label preparation that is required for the inbound shipment. * @export * @enum {string} */ export declare enum LabelPrepType { NoLabel = "NO_LABEL", SellerLabel = "SELLER_LABEL", AmazonLabel = "AMAZON_LABEL" } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occured. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition in a human-readable form. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * Information that you provide to Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon. * @export * @interface NonPartneredLtlDataInput */ export interface NonPartneredLtlDataInput { /** * The carrier that you are using for the inbound shipment. * @type {string} * @memberof NonPartneredLtlDataInput */ CarrierName: string; /** * The PRO number (\"progressive number\" or \"progressive ID\") assigned to the shipment by the carrier. * @type {string} * @memberof NonPartneredLtlDataInput */ ProNumber: string; } /** * Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment shipped by a carrier that has not partnered with Amazon. * @export * @interface NonPartneredLtlDataOutput */ export interface NonPartneredLtlDataOutput { /** * The carrier that you are using for the inbound shipment. * @type {string} * @memberof NonPartneredLtlDataOutput */ CarrierName: string; /** * The PRO number (\"progressive number\" or \"progressive ID\") assigned to the shipment by the carrier. * @type {string} * @memberof NonPartneredLtlDataOutput */ ProNumber: string; } /** * Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon. * @export * @interface NonPartneredSmallParcelDataInput */ export interface NonPartneredSmallParcelDataInput { /** * The carrier that you are using for the inbound shipment. * @type {string} * @memberof NonPartneredSmallParcelDataInput */ CarrierName: string; /** * A list of package tracking information. * @type {Array<NonPartneredSmallParcelPackageInput>} * @memberof NonPartneredSmallParcelDataInput */ PackageList: Array<NonPartneredSmallParcelPackageInput>; } /** * Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon. * @export * @interface NonPartneredSmallParcelDataOutput */ export interface NonPartneredSmallParcelDataOutput { /** * A list of packages, including carrier, tracking number, and status information for each package. * @type {Array<NonPartneredSmallParcelPackageOutput>} * @memberof NonPartneredSmallParcelDataOutput */ PackageList: Array<NonPartneredSmallParcelPackageOutput>; } /** * The tracking number of the package, provided by the carrier. * @export * @interface NonPartneredSmallParcelPackageInput */ export interface NonPartneredSmallParcelPackageInput { /** * The tracking number of the package, provided by the carrier. * @type {string} * @memberof NonPartneredSmallParcelPackageInput */ TrackingId: string; } /** * Carrier, tracking number, and status information for the package. * @export * @interface NonPartneredSmallParcelPackageOutput */ export interface NonPartneredSmallParcelPackageOutput { /** * The carrier that you are using for the inbound shipment. * @type {string} * @memberof NonPartneredSmallParcelPackageOutput */ CarrierName: string; /** * The tracking number of the package, provided by the carrier. * @type {string} * @memberof NonPartneredSmallParcelPackageOutput */ TrackingId: string; /** * * @type {PackageStatus} * @memberof NonPartneredSmallParcelPackageOutput */ PackageStatus: PackageStatus | 'SHIPPED' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN' | 'RECEIVING' | 'CLOSED' | 'DELETED'; } /** * The shipment status of the package. * @export * @enum {string} */ export declare enum PackageStatus { Shipped = "SHIPPED", InTransit = "IN_TRANSIT", Delivered = "DELIVERED", CheckedIn = "CHECKED_IN", Receiving = "RECEIVING", Closed = "CLOSED", Deleted = "DELETED" } /** * Pallet information. * @export * @interface Pallet */ export interface Pallet { /** * * @type {Dimensions} * @memberof Pallet */ Dimensions: Dimensions; /** * * @type {Weight} * @memberof Pallet */ Weight?: Weight; /** * Indicates whether pallets will be stacked when carrier arrives for pick-up. * @type {boolean} * @memberof Pallet */ IsStacked: boolean; } /** * The estimated shipping cost for a shipment using an Amazon-partnered carrier. * @export * @interface PartneredEstimate */ export interface PartneredEstimate { /** * * @type {Amount} * @memberof PartneredEstimate */ Amount: Amount; /** * Timestamp in ISO 8601 format. * @type {string} * @memberof PartneredEstimate */ ConfirmDeadline?: string; /** * Timestamp in ISO 8601 format. * @type {string} * @memberof PartneredEstimate */ VoidDeadline?: string; } /** * Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. * @export * @interface PartneredLtlDataInput */ export interface PartneredLtlDataInput { /** * * @type {Contact} * @memberof PartneredLtlDataInput */ Contact?: Contact; /** * Contains an unsigned integer * @type {number} * @memberof PartneredLtlDataInput */ BoxCount?: number; /** * * @type {SellerFreightClass} * @memberof PartneredLtlDataInput */ SellerFreightClass?: SellerFreightClass | '50' | '55' | '60' | '65' | '70' | '77.5' | '85' | '92.5' | '100' | '110' | '125' | '150' | '175' | '200' | '250' | '300' | '400' | '500'; /** * Type containing date in string format * @type {string} * @memberof PartneredLtlDataInput */ FreightReadyDate?: string; /** * A list of pallet information. * @type {Array<Pallet>} * @memberof PartneredLtlDataInput */ PalletList?: Array<Pallet>; /** * * @type {Weight} * @memberof PartneredLtlDataInput */ TotalWeight?: Weight; /** * * @type {Amount} * @memberof PartneredLtlDataInput */ SellerDeclaredValue?: Amount; } /** * Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier. * @export * @interface PartneredLtlDataOutput */ export interface PartneredLtlDataOutput { /** * * @type {Contact} * @memberof PartneredLtlDataOutput */ Contact: Contact; /** * Contains an unsigned integer * @type {number} * @memberof PartneredLtlDataOutput */ BoxCount: number; /** * * @type {SellerFreightClass} * @memberof PartneredLtlDataOutput */ SellerFreightClass?: SellerFreightClass | '50' | '55' | '60' | '65' | '70' | '77.5' | '85' | '92.5' | '100' | '110' | '125' | '150' | '175' | '200' | '250' | '300' | '400' | '500'; /** * Type containing date in string format * @type {string} * @memberof PartneredLtlDataOutput */ FreightReadyDate: string; /** * A list of pallet information. * @type {Array<Pallet>} * @memberof PartneredLtlDataOutput */ PalletList: Array<Pallet>; /** * * @type {Weight} * @memberof PartneredLtlDataOutput */ TotalWeight: Weight; /** * * @type {Amount} * @memberof PartneredLtlDataOutput */ SellerDeclaredValue?: Amount; /** * * @type {Amount} * @memberof PartneredLtlDataOutput */ AmazonCalculatedValue?: Amount; /** * Type containing date in string format * @type {string} * @memberof PartneredLtlDataOutput */ PreviewPickupDate: string; /** * Type containing date in string format * @type {string} * @memberof PartneredLtlDataOutput */ PreviewDeliveryDate: string; /** * * @type {SellerFreightClass} * @memberof PartneredLtlDataOutput */ PreviewFreightClass: SellerFreightClass | '50' | '55' | '60' | '65' | '70' | '77.5' | '85' | '92.5' | '100' | '110' | '125' | '150' | '175' | '200' | '250' | '300' | '400' | '500'; /** * A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment. * @type {string} * @memberof PartneredLtlDataOutput */ AmazonReferenceId: string; /** * Indicates whether the bill of lading for the shipment is available. * @type {boolean} * @memberof PartneredLtlDataOutput */ IsBillOfLadingAvailable: boolean; /** * * @type {PartneredEstimate} * @memberof PartneredLtlDataOutput */ PartneredEstimate?: PartneredEstimate; /** * The carrier for the inbound shipment. * @type {string} * @memberof PartneredLtlDataOutput */ CarrierName: string; } /** * Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment. * @export * @interface PartneredSmallParcelDataInput */ export interface PartneredSmallParcelDataInput { /** * A list of dimensions and weight information for packages. * @type {Array<PartneredSmallParcelPackageInput>} * @memberof PartneredSmallParcelDataInput */ PackageList?: Array<PartneredSmallParcelPackageInput>; /** * The Amazon-partnered carrier to use for the inbound shipment. **`CarrierName`** values in France (FR), Italy (IT), Spain (ES), the United Kingdom (UK), and the United States (US): `UNITED_PARCEL_SERVICE_INC`. <br> **`CarrierName`** values in Germany (DE): `DHL_STANDARD`,`UNITED_PARCEL_SERVICE_INC`. <br>Default: `UNITED_PARCEL_SERVICE_INC`. * @type {string} * @memberof PartneredSmallParcelDataInput */ CarrierName?: string; } /** * Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier. * @export * @interface PartneredSmallParcelDataOutput */ export interface PartneredSmallParcelDataOutput { /** * A list of packages, including shipping information from the Amazon-partnered carrier. * @type {Array<PartneredSmallParcelPackageOutput>} * @memberof PartneredSmallParcelDataOutput */ PackageList: Array<PartneredSmallParcelPackageOutput>; /** * * @type {PartneredEstimate} * @memberof PartneredSmallParcelDataOutput */ PartneredEstimate?: PartneredEstimate; } /** * Dimension and weight information for the package. * @export * @interface PartneredSmallParcelPackageInput */ export interface PartneredSmallParcelPackageInput { /** * * @type {Dimensions} * @memberof PartneredSmallParcelPackageInput */ Dimensions: Dimensions; /** * * @type {Weight} * @memberof PartneredSmallParcelPackageInput */ Weight: Weight; } /** * Dimension, weight, and shipping information for the package. * @export * @interface PartneredSmallParcelPackageOutput */ export interface PartneredSmallParcelPackageOutput { /** * * @type {Dimensions} * @memberof PartneredSmallParcelPackageOutput */ Dimensions: Dimensions; /** * * @type {Weight} * @memberof PartneredSmallParcelPackageOutput */ Weight: Weight; /** * The carrier specified with a previous call to putTransportDetails. * @type {string} * @memberof PartneredSmallParcelPackageOutput */ CarrierName: string; /** * The tracking number of the package, provided by the carrier. * @type {string} * @memberof PartneredSmallParcelPackageOutput */ TrackingId: string; /** * * @type {PackageStatus} * @memberof PartneredSmallParcelPackageOutput */ PackageStatus: PackageStatus | 'SHIPPED' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN' | 'RECEIVING' | 'CLOSED' | 'DELETED'; } /** * Preparation instructions and who is responsible for the preparation. * @export * @interface PrepDetails */ export interface PrepDetails { /** * * @type {PrepInstruction} * @memberof PrepDetails */ PrepInstruction: PrepInstruction | 'Polybagging' | 'BubbleWrapping' | 'Taping' | 'BlackShrinkWrapping' | 'Labeling' | 'HangGarment' | 'SetCreation' | 'Boxing' | 'RemoveFromHanger' | 'Debundle' | 'SuffocationStickering' | 'CapSealing' | 'SetStickering' | 'BlankStickering' | 'ShipsInProductPackaging' | 'NoPrep'; /** * * @type {PrepOwner} * @memberof PrepDetails */ PrepOwner: PrepOwner | 'AMAZON' | 'SELLER'; } /** * Item preparation instructions. * @export * @enum {string} */ export declare enum PrepGuidance { ConsultHelpDocuments = "ConsultHelpDocuments", NoAdditionalPrepRequired = "NoAdditionalPrepRequired", SeePrepInstructionsList = "SeePrepInstructionsList" } /** * 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. * @export * @enum {string} */ export declare enum PrepInstruction { Polybagging = "Polybagging", BubbleWrapping = "BubbleWrapping", Taping = "Taping", BlackShrinkWrapping = "BlackShrinkWrapping", Labeling = "Labeling", HangGarment = "HangGarment", SetCreation = "SetCreation", Boxing = "Boxing", RemoveFromHanger = "RemoveFromHanger", Debundle = "Debundle", SuffocationStickering = "SuffocationStickering", CapSealing = "CapSealing", SetStickering = "SetStickering", BlankStickering = "BlankStickering", ShipsInProductPackaging = "ShipsInProductPackaging", NoPrep = "NoPrep" } /** * Indicates who will prepare the item. * @export * @enum {string} */ export declare enum PrepOwner { Amazon = "AMAZON", Seller = "SELLER" } /** * The request schema for a putTransportDetails operation. * @export * @interface PutTransportDetailsRequest */ export interface PutTransportDetailsRequest { /** * Indicates whether a putTransportDetails request is for an Amazon-partnered carrier. * @type {boolean} * @memberof PutTransportDetailsRequest */ IsPartnered: boolean; /** * * @type {ShipmentType} * @memberof PutTransportDetailsRequest */ ShipmentType: ShipmentType | 'SP' | 'LTL'; /**