/** * Selling Partner API for Merchant Fulfillment * With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services. * * 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'; /** * Maps the additional seller input to the definition. The key to the map is the field name. * @export * @interface AdditionalInputs */ export interface AdditionalInputs { /** * The field name. * @type {string} * @memberof AdditionalInputs */ AdditionalInputFieldName?: string; /** * * @type {SellerInputDefinition} * @memberof AdditionalInputs */ SellerInputDefinition?: SellerInputDefinition; } /** * Additional information required to purchase shipping. * @export * @interface AdditionalSellerInput */ export interface AdditionalSellerInput { /** * The data type of the additional information. * @type {string} * @memberof AdditionalSellerInput */ DataType?: string; /** * The value when the data type is string. * @type {string} * @memberof AdditionalSellerInput */ ValueAsString?: string; /** * The value when the data type is boolean. * @type {boolean} * @memberof AdditionalSellerInput */ ValueAsBoolean?: boolean; /** * The value when the data type is integer. * @type {number} * @memberof AdditionalSellerInput */ ValueAsInteger?: number; /** * Date-time formatted timestamp. * @type {string} * @memberof AdditionalSellerInput */ ValueAsTimestamp?: string; /** * * @type {Address} * @memberof AdditionalSellerInput */ ValueAsAddress?: Address; /** * * @type {Weight} * @memberof AdditionalSellerInput */ ValueAsWeight?: Weight; /** * * @type {Length} * @memberof AdditionalSellerInput */ ValueAsDimension?: Length; /** * * @type {CurrencyAmount} * @memberof AdditionalSellerInput */ ValueAsCurrency?: CurrencyAmount; } /** * An additional set of seller inputs required to purchase shipping. * @export * @interface AdditionalSellerInputs */ export interface AdditionalSellerInputs { /** * The name of the additional input field. * @type {string} * @memberof AdditionalSellerInputs */ AdditionalInputFieldName: string; /** * * @type {AdditionalSellerInput} * @memberof AdditionalSellerInputs */ AdditionalSellerInput: AdditionalSellerInput; } /** * The postal address information. * @export * @interface Address */ export interface Address { /** * The name of the addressee, or business name. * @type {string} * @memberof Address */ Name: string; /** * The street address information. * @type {string} * @memberof Address */ AddressLine1: string; /** * Additional street address information. * @type {string} * @memberof Address */ AddressLine2?: string; /** * Additional street address information. * @type {string} * @memberof Address */ AddressLine3?: string; /** * The district or county. * @type {string} * @memberof Address */ DistrictOrCounty?: string; /** * The email address. * @type {string} * @memberof Address */ Email: string; /** * The city. * @type {string} * @memberof Address */ City: string; /** * The state or province code. This is a required field in Canada, US, and UK marketplaces, and for shipments that originate in China. * @type {string} * @memberof Address */ StateOrProvinceCode?: string; /** * The zip code or postal code. * @type {string} * @memberof Address */ PostalCode: string; /** * The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format. * @type {string} * @memberof Address */ CountryCode: string; /** * The phone number. * @type {string} * @memberof Address */ Phone: string; } /** * Indicates whether the carrier will pick up the package, and what fee is charged, if any. * @export * @interface AvailableCarrierWillPickUpOption */ export interface AvailableCarrierWillPickUpOption { /** * * @type {CarrierWillPickUpOption} * @memberof AvailableCarrierWillPickUpOption */ CarrierWillPickUpOption: CarrierWillPickUpOption | 'CarrierWillPickUp' | 'ShipperWillDropOff' | 'NoPreference'; /** * * @type {CurrencyAmount} * @memberof AvailableCarrierWillPickUpOption */ Charge: CurrencyAmount; } /** * The available delivery confirmation options, and the fee charged, if any. * @export * @interface AvailableDeliveryExperienceOption */ export interface AvailableDeliveryExperienceOption { /** * * @type {DeliveryExperienceOption} * @memberof AvailableDeliveryExperienceOption */ DeliveryExperienceOption: DeliveryExperienceOption | 'DeliveryConfirmationWithAdultSignature' | 'DeliveryConfirmationWithSignature' | 'DeliveryConfirmationWithoutSignature' | 'NoTracking' | 'NoPreference'; /** * * @type {CurrencyAmount} * @memberof AvailableDeliveryExperienceOption */ Charge: CurrencyAmount; } /** * The available shipping service options. * @export * @interface AvailableShippingServiceOptions */ export interface AvailableShippingServiceOptions { /** * List of available carrier pickup options. * @type {Array} * @memberof AvailableShippingServiceOptions */ AvailableCarrierWillPickUpOptions: Array; /** * List of available delivery experience options. * @type {Array} * @memberof AvailableShippingServiceOptions */ AvailableDeliveryExperienceOptions: Array; } /** * Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, `CLAIMS_PROTECTED`) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC. * @export * @interface Benefits */ export interface Benefits { /** * A list of included benefits. * @type {Array} * @memberof Benefits */ IncludedBenefits?: Array; /** * A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation. * @type {Array} * @memberof Benefits */ ExcludedBenefits?: Array; } /** * Response schema. * @export * @interface CancelShipmentResponse */ export interface CancelShipmentResponse { /** * * @type {Shipment} * @memberof CancelShipmentResponse */ payload?: Shipment; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CancelShipmentResponse */ errors?: Array; } /** * Carrier will pick up option. * @export * @enum {string} */ export declare enum CarrierWillPickUpOption { CarrierWillPickUp = "CarrierWillPickUp", ShipperWillDropOff = "ShipperWillDropOff", NoPreference = "NoPreference" } /** * A validation constraint. * @export * @interface Constraint */ export interface Constraint { /** * A regular expression. * @type {string} * @memberof Constraint */ ValidationRegEx?: string; /** * A validation string. * @type {string} * @memberof Constraint */ ValidationString: string; } /** * Request schema. * @export * @interface CreateShipmentRequest */ export interface CreateShipmentRequest { /** * * @type {ShipmentRequestDetails} * @memberof CreateShipmentRequest */ ShipmentRequestDetails: ShipmentRequestDetails; /** * An Amazon-defined shipping service identifier. * @type {string} * @memberof CreateShipmentRequest */ ShippingServiceId: string; /** * Identifies a shipping service order made by a carrier. * @type {string} * @memberof CreateShipmentRequest */ ShippingServiceOfferId?: string; /** * * @type {HazmatType} * @memberof CreateShipmentRequest */ HazmatType?: HazmatType | 'None' | 'LQHazmat'; /** * * @type {LabelFormatOptionRequest} * @memberof CreateShipmentRequest */ LabelFormatOption?: LabelFormatOptionRequest; /** * A list of additional seller input pairs required to purchase shipping. * @type {Array} * @memberof CreateShipmentRequest */ ShipmentLevelSellerInputsList?: Array; } /** * Response schema. * @export * @interface CreateShipmentResponse */ export interface CreateShipmentResponse { /** * * @type {Shipment} * @memberof CreateShipmentResponse */ payload?: Shipment; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateShipmentResponse */ errors?: Array; } /** * Currency type and amount. * @export * @interface CurrencyAmount */ export interface CurrencyAmount { /** * Three-digit currency code in ISO 4217 format. * @type {string} * @memberof CurrencyAmount */ CurrencyCode: string; /** * The currency amount. * @type {number} * @memberof CurrencyAmount */ Amount: number; } /** * Details related to any dangerous goods or items that are shipped. * @export * @interface DangerousGoodsDetails */ export interface DangerousGoodsDetails { /** * The specific UNID of the item being shipped. * @type {string} * @memberof DangerousGoodsDetails */ UnitedNationsRegulatoryId?: string; /** * The specific regulatory class of the shipped item. * @type {string} * @memberof DangerousGoodsDetails */ TransportationRegulatoryClass?: string; /** * The specific packaging group of the item being shipped. * @type {string} * @memberof DangerousGoodsDetails */ PackingGroup?: DangerousGoodsDetailsPackingGroupEnum | 'I' | 'II' | 'III'; /** * The specific packing instruction of the item being shipped. * @type {string} * @memberof DangerousGoodsDetails */ PackingInstruction?: DangerousGoodsDetailsPackingInstructionEnum | 'PI965_SECTION_IA' | 'PI965_SECTION_IB' | 'PI965_SECTION_II' | 'PI966_SECTION_I' | 'PI966_SECTION_II' | 'PI967_SECTION_I' | 'PI967_SECTION_II' | 'PI968_SECTION_IA' | 'PI968_SECTION_IB' | 'PI969_SECTION_I' | 'PI969_SECTION_II' | 'PI970_SECTION_I' | 'PI970_SECTION_II'; } /** * @export * @enum {string} */ export declare enum DangerousGoodsDetailsPackingGroupEnum { I = "I", Ii = "II", Iii = "III" } /** * @export * @enum {string} */ export declare enum DangerousGoodsDetailsPackingInstructionEnum { Pi965SectionIa = "PI965_SECTION_IA", Pi965SectionIb = "PI965_SECTION_IB", Pi965SectionIi = "PI965_SECTION_II", Pi966SectionI = "PI966_SECTION_I", Pi966SectionIi = "PI966_SECTION_II", Pi967SectionI = "PI967_SECTION_I", Pi967SectionIi = "PI967_SECTION_II", Pi968SectionIa = "PI968_SECTION_IA", Pi968SectionIb = "PI968_SECTION_IB", Pi969SectionI = "PI969_SECTION_I", Pi969SectionIi = "PI969_SECTION_II", Pi970SectionI = "PI970_SECTION_I", Pi970SectionIi = "PI970_SECTION_II" } /** * The delivery confirmation level. * @export * @enum {string} */ export declare enum DeliveryExperienceOption { DeliveryConfirmationWithAdultSignature = "DeliveryConfirmationWithAdultSignature", DeliveryConfirmationWithSignature = "DeliveryConfirmationWithSignature", DeliveryConfirmationWithoutSignature = "DeliveryConfirmationWithoutSignature", NoTracking = "NoTracking", NoPreference = "NoPreference" } /** * The delivery confirmation level. * @export * @enum {string} */ export declare enum DeliveryExperienceType { DeliveryConfirmationWithAdultSignature = "DeliveryConfirmationWithAdultSignature", DeliveryConfirmationWithSignature = "DeliveryConfirmationWithSignature", DeliveryConfirmationWithoutSignature = "DeliveryConfirmationWithoutSignature", NoTracking = "NoTracking" } /** * An object representing an excluded benefit that is excluded for a shipping offer or rate. * @export * @interface ExcludedBenefit */ export interface ExcludedBenefit { /** * A benefit that is being excluded from a shipment. * @type {string} * @memberof ExcludedBenefit */ Benefit?: string; /** * List of reasons why a benefit is excluded for a shipping offer (for example, `LATE_DELIVERY_RISK`). * @type {Array} * @memberof ExcludedBenefit */ ReasonCodes?: Array; } /** * The document data and checksum. * @export * @interface FileContents */ export interface FileContents { /** * Data for printing labels encoded into a Base64, GZip-compressed string. * @type {string} * @memberof FileContents */ Contents: string; /** * * @type {FileType} * @memberof FileContents */ FileType: FileType | 'application/pdf' | 'application/zpl' | 'image/png'; /** * An MD5 hash to validate the PDF document data, in the form of a Base64 string. * @type {string} * @memberof FileContents */ Checksum: string; } /** * The file type for a label. * @export * @enum {string} */ export declare enum FileType { ApplicationPdf = "application/pdf", ApplicationZpl = "application/zpl", ImagePng = "image/png" } /** * Request schema. * @export * @interface GetAdditionalSellerInputsRequest */ export interface GetAdditionalSellerInputsRequest { /** * An Amazon-defined shipping service identifier. * @type {string} * @memberof GetAdditionalSellerInputsRequest */ ShippingServiceId: string; /** * * @type {Address} * @memberof GetAdditionalSellerInputsRequest */ ShipFromAddress: Address; /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} * @memberof GetAdditionalSellerInputsRequest */ OrderId: string; } /** * Response schema. * @export * @interface GetAdditionalSellerInputsResponse */ export interface GetAdditionalSellerInputsResponse { /** * * @type {GetAdditionalSellerInputsResult} * @memberof GetAdditionalSellerInputsResponse */ payload?: GetAdditionalSellerInputsResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetAdditionalSellerInputsResponse */ errors?: Array; } /** * The payload for the `getAdditionalSellerInputs` operation. * @export * @interface GetAdditionalSellerInputsResult */ export interface GetAdditionalSellerInputsResult { /** * A list of additional inputs. * @type {Array} * @memberof GetAdditionalSellerInputsResult */ ShipmentLevelFields?: Array; /** * A list of item level fields. * @type {Array} * @memberof GetAdditionalSellerInputsResult */ ItemLevelFieldsList?: Array; } /** * Request schema. * @export * @interface GetEligibleShipmentServicesRequest */ export interface GetEligibleShipmentServicesRequest { /** * * @type {ShipmentRequestDetails} * @memberof GetEligibleShipmentServicesRequest */ ShipmentRequestDetails: ShipmentRequestDetails; /** * * @type {ShippingOfferingFilter} * @memberof GetEligibleShipmentServicesRequest */ ShippingOfferingFilter?: ShippingOfferingFilter; } /** * Response schema. * @export * @interface GetEligibleShipmentServicesResponse */ export interface GetEligibleShipmentServicesResponse { /** * * @type {GetEligibleShipmentServicesResult} * @memberof GetEligibleShipmentServicesResponse */ payload?: GetEligibleShipmentServicesResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetEligibleShipmentServicesResponse */ errors?: Array; } /** * The payload for the `getEligibleShipmentServices` operation. * @export * @interface GetEligibleShipmentServicesResult */ export interface GetEligibleShipmentServicesResult { /** * A list of shipping services offers. * @type {Array} * @memberof GetEligibleShipmentServicesResult */ ShippingServiceList: Array; /** * List of services that are for some reason unavailable for this request * @type {Array} * @memberof GetEligibleShipmentServicesResult */ RejectedShippingServiceList?: Array; /** * A list of temporarily unavailable carriers. * @type {Array} * @memberof GetEligibleShipmentServicesResult */ TemporarilyUnavailableCarrierList?: Array; /** * List of carriers whose terms and conditions were not accepted by the seller. * @type {Array} * @memberof GetEligibleShipmentServicesResult */ TermsAndConditionsNotAcceptedCarrierList?: Array; } /** * Response schema. * @export * @interface GetShipmentResponse */ export interface GetShipmentResponse { /** * * @type {Shipment} * @memberof GetShipmentResponse */ payload?: Shipment; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetShipmentResponse */ errors?: Array; } /** * Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials. * @export * @enum {string} */ export declare enum HazmatType { None = "None", LqHazmat = "LQHazmat" } /** * Indicates whether the additional seller input is at the item or shipment level. * @export * @enum {string} */ export declare enum InputTargetType { ShipmentLevel = "SHIPMENT_LEVEL", ItemLevel = "ITEM_LEVEL" } /** * An Amazon order item identifier and a quantity. * @export * @interface Item */ export interface Item { /** * An Amazon-defined identifier for an individual item in an order. * @type {string} * @memberof Item */ OrderItemId: string; /** * The number of items. * @type {number} * @memberof Item */ Quantity: number; /** * * @type {Weight} * @memberof Item */ ItemWeight?: Weight; /** * The description of the item. * @type {string} * @memberof Item */ ItemDescription?: string; /** * A list of transparency codes. * @type {Array} * @memberof Item */ TransparencyCodeList?: Array; /** * A list of additional seller input pairs required to purchase shipping. * @type {Array} * @memberof Item */ ItemLevelSellerInputsList?: Array; /** * * @type {LiquidVolume} * @memberof Item */ LiquidVolume?: LiquidVolume; /** * When true, the item qualifies as hazardous materials (hazmat). Defaults to false. * @type {boolean} * @memberof Item */ IsHazmat?: boolean; /** * * @type {DangerousGoodsDetails} * @memberof Item */ DangerousGoodsDetails?: DangerousGoodsDetails; } /** * A list of item level fields. * @export * @interface ItemLevelFields */ export interface ItemLevelFields { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof ItemLevelFields */ Asin: string; /** * A list of additional inputs. * @type {Array} * @memberof ItemLevelFields */ AdditionalInputs: Array; } /** * Data for creating a shipping label and dimensions for printing the label. * @export * @interface Label */ export interface Label { /** * Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`. * @type {string} * @memberof Label */ CustomTextForLabel?: string; /** * * @type {LabelDimensions} * @memberof Label */ Dimensions: LabelDimensions; /** * * @type {FileContents} * @memberof Label */ FileContents: FileContents; /** * * @type {LabelFormat} * @memberof Label */ LabelFormat?: LabelFormat | 'PDF' | 'PNG' | 'ZPL203' | 'ZPL300' | 'ShippingServiceDefault'; /** * * @type {StandardIdForLabel} * @memberof Label */ StandardIdForLabel?: StandardIdForLabel | 'AmazonOrderId'; } /** * Custom text for shipping labels. * @export * @interface LabelCustomization */ export interface LabelCustomization { /** * Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`. * @type {string} * @memberof LabelCustomization */ CustomTextForLabel?: string; /** * * @type {StandardIdForLabel} * @memberof LabelCustomization */ StandardIdForLabel?: StandardIdForLabel | 'AmazonOrderId'; } /** * Dimensions for printing a shipping label. * @export * @interface LabelDimensions */ export interface LabelDimensions { /** * A label dimension. * @type {number} * @memberof LabelDimensions */ Length: number; /** * A label dimension. * @type {number} * @memberof LabelDimensions */ Width: number; /** * * @type {UnitOfLength} * @memberof LabelDimensions */ Unit: UnitOfLength | 'inches' | 'centimeters'; } /** * The label format. * @export * @enum {string} */ export declare enum LabelFormat { Pdf = "PDF", Png = "PNG", Zpl203 = "ZPL203", Zpl300 = "ZPL300", ShippingServiceDefault = "ShippingServiceDefault" } /** * The label format details and whether to include a packing slip. * @export * @interface LabelFormatOption */ export interface LabelFormatOption { /** * When true, include a packing slip with the label. * @type {boolean} * @memberof LabelFormatOption */ IncludePackingSlipWithLabel?: boolean; /** * * @type {LabelFormat} * @memberof LabelFormatOption */ LabelFormat?: LabelFormat | 'PDF' | 'PNG' | 'ZPL203' | 'ZPL300' | 'ShippingServiceDefault'; } /** * Whether to include a packing slip. * @export * @interface LabelFormatOptionRequest */ export interface LabelFormatOptionRequest { /** * When true, include a packing slip with the label. * @type {boolean} * @memberof LabelFormatOptionRequest */ IncludePackingSlipWithLabel?: boolean; } /** * The length. * @export * @interface Length */ export interface Length { /** * The value in units. * @type {number} * @memberof Length */ value?: number; /** * * @type {UnitOfLength} * @memberof Length */ unit?: UnitOfLength | 'inches' | 'centimeters'; } /** * Liquid volume. * @export * @interface LiquidVolume */ export interface LiquidVolume { /** * The unit of measurement. * @type {string} * @memberof LiquidVolume */ Unit: LiquidVolumeUnitEnum | 'ML' | 'L' | 'FL_OZ' | 'GAL' | 'PT' | 'QT' | 'C'; /** * The measurement value. * @type {number} * @memberof LiquidVolume */ Value: number; } /** * @export * @enum {string} */ export declare enum LiquidVolumeUnitEnum { Ml = "ML", L = "L", FlOz = "FL_OZ", Gal = "GAL", Pt = "PT", Qt = "QT", C = "C" } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition in a human-readable form. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The dimensions of a package contained in a shipment. * @export * @interface PackageDimensions */ export interface PackageDimensions { /** * A number that represents the given package dimension. * @type {number} * @memberof PackageDimensions */ Length?: number; /** * A number that represents the given package dimension. * @type {number} * @memberof PackageDimensions */ Width?: number; /** * A number that represents the given package dimension. * @type {number} * @memberof PackageDimensions */ Height?: number; /** * * @type {UnitOfLength} * @memberof PackageDimensions */ Unit?: UnitOfLength | 'inches' | 'centimeters'; /** * * @type {PredefinedPackageDimensions} * @memberof PackageDimensions */ PredefinedPackageDimensions?: PredefinedPackageDimensions | 'FedEx_Box_10kg' | 'FedEx_Box_25kg' | 'FedEx_Box_Extra_Large_1' | 'FedEx_Box_Extra_Large_2' | 'FedEx_Box_Large_1' | 'FedEx_Box_Large_2' | 'FedEx_Box_Medium_1' | 'FedEx_Box_Medium_2' | 'FedEx_Box_Small_1' | 'FedEx_Box_Small_2' | 'FedEx_Envelope' | 'FedEx_Padded_Pak' | 'FedEx_Pak_1' | 'FedEx_Pak_2' | 'FedEx_Tube' | 'FedEx_XL_Pak' | 'UPS_Box_10kg' | 'UPS_Box_25kg' | 'UPS_Express_Box' | 'UPS_Express_Box_Large' | 'UPS_Express_Box_Medium' | 'UPS_Express_Box_Small' | 'UPS_Express_Envelope' | 'UPS_Express_Hard_Pak' | 'UPS_Express_Legal_Envelope' | 'UPS_Express_Pak' | 'UPS_Express_Tube' | 'UPS_Laboratory_Pak' | 'UPS_Pad_Pak' | 'UPS_Pallet' | 'USPS_Card' | 'USPS_Flat' | 'USPS_FlatRateCardboardEnvelope' | 'USPS_FlatRateEnvelope' | 'USPS_FlatRateGiftCardEnvelope' | 'USPS_FlatRateLegalEnvelope' | 'USPS_FlatRatePaddedEnvelope' | 'USPS_FlatRateWindowEnvelope' | 'USPS_LargeFlatRateBoardGameBox' | 'USPS_LargeFlatRateBox' | 'USPS_Letter' | 'USPS_MediumFlatRateBox1' | 'USPS_MediumFlatRateBox2' | 'USPS_RegionalRateBoxA1' | 'USPS_RegionalRateBoxA2' | 'USPS_RegionalRateBoxB1' | 'USPS_RegionalRateBoxB2' | 'USPS_RegionalRateBoxC' | 'USPS_SmallFlatRateBox' | 'USPS_SmallFlatRateEnvelope'; } /** * An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box. * @export * @enum {string} */ export declare enum PredefinedPackageDimensions { FedExBox10kg = "FedEx_Box_10kg", FedExBox25kg = "FedEx_Box_25kg", FedExBoxExtraLarge1 = "FedEx_Box_Extra_Large_1", FedExBoxExtraLarge2 = "FedEx_Box_Extra_Large_2", FedExBoxLarge1 = "FedEx_Box_Large_1", FedExBoxLarge2 = "FedEx_Box_Large_2", FedExBoxMedium1 = "FedEx_Box_Medium_1", FedExBoxMedium2 = "FedEx_Box_Medium_2", FedExBoxSmall1 = "FedEx_Box_Small_1", FedExBoxSmall2 = "FedEx_Box_Small_2", FedExEnvelope = "FedEx_Envelope", FedExPaddedPak = "FedEx_Padded_Pak", FedExPak1 = "FedEx_Pak_1", FedExPak2 = "FedEx_Pak_2", FedExTube = "FedEx_Tube", FedExXlPak = "FedEx_XL_Pak", UpsBox10kg = "UPS_Box_10kg", UpsBox25kg = "UPS_Box_25kg", UpsExpressBox = "UPS_Express_Box", UpsExpressBoxLarge = "UPS_Express_Box_Large", UpsExpressBoxMedium = "UPS_Express_Box_Medium", UpsExpressBoxSmall = "UPS_Express_Box_Small", UpsExpressEnvelope = "UPS_Express_Envelope", UpsExpressHardPak = "UPS_Express_Hard_Pak", UpsExpressLegalEnvelope = "UPS_Express_Legal_Envelope", UpsExpressPak = "UPS_Express_Pak", UpsExpressTube = "UPS_Express_Tube", UpsLaboratoryPak = "UPS_Laboratory_Pak", UpsPadPak = "UPS_Pad_Pak", UpsPallet = "UPS_Pallet", UspsCard = "USPS_Card", UspsFlat = "USPS_Flat", UspsFlatRateCardboardEnvelope = "USPS_FlatRateCardboardEnvelope", UspsFlatRateEnvelope = "USPS_FlatRateEnvelope", UspsFlatRateGiftCardEnvelope = "USPS_FlatRateGiftCardEnvelope", UspsFlatRateLegalEnvelope = "USPS_FlatRateLegalEnvelope", UspsFlatRatePaddedEnvelope = "USPS_FlatRatePaddedEnvelope", UspsFlatRateWindowEnvelope = "USPS_FlatRateWindowEnvelope", UspsLargeFlatRateBoardGameBox = "USPS_LargeFlatRateBoardGameBox", UspsLargeFlatRateBox = "USPS_LargeFlatRateBox", UspsLetter = "USPS_Letter", UspsMediumFlatRateBox1 = "USPS_MediumFlatRateBox1", UspsMediumFlatRateBox2 = "USPS_MediumFlatRateBox2", UspsRegionalRateBoxA1 = "USPS_RegionalRateBoxA1", UspsRegionalRateBoxA2 = "USPS_RegionalRateBoxA2", UspsRegionalRateBoxB1 = "USPS_RegionalRateBoxB1", UspsRegionalRateBoxB2 = "USPS_RegionalRateBoxB2", UspsRegionalRateBoxC = "USPS_RegionalRateBoxC", UspsSmallFlatRateBox = "USPS_SmallFlatRateBox", UspsSmallFlatRateEnvelope = "USPS_SmallFlatRateEnvelope" } /** * Information about a rejected shipping service * @export * @interface RejectedShippingService */ export interface RejectedShippingService { /** * The rejected shipping carrier name. For example, USPS. * @type {string} * @memberof RejectedShippingService */ CarrierName: string; /** * The rejected shipping service localized name. For example, FedEx Standard Overnight. * @type {string} * @memberof RejectedShippingService */ ShippingServiceName: string; /** * An Amazon-defined shipping service identifier. * @type {string} * @memberof RejectedShippingService */ ShippingServiceId: string; /** * A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`. * @type {string} * @memberof RejectedShippingService */ RejectionReasonCode: string; /** * A localized human readable description of the rejected reason. * @type {string} * @memberof RejectedShippingService */ RejectionReasonMessage?: string; } /** * Specifies characteristics that apply to a seller input. * @export * @interface SellerInputDefinition */ export interface SellerInputDefinition { /** * When true, the additional input field is required. * @type {boolean} * @memberof SellerInputDefinition */ IsRequired: boolean; /** * The data type of the additional input field. * @type {string} * @memberof SellerInputDefinition */ DataType: string; /** * List of constraints. * @type {Array} * @memberof SellerInputDefinition */ Constraints: Array; /** * The display text for the additional input field. * @type {string} * @memberof SellerInputDefinition */ InputDisplayText: string; /** * * @type {InputTargetType} * @memberof SellerInputDefinition */ InputTarget?: InputTargetType | 'SHIPMENT_LEVEL' | 'ITEM_LEVEL'; /** * * @type {AdditionalSellerInput} * @memberof SellerInputDefinition */ StoredValue: AdditionalSellerInput; /** * The set of fixed values in an additional seller input. * @type {Array} * @memberof SellerInputDefinition */ RestrictedSetValues?: Array; } /** * The details of a shipment. Includes the shipment status. * @export * @interface Shipment */ export interface Shipment { /** * An Amazon-defined shipment identifier. * @type {string} * @memberof Shipment */ ShipmentId: string; /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} * @memberof Shipment */ AmazonOrderId: string; /** * A seller-defined order identifier. * @type {string} * @memberof Shipment */ SellerOrderId?: string; /** * The list of items you want to include in a shipment. * @type {Array} * @memberof Shipment */ ItemList: Array; /** * * @type {Address} * @memberof Shipment */ ShipFromAddress: Address; /** * * @type {Address} * @memberof Shipment */ ShipToAddress: Address; /** * * @type {PackageDimensions} * @memberof Shipment */ PackageDimensions: PackageDimensions; /** * * @type {Weight} * @memberof Shipment */ Weight: Weight; /** * * @type {CurrencyAmount} * @memberof Shipment */ Insurance: CurrencyAmount; /** * * @type {ShippingService} * @memberof Shipment */ ShippingService: ShippingService; /** * * @type {Label} * @memberof Shipment */ Label: Label; /** * * @type {ShipmentStatus} * @memberof Shipment */ Status: ShipmentStatus | 'Purchased' | 'RefundPending' | 'RefundRejected' | 'RefundApplied'; /** * The shipment tracking identifier provided by the carrier. * @type {string} * @memberof Shipment */ TrackingId?: string; /** * Date-time formatted timestamp. * @type {string} * @memberof Shipment */ CreatedDate: string; /** * Date-time formatted timestamp. * @type {string} * @memberof Shipment */ LastUpdatedDate?: string; } /** * Shipment information required for requesting shipping service offers or for creating a shipment. * @export * @interface ShipmentRequestDetails */ export interface ShipmentRequestDetails { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} * @memberof ShipmentRequestDetails */ AmazonOrderId: string; /** * A seller-defined order identifier. * @type {string} * @memberof ShipmentRequestDetails */ SellerOrderId?: string; /** * The list of items you want to include in a shipment. * @type {Array} * @memberof ShipmentRequestDetails */ ItemList: Array; /** * * @type {Address} * @memberof ShipmentRequestDetails */ ShipFromAddress: Address; /** * * @type {PackageDimensions} * @memberof ShipmentRequestDetails */ PackageDimensions: PackageDimensions; /** * * @type {Weight} * @memberof ShipmentRequestDetails */ Weight: Weight; /** * Date-time formatted timestamp. * @type {string} * @memberof ShipmentRequestDetails */ MustArriveByDate?: string; /** * Date-time formatted timestamp. * @type {string} * @memberof ShipmentRequestDetails */ ShipDate?: string; /** * * @type {ShippingServiceOptions} * @memberof ShipmentRequestDetails */ ShippingServiceOptions: ShippingServiceOptions; /** * * @type {LabelCustomization} * @memberof ShipmentRequestDetails */ LabelCustomization?: LabelCustomization; } /** * The shipment status. * @export * @enum {string} */ export declare enum ShipmentStatus { Purchased = "Purchased", RefundPending = "RefundPending", RefundRejected = "RefundRejected", RefundApplied = "RefundApplied" } /** * Filter for use when requesting eligible shipping services. * @export * @interface ShippingOfferingFilter */ export interface ShippingOfferingFilter { /** * When true, include a packing slip with the label. * @type {boolean} * @memberof ShippingOfferingFilter */ IncludePackingSlipWithLabel?: boolean; /** * When true, include complex shipping options. * @type {boolean} * @memberof ShippingOfferingFilter */ IncludeComplexShippingOptions?: boolean; /** * * @type {CarrierWillPickUpOption} * @memberof ShippingOfferingFilter */ CarrierWillPickUp?: CarrierWillPickUpOption | 'CarrierWillPickUp' | 'ShipperWillDropOff' | 'NoPreference'; /** * * @type {DeliveryExperienceOption} * @memberof ShippingOfferingFilter */ DeliveryExperience?: DeliveryExperienceOption | 'DeliveryConfirmationWithAdultSignature' | 'DeliveryConfirmationWithSignature' | 'DeliveryConfirmationWithoutSignature' | 'NoTracking' | 'NoPreference'; } /** * A shipping service offer made by a carrier. * @export * @interface ShippingService */ export interface ShippingService { /** * A plain text representation of a carrier\'s shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\". * @type {string} * @memberof ShippingService */ ShippingServiceName: string; /** * The name of the carrier. * @type {string} * @memberof ShippingService */ CarrierName: string; /** * An Amazon-defined shipping service identifier. * @type {string} * @memberof ShippingService */ ShippingServiceId: string; /** * An Amazon-defined shipping service offer identifier. * @type {string} * @memberof ShippingService */ ShippingServiceOfferId: string; /** * Date-time formatted timestamp. * @type {string} * @memberof ShippingService */ ShipDate: string; /** * Date-time formatted timestamp. * @type {string} * @memberof ShippingService */ EarliestEstimatedDeliveryDate?: string; /** * Date-time formatted timestamp. * @type {string} * @memberof ShippingService */ LatestEstimatedDeliveryDate?: string; /** * * @type {CurrencyAmount} * @memberof ShippingService */ Rate: CurrencyAmount; /** * * @type {ShippingServiceOptions} * @memberof ShippingService */ ShippingServiceOptions: ShippingServiceOptions; /** * * @type {AvailableShippingServiceOptions} * @memberof ShippingService */ AvailableShippingServiceOptions?: AvailableShippingServiceOptions; /** * List of label formats. * @type {Array} * @memberof ShippingService */ AvailableLabelFormats?: Array<(LabelFormat | 'PDF' | 'PNG' | 'ZPL203' | 'ZPL300' | 'ShippingServiceDefault')>; /** * The available label formats. * @type {Array} * @memberof ShippingService */ AvailableFormatOptionsForLabel?: Array; /** * When true, additional seller inputs are required. * @type {boolean} * @memberof ShippingService */ RequiresAdditionalSellerInputs: boolean; /** * * @type {Benefits} * @memberof ShippingService */ Benefits?: Benefits; } /** * Extra services provided by a carrier. * @export * @interface ShippingServiceOptions */ export interface ShippingServiceOptions { /** * * @type {DeliveryExperienceType} * @memberof ShippingServiceOptions */ DeliveryExperience: DeliveryExperienceType | 'DeliveryConfirmationWithAdultSignature' | 'DeliveryConfirmationWithSignature' | 'DeliveryConfirmationWithoutSignature' | 'NoTracking'; /** * * @type {CurrencyAmount} * @memberof ShippingServiceOptions */ DeclaredValue?: CurrencyAmount; /** * When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK). * @type {boolean} * @memberof ShippingServiceOptions */ CarrierWillPickUp: boolean; /** * * @type {CarrierWillPickUpOption} * @memberof ShippingServiceOptions */ CarrierWillPickUpOption?: CarrierWillPickUpOption | 'CarrierWillPickUp' | 'ShipperWillDropOff' | 'NoPreference'; /** * * @type {LabelFormat} * @memberof ShippingServiceOptions */ LabelFormat?: LabelFormat | 'PDF' | 'PNG' | 'ZPL203' | 'ZPL300' | 'ShippingServiceDefault'; } /** * The type of standard identifier to print on the label. * @export * @enum {string} */ export declare enum StandardIdForLabel { AmazonOrderId = "AmazonOrderId" } /** * A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier. * @export * @interface TemporarilyUnavailableCarrier */ export interface TemporarilyUnavailableCarrier { /** * The name of the carrier. * @type {string} * @memberof TemporarilyUnavailableCarrier */ CarrierName: string; } /** * A carrier whose terms and conditions have not been accepted by the seller. * @export * @interface TermsAndConditionsNotAcceptedCarrier */ export interface TermsAndConditionsNotAcceptedCarrier { /** * The name of the carrier. * @type {string} * @memberof TermsAndConditionsNotAcceptedCarrier */ CarrierName: string; } /** * The unit of length. * @export * @enum {string} */ export declare enum UnitOfLength { Inches = "inches", Centimeters = "centimeters" } /** * The unit of weight. * @export * @enum {string} */ export declare enum UnitOfWeight { Oz = "oz", G = "g" } /** * The weight. * @export * @interface Weight */ export interface Weight { /** * The weight value. * @type {number} * @memberof Weight */ Value: number; /** * * @type {UnitOfWeight} * @memberof Weight */ Unit: UnitOfWeight | 'oz' | 'g'; } /** * MerchantFulfillmentApi - axios parameter creator * @export */ export declare const MerchantFulfillmentApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelShipment: (shipmentId: string, options?: any) => Promise; /** * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateShipmentRequest} body The request schema for the `CreateShipment` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createShipment: (body: CreateShipmentRequest, options?: any) => Promise; /** * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetAdditionalSellerInputsRequest} body The request schema for the `GetAdditionalSellerInputs` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAdditionalSellerInputs: (body: GetAdditionalSellerInputsRequest, options?: any) => Promise; /** * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetEligibleShipmentServicesRequest} body The request schema for the `GetEligibleShipmentServices` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEligibleShipmentServices: (body: GetEligibleShipmentServicesRequest, options?: any) => Promise; /** * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipment: (shipmentId: string, options?: any) => Promise; }; /** * MerchantFulfillmentApi - functional programming interface * @export */ export declare const MerchantFulfillmentApiFp: (configuration?: Configuration) => { /** * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelShipment(shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateShipmentRequest} body The request schema for the `CreateShipment` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createShipment(body: CreateShipmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetAdditionalSellerInputsRequest} body The request schema for the `GetAdditionalSellerInputs` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAdditionalSellerInputs(body: GetAdditionalSellerInputsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetEligibleShipmentServicesRequest} body The request schema for the `GetEligibleShipmentServices` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEligibleShipmentServices(body: GetEligibleShipmentServicesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipment(shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MerchantFulfillmentApi - factory interface * @export */ export declare const MerchantFulfillmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelShipment(shipmentId: string, options?: any): AxiosPromise; /** * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateShipmentRequest} body The request schema for the `CreateShipment` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createShipment(body: CreateShipmentRequest, options?: any): AxiosPromise; /** * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetAdditionalSellerInputsRequest} body The request schema for the `GetAdditionalSellerInputs` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAdditionalSellerInputs(body: GetAdditionalSellerInputsRequest, options?: any): AxiosPromise; /** * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetEligibleShipmentServicesRequest} body The request schema for the `GetEligibleShipmentServices` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEligibleShipmentServices(body: GetEligibleShipmentServicesRequest, options?: any): AxiosPromise; /** * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipment(shipmentId: string, options?: any): AxiosPromise; }; /** * Request parameters for cancelShipment operation in MerchantFulfillmentApi. * @export * @interface MerchantFulfillmentApiCancelShipmentRequest */ export interface MerchantFulfillmentApiCancelShipmentRequest { /** * The Amazon-defined shipment identifier for the shipment to cancel. * @type {string} * @memberof MerchantFulfillmentApiCancelShipment */ readonly shipmentId: string; } /** * Request parameters for createShipment operation in MerchantFulfillmentApi. * @export * @interface MerchantFulfillmentApiCreateShipmentRequest */ export interface MerchantFulfillmentApiCreateShipmentRequest { /** * The request schema for the `CreateShipment` operation. * @type {CreateShipmentRequest} * @memberof MerchantFulfillmentApiCreateShipment */ readonly body: CreateShipmentRequest; } /** * Request parameters for getAdditionalSellerInputs operation in MerchantFulfillmentApi. * @export * @interface MerchantFulfillmentApiGetAdditionalSellerInputsRequest */ export interface MerchantFulfillmentApiGetAdditionalSellerInputsRequest { /** * The request schema for the `GetAdditionalSellerInputs` operation. * @type {GetAdditionalSellerInputsRequest} * @memberof MerchantFulfillmentApiGetAdditionalSellerInputs */ readonly body: GetAdditionalSellerInputsRequest; } /** * Request parameters for getEligibleShipmentServices operation in MerchantFulfillmentApi. * @export * @interface MerchantFulfillmentApiGetEligibleShipmentServicesRequest */ export interface MerchantFulfillmentApiGetEligibleShipmentServicesRequest { /** * The request schema for the `GetEligibleShipmentServices` operation. * @type {GetEligibleShipmentServicesRequest} * @memberof MerchantFulfillmentApiGetEligibleShipmentServices */ readonly body: GetEligibleShipmentServicesRequest; } /** * Request parameters for getShipment operation in MerchantFulfillmentApi. * @export * @interface MerchantFulfillmentApiGetShipmentRequest */ export interface MerchantFulfillmentApiGetShipmentRequest { /** * The Amazon-defined shipment identifier for the shipment. * @type {string} * @memberof MerchantFulfillmentApiGetShipment */ readonly shipmentId: string; } /** * MerchantFulfillmentApi - object-oriented interface * @export * @class MerchantFulfillmentApi * @extends {BaseAPI} */ export declare class MerchantFulfillmentApi extends BaseAPI { /** * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MerchantFulfillmentApiCancelShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MerchantFulfillmentApi */ cancelShipment(requestParameters: MerchantFulfillmentApiCancelShipmentRequest, options?: any): Promise>; /** * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MerchantFulfillmentApiCreateShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MerchantFulfillmentApi */ createShipment(requestParameters: MerchantFulfillmentApiCreateShipmentRequest, options?: any): Promise>; /** * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MerchantFulfillmentApiGetAdditionalSellerInputsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MerchantFulfillmentApi */ getAdditionalSellerInputs(requestParameters: MerchantFulfillmentApiGetAdditionalSellerInputsRequest, options?: any): Promise>; /** * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MerchantFulfillmentApiGetEligibleShipmentServicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MerchantFulfillmentApi */ getEligibleShipmentServices(requestParameters: MerchantFulfillmentApiGetEligibleShipmentServicesRequest, options?: any): Promise>; /** * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MerchantFulfillmentApiGetShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MerchantFulfillmentApi */ getShipment(requestParameters: MerchantFulfillmentApiGetShipmentRequest, options?: any): Promise>; }