/** * Selling Partner API for Retail Procurement Shipments * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * Address of the party. * @export * @interface Address */ export interface Address { /** * The name of the person, business or institution at that address. * @type {string} * @memberof Address */ name: string; /** * First line of the address. * @type {string} * @memberof Address */ addressLine1: string; /** * Additional street address information, if required. * @type {string} * @memberof Address */ addressLine2?: string; /** * Additional street address information, if required. * @type {string} * @memberof Address */ addressLine3?: string; /** * The city where the person, business or institution is located. * @type {string} * @memberof Address */ city?: string; /** * The county where person, business or institution is located. * @type {string} * @memberof Address */ county?: string; /** * The district where person, business or institution is located. * @type {string} * @memberof Address */ district?: string; /** * The state or region where person, business or institution is located. * @type {string} * @memberof Address */ stateOrRegion?: string; /** * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. * @type {string} * @memberof Address */ postalCode?: string; /** * The two digit country code in ISO 3166-1 alpha-2 format. * @type {string} * @memberof Address */ countryCode: string; /** * The phone number of the person, business or institution located at that address. * @type {string} * @memberof Address */ phone?: string; } /** * Indicates the carrier details and their contact informations * @export * @interface CarrierDetails */ export interface CarrierDetails { /** * The field is used to represent the carrier used for performing the shipment. * @type {string} * @memberof CarrierDetails */ name?: string; /** * Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association). * @type {string} * @memberof CarrierDetails */ code?: string; /** * The field is used to represent the Carrier contact number. * @type {string} * @memberof CarrierDetails */ phone?: string; /** * The field is used to represent the carrier Email id. * @type {string} * @memberof CarrierDetails */ email?: string; /** * The field is also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for US, CA, MX shipment confirmations. * @type {string} * @memberof CarrierDetails */ shipmentReferenceNumber?: string; } /** * Details of the carton/package being shipped. * @export * @interface Carton */ export interface Carton { /** * A list of carton identifiers. * @type {Array} * @memberof Carton */ cartonIdentifiers?: Array; /** * Carton sequence number for the carton. The first carton will be 001, the second 002, and so on. This number is used as a reference to refer to this carton from the pallet level. * @type {string} * @memberof Carton */ cartonSequenceNumber: string; /** * * @type {Dimensions} * @memberof Carton */ dimensions?: Dimensions; /** * * @type {Weight} * @memberof Carton */ weight?: Weight; /** * This is required to be provided for every carton in the small parcel shipments. * @type {string} * @memberof Carton */ trackingNumber?: string; /** * A list of container item details. * @type {Array} * @memberof Carton */ items: Array; } /** * Carton reference details. * @export * @interface CartonReferenceDetails */ export interface CartonReferenceDetails { /** * Pallet level carton count is mandatory for single item pallet and optional for mixed item pallet. * @type {number} * @memberof CartonReferenceDetails */ cartonCount?: number; /** * Array of reference numbers for the carton that are part of this pallet/shipment. Please provide the cartonSequenceNumber from the \'cartons\' segment to refer to that carton\'s details here. * @type {Array} * @memberof CartonReferenceDetails */ cartonReferenceNumbers: Array; } /** * Transport Request pickup date from Vendor Warehouse by Buyer * @export * @interface CollectFreightPickupDetails */ export interface CollectFreightPickupDetails { /** * Date on which the items can be picked up from vendor warehouse by Buyer used for WePay/Collect vendors. * @type {string} * @memberof CollectFreightPickupDetails */ requestedPickUp?: string; /** * Date on which the items are scheduled to be picked from vendor warehouse by Buyer used for WePay/Collect vendors. * @type {string} * @memberof CollectFreightPickupDetails */ scheduledPickUp?: string; /** * Date on which the carrier is being scheduled to pickup items from vendor warehouse by Byer used for WePay/Collect vendors. * @type {string} * @memberof CollectFreightPickupDetails */ carrierAssignmentDate?: string; } /** * A list of carton identifiers. * @export * @interface ContainerIdentification */ export interface ContainerIdentification { /** * The container identification type. * @type {string} * @memberof ContainerIdentification */ containerIdentificationType: ContainerIdentificationContainerIdentificationTypeEnum | 'SSCC' | 'AMZNCC' | 'GTIN' | 'BPS' | 'CID'; /** * Container identification number that adheres to the definition of the container identification type. * @type {string} * @memberof ContainerIdentification */ containerIdentificationNumber: string; } /** * @export * @enum {string} */ export declare enum ContainerIdentificationContainerIdentificationTypeEnum { Sscc = "SSCC", Amzncc = "AMZNCC", Gtin = "GTIN", Bps = "BPS", Cid = "CID" } /** * Carton/Pallet level details for the item. * @export * @interface ContainerItem */ export interface ContainerItem { /** * The reference number for the item. Please provide the itemSequenceNumber from the \'items\' segment to refer to that item\'s details here. * @type {string} * @memberof ContainerItem */ itemReference: string; /** * * @type {ItemQuantity} * @memberof ContainerItem */ shippedQuantity: ItemQuantity; /** * * @type {ItemDetails} * @memberof ContainerItem */ itemDetails?: ItemDetails; } /** * Container sequence numbers that are involved in this shipment. * @export * @interface ContainerSequenceNumbers */ export interface ContainerSequenceNumbers { /** * A list of containers shipped * @type {string} * @memberof ContainerSequenceNumbers */ containerSequenceNumber?: string; } /** * A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level. * @export * @interface Containers */ export interface Containers { /** * The type of container. * @type {string} * @memberof Containers */ containerType: ContainersContainerTypeEnum | 'carton' | 'pallet'; /** * An integer that must be submitted for multi-box shipments only, where one item may come in separate packages. * @type {string} * @memberof Containers */ containerSequenceNumber?: string; /** * A list of carton identifiers. * @type {Array} * @memberof Containers */ containerIdentifiers: Array; /** * The tracking number used for identifying the shipment. * @type {string} * @memberof Containers */ trackingNumber?: string; /** * * @type {Dimensions} * @memberof Containers */ dimensions?: Dimensions; /** * * @type {Weight} * @memberof Containers */ weight?: Weight; /** * Number of layers per pallet. * @type {number} * @memberof Containers */ tier?: number; /** * Number of cartons per layer on the pallet. * @type {number} * @memberof Containers */ block?: number; /** * * @type {InnerContainersDetails} * @memberof Containers */ innerContainersDetails?: InnerContainersDetails; /** * A list of packed items. * @type {Array} * @memberof Containers */ packedItems?: Array; } /** * @export * @enum {string} */ export declare enum ContainersContainerTypeEnum { Carton = "carton", Pallet = "pallet" } /** * Physical dimensional measurements of a container. * @export * @interface Dimensions */ export interface Dimensions { /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Dimensions */ length: string; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Dimensions */ width: string; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Dimensions */ height: string; /** * The unit of measure for dimensions. * @type {string} * @memberof Dimensions */ unitOfMeasure: DimensionsUnitOfMeasureEnum | 'In' | 'Ft' | 'Meter' | 'Yard'; } /** * @export * @enum {string} */ export declare enum DimensionsUnitOfMeasureEnum { In = "In", Ft = "Ft", Meter = "Meter", Yard = "Yard" } /** * Duration after manufacturing date during which the product is valid for consumption. * @export * @interface Duration */ export interface Duration { /** * Unit for duration. * @type {string} * @memberof Duration */ durationUnit: DurationDurationUnitEnum | 'Days' | 'Months'; /** * Value for the duration in terms of the durationUnit. * @type {number} * @memberof Duration */ durationValue: number; } /** * @export * @enum {string} */ export declare enum DurationDurationUnitEnum { Days = "Days", Months = "Months" } /** * Expiry refers to the collection of dates required for certain items. These could be either expiryDate or mfgDate and expiryAfterDuration. These are mandatory for perishable items. * @export * @interface Expiry */ export interface Expiry { /** * Production, packaging or assembly date determined by the manufacturer. Its meaning is determined based on the trade item context. * @type {string} * @memberof Expiry */ manufacturerDate?: string; /** * The date that determines the limit of consumption or use of a product. Its meaning is determined based on the trade item context. * @type {string} * @memberof Expiry */ expiryDate?: string; /** * * @type {Duration} * @memberof Expiry */ expiryAfterDuration?: Duration; } /** * The response schema for the GetShipmentDetails operation. * @export * @interface GetShipmentDetailsResponse */ export interface GetShipmentDetailsResponse { /** * * @type {ShipmentDetails} * @memberof GetShipmentDetailsResponse */ payload?: ShipmentDetails; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetShipmentDetailsResponse */ errors?: Array; } /** * The response schema for the GetShipmentLabels operation. * @export * @interface GetShipmentLabels */ export interface GetShipmentLabels { /** * * @type {TransportationLabels} * @memberof GetShipmentLabels */ payload?: TransportationLabels; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetShipmentLabels */ errors?: Array; } /** * Provide these fields only if this shipment is a direct import. * @export * @interface ImportDetails */ export interface ImportDetails { /** * This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment. * @type {string} * @memberof ImportDetails */ methodOfPayment?: ImportDetailsMethodOfPaymentEnum | 'PaidByBuyer' | 'CollectOnDelivery' | 'DefinedByBuyerAndSeller' | 'FOBPortOfCall' | 'PrepaidBySeller' | 'PaidBySeller'; /** * The container\'s seal number. * @type {string} * @memberof ImportDetails */ sealNumber?: string; /** * * @type {Route} * @memberof ImportDetails */ route?: Route; /** * Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers. * @type {string} * @memberof ImportDetails */ importContainers?: string; /** * * @type {Weight} * @memberof ImportDetails */ billableWeight?: Weight; /** * Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future. * @type {string} * @memberof ImportDetails */ estimatedShipByDate?: string; /** * Identification of the instructions on how specified item/carton/pallet should be handled. * @type {string} * @memberof ImportDetails */ handlingInstructions?: ImportDetailsHandlingInstructionsEnum | 'Oversized' | 'Fragile' | 'Food' | 'HandleWithCare'; } /** * @export * @enum {string} */ export declare enum ImportDetailsMethodOfPaymentEnum { PaidByBuyer = "PaidByBuyer", CollectOnDelivery = "CollectOnDelivery", DefinedByBuyerAndSeller = "DefinedByBuyerAndSeller", FobPortOfCall = "FOBPortOfCall", PrepaidBySeller = "PrepaidBySeller", PaidBySeller = "PaidBySeller" } /** * @export * @enum {string} */ export declare enum ImportDetailsHandlingInstructionsEnum { Oversized = "Oversized", Fragile = "Fragile", Food = "Food", HandleWithCare = "HandleWithCare" } /** * Details of the innerContainersDetails. * @export * @interface InnerContainersDetails */ export interface InnerContainersDetails { /** * Total containers as part of the shipment * @type {number} * @memberof InnerContainersDetails */ containerCount?: number; /** * Container sequence numbers that are involved in this shipment. * @type {Array} * @memberof InnerContainersDetails */ containerSequenceNumbers?: Array; } /** * Details of the item being shipped. * @export * @interface Item */ export interface Item { /** * Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level. * @type {string} * @memberof Item */ itemSequenceNumber: string; /** * Buyer Standard Identification Number (ASIN) of an item. * @type {string} * @memberof Item */ amazonProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was sent in the purchase order. * @type {string} * @memberof Item */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof Item */ shippedQuantity: ItemQuantity; /** * * @type {ItemDetails} * @memberof Item */ itemDetails?: ItemDetails; } /** * Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. * @export * @interface ItemDetails */ export interface ItemDetails { /** * The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code. * @type {string} * @memberof ItemDetails */ purchaseOrderNumber?: string; /** * The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items. * @type {string} * @memberof ItemDetails */ lotNumber?: string; /** * * @type {Expiry} * @memberof ItemDetails */ expiry?: Expiry; /** * * @type {Money} * @memberof ItemDetails */ maximumRetailPrice?: Money; /** * Identification of the instructions on how specified item/carton/pallet should be handled. * @type {string} * @memberof ItemDetails */ handlingCode?: ItemDetailsHandlingCodeEnum | 'Oversized' | 'Fragile' | 'Food' | 'HandleWithCare'; } /** * @export * @enum {string} */ export declare enum ItemDetailsHandlingCodeEnum { Oversized = "Oversized", Fragile = "Fragile", Food = "Food", HandleWithCare = "HandleWithCare" } /** * Details of item quantity. * @export * @interface ItemQuantity */ export interface ItemQuantity { /** * Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level. * @type {number} * @memberof ItemQuantity */ amount: number; /** * Unit of measure for the shipped quantity. * @type {string} * @memberof ItemQuantity */ unitOfMeasure: ItemQuantityUnitOfMeasureEnum | 'Cases' | 'Eaches'; /** * The case size, in the event that we ordered using cases. Otherwise, 1. * @type {number} * @memberof ItemQuantity */ unitSize?: number; /** * * @type {TotalWeight} * @memberof ItemQuantity */ totalWeight?: TotalWeight; } /** * @export * @enum {string} */ export declare enum ItemQuantityUnitOfMeasureEnum { Cases = "Cases", Eaches = "Eaches" } /** * Label details as part of the transport label response * @export * @interface LabelData */ export interface LabelData { /** * A sequential number assigned to each label within a shipment. * @type {number} * @memberof LabelData */ labelSequenceNumber?: number; /** * The format of the label. * @type {string} * @memberof LabelData */ labelFormat?: LabelDataLabelFormatEnum | 'PDF'; /** * Unique identification of the carrier. * @type {string} * @memberof LabelData */ carrierCode?: string; /** * Tracking Id for the transportation. * @type {string} * @memberof LabelData */ trackingId?: string; /** * The base-64 encoded string that represents the shipment label. * @type {string} * @memberof LabelData */ label?: string; } /** * @export * @enum {string} */ export declare enum LabelDataLabelFormatEnum { Pdf = "PDF" } /** * Location identifier. * @export * @interface Location */ export interface Location { /** * Type of location identification. * @type {string} * @memberof Location */ type?: string; /** * Location code. * @type {string} * @memberof Location */ locationCode?: string; /** * The two digit country code. In ISO 3166-1 alpha-2 format. * @type {string} * @memberof Location */ countryCode?: string; } /** * 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. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * An amount of money, including units in the form of currency. * @export * @interface Money */ export interface Money { /** * Three digit currency code in ISO 4217 format. * @type {string} * @memberof Money */ currencyCode: string; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Money */ amount: string; } /** * Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. * @export * @interface PackageItemDetails */ export interface PackageItemDetails { /** * The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code. * @type {string} * @memberof PackageItemDetails */ purchaseOrderNumber?: string; /** * The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items. * @type {string} * @memberof PackageItemDetails */ lotNumber?: string; /** * * @type {Expiry} * @memberof PackageItemDetails */ expiry?: Expiry; } /** * Details of the item being shipped. * @export * @interface PackedItems */ export interface PackedItems { /** * Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level. * @type {string} * @memberof PackedItems */ itemSequenceNumber?: string; /** * Buyer Standard Identification Number (ASIN) of an item. * @type {string} * @memberof PackedItems */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was sent in the purchase order. * @type {string} * @memberof PackedItems */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof PackedItems */ packedQuantity?: ItemQuantity; /** * * @type {PackageItemDetails} * @memberof PackedItems */ itemDetails?: PackageItemDetails; } /** * Details of item quantity. * @export * @interface PackedQuantity */ export interface PackedQuantity { /** * Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level. * @type {number} * @memberof PackedQuantity */ amount: number; /** * Unit of measure for the shipped quantity. * @type {string} * @memberof PackedQuantity */ unitOfMeasure: PackedQuantityUnitOfMeasureEnum | 'Cases' | 'Eaches'; /** * The case size, in the event that we ordered using cases. Otherwise, 1. * @type {number} * @memberof PackedQuantity */ unitSize?: number; } /** * @export * @enum {string} */ export declare enum PackedQuantityUnitOfMeasureEnum { Cases = "Cases", Eaches = "Eaches" } /** * The pagination elements required to retrieve the remaining data. * @export * @interface Pagination */ export interface Pagination { /** * A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more shipment items to return. * @type {string} * @memberof Pagination */ nextToken?: string; } /** * Details of the Pallet/Tare being shipped. * @export * @interface Pallet */ export interface Pallet { /** * A list of pallet identifiers. * @type {Array} * @memberof Pallet */ palletIdentifiers: Array; /** * Number of layers per pallet. Only applicable to container type Pallet. * @type {number} * @memberof Pallet */ tier?: number; /** * Number of cartons per layer on the pallet. Only applicable to container type Pallet. * @type {number} * @memberof Pallet */ block?: number; /** * * @type {Dimensions} * @memberof Pallet */ dimensions?: Dimensions; /** * * @type {Weight} * @memberof Pallet */ weight?: Weight; /** * * @type {CartonReferenceDetails} * @memberof Pallet */ cartonReferenceDetails?: CartonReferenceDetails; /** * A list of container item details. * @type {Array} * @memberof Pallet */ items?: Array; } /** * Name/Address and tax details of the party. * @export * @interface PartyIdentification */ export interface PartyIdentification { /** * * @type {Address} * @memberof PartyIdentification */ address?: Address; /** * Assigned identification for the party. * @type {string} * @memberof PartyIdentification */ partyId: string; /** * Tax registration details of the entity. * @type {Array} * @memberof PartyIdentification */ taxRegistrationDetails?: Array; } /** * Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. * @export * @interface PurchaseOrderItemDetails */ export interface PurchaseOrderItemDetails { /** * * @type {Money} * @memberof PurchaseOrderItemDetails */ maximumRetailPrice?: Money; } /** * Details of the item being shipped. * @export * @interface PurchaseOrderItems */ export interface PurchaseOrderItems { /** * Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level. * @type {string} * @memberof PurchaseOrderItems */ itemSequenceNumber: string; /** * Amazon Standard Identification Number (ASIN) for a SKU * @type {string} * @memberof PurchaseOrderItems */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was sent in the purchase order. * @type {string} * @memberof PurchaseOrderItems */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof PurchaseOrderItems */ shippedQuantity: ItemQuantity; /** * * @type {Money} * @memberof PurchaseOrderItems */ maximumRetailPrice?: Money; } /** * Transport Request pickup date * @export * @interface PurchaseOrders */ export interface PurchaseOrders { /** * Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment. * @type {string} * @memberof PurchaseOrders */ purchaseOrderNumber?: string; /** * Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment. * @type {string} * @memberof PurchaseOrders */ purchaseOrderDate?: string; /** * Date range in which shipment is expected for these purchase orders. * @type {string} * @memberof PurchaseOrders */ shipWindow?: string; /** * A list of the items that are associated to the PO in this transport and their associated details. * @type {Array} * @memberof PurchaseOrders */ items?: Array; } /** * This is used only for direct import shipment confirmations. * @export * @interface Route */ export interface Route { /** * The port or location involved in transporting the cargo, as specified in transportation contracts or operational plans. * @type {Array} * @memberof Route */ stops: Array; } /** * A list of one or more shipments with respective details. * @export * @interface Shipment */ export interface Shipment { /** * Unique Transportation ID created by Vendor (Should not be used over the last 365 days). * @type {string} * @memberof Shipment */ vendorShipmentIdentifier: string; /** * Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation. * @type {string} * @memberof Shipment */ transactionType: ShipmentTransactionTypeEnum | 'New' | 'Cancel'; /** * The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments. * @type {string} * @memberof Shipment */ buyerReferenceNumber?: string; /** * Date on which the transportation request was submitted. * @type {string} * @memberof Shipment */ transactionDate: string; /** * Indicates the current shipment status. * @type {string} * @memberof Shipment */ currentShipmentStatus?: ShipmentCurrentShipmentStatusEnum | 'Created' | 'TransportationRequested' | 'CarrierAssigned' | 'Shipped'; /** * Date and time when the last status was updated. * @type {string} * @memberof Shipment */ currentshipmentStatusDate?: string; /** * Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response. * @type {Array} * @memberof Shipment */ shipmentStatusDetails?: Array; /** * The date and time of the shipment request created by vendor. * @type {string} * @memberof Shipment */ shipmentCreateDate?: string; /** * The date and time of the departure of the shipment from the vendor\'s location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future. * @type {string} * @memberof Shipment */ shipmentConfirmDate?: string; /** * The date and time of the package label created for the shipment by buyer. * @type {string} * @memberof Shipment */ packageLabelCreateDate?: string; /** * Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information. * @type {string} * @memberof Shipment */ shipmentFreightTerm?: ShipmentShipmentFreightTermEnum | 'Collect' | 'Prepaid'; /** * * @type {PartyIdentification} * @memberof Shipment */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof Shipment */ shipFromParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof Shipment */ shipToParty: PartyIdentification; /** * * @type {TransportShipmentMeasurements} * @memberof Shipment */ shipmentMeasurements?: TransportShipmentMeasurements; /** * * @type {CollectFreightPickupDetails} * @memberof Shipment */ collectFreightPickupDetails?: CollectFreightPickupDetails; /** * Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect) * @type {Array} * @memberof Shipment */ purchaseOrders?: Array; /** * * @type {ImportDetails} * @memberof Shipment */ importDetails?: ImportDetails; /** * A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level. * @type {Array} * @memberof Shipment */ containers?: Array; /** * * @type {TransportationDetails} * @memberof Shipment */ transportationDetails?: TransportationDetails; } /** * @export * @enum {string} */ export declare enum ShipmentTransactionTypeEnum { New = "New", Cancel = "Cancel" } /** * @export * @enum {string} */ export declare enum ShipmentCurrentShipmentStatusEnum { Created = "Created", TransportationRequested = "TransportationRequested", CarrierAssigned = "CarrierAssigned", Shipped = "Shipped" } /** * @export * @enum {string} */ export declare enum ShipmentShipmentFreightTermEnum { Collect = "Collect", Prepaid = "Prepaid" } /** * A list of one or more shipment confirmations. * @export * @interface ShipmentConfirmation */ export interface ShipmentConfirmation { /** * Unique shipment ID (not used over the last 365 days). * @type {string} * @memberof ShipmentConfirmation */ shipmentIdentifier: string; /** * Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. If replacing an existing shipment confirmation, be sure to provide the identical shipmentIdentifier and sellingParty information as in the previous confirmation. * @type {string} * @memberof ShipmentConfirmation */ shipmentConfirmationType: ShipmentConfirmationShipmentConfirmationTypeEnum | 'Original' | 'Replace'; /** * The type of shipment. * @type {string} * @memberof ShipmentConfirmation */ shipmentType?: ShipmentConfirmationShipmentTypeEnum | 'TruckLoad' | 'LessThanTruckLoad' | 'SmallParcel'; /** * Shipment hierarchical structure. * @type {string} * @memberof ShipmentConfirmation */ shipmentStructure?: ShipmentConfirmationShipmentStructureEnum | 'PalletizedAssortmentCase' | 'LooseAssortmentCase' | 'PalletOfItems' | 'PalletizedStandardCase' | 'LooseStandardCase' | 'MasterPallet' | 'MasterCase'; /** * * @type {TransportationDetailsForShipmentConfirmation} * @memberof ShipmentConfirmation */ transportationDetails?: TransportationDetailsForShipmentConfirmation; /** * The Amazon Reference Number is a unique identifier generated by Amazon for all Collect/WePay shipments when you submit a routing request. This field is mandatory for Collect/WePay shipments. * @type {string} * @memberof ShipmentConfirmation */ amazonReferenceNumber?: string; /** * Date on which the shipment confirmation was submitted. * @type {string} * @memberof ShipmentConfirmation */ shipmentConfirmationDate: string; /** * The date and time of the departure of the shipment from the vendor\'s location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future. * @type {string} * @memberof ShipmentConfirmation */ shippedDate?: string; /** * The date and time on which the shipment is estimated to reach buyer\'s warehouse. It needs to be an estimate based on the average transit time between ship from location and the destination. The exact appointment time will be provided by the buyer and is potentially not known when creating the shipment confirmation. * @type {string} * @memberof ShipmentConfirmation */ estimatedDeliveryDate?: string; /** * * @type {PartyIdentification} * @memberof ShipmentConfirmation */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShipmentConfirmation */ shipFromParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShipmentConfirmation */ shipToParty: PartyIdentification; /** * * @type {ShipmentMeasurements} * @memberof ShipmentConfirmation */ shipmentMeasurements?: ShipmentMeasurements; /** * * @type {ImportDetails} * @memberof ShipmentConfirmation */ importDetails?: ImportDetails; /** * A list of the items in this shipment and their associated details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level. * @type {Array} * @memberof ShipmentConfirmation */ shippedItems: Array; /** * A list of the cartons in this shipment. * @type {Array} * @memberof ShipmentConfirmation */ cartons?: Array; /** * A list of the pallets in this shipment. * @type {Array} * @memberof ShipmentConfirmation */ pallets?: Array; } /** * @export * @enum {string} */ export declare enum ShipmentConfirmationShipmentConfirmationTypeEnum { Original = "Original", Replace = "Replace" } /** * @export * @enum {string} */ export declare enum ShipmentConfirmationShipmentTypeEnum { TruckLoad = "TruckLoad", LessThanTruckLoad = "LessThanTruckLoad", SmallParcel = "SmallParcel" } /** * @export * @enum {string} */ export declare enum ShipmentConfirmationShipmentStructureEnum { PalletizedAssortmentCase = "PalletizedAssortmentCase", LooseAssortmentCase = "LooseAssortmentCase", PalletOfItems = "PalletOfItems", PalletizedStandardCase = "PalletizedStandardCase", LooseStandardCase = "LooseStandardCase", MasterPallet = "MasterPallet", MasterCase = "MasterCase" } /** * The request schema for the GetShipmentDetails operation. * @export * @interface ShipmentDetails */ export interface ShipmentDetails { /** * * @type {Pagination} * @memberof ShipmentDetails */ pagination?: Pagination; /** * A list of one or more shipments with underlying details. * @type {Array} * @memberof ShipmentDetails */ shipments?: Array; } /** * Shipment Information details for Label request. * @export * @interface ShipmentInformation */ export interface ShipmentInformation { /** * * @type {VendorDetails} * @memberof ShipmentInformation */ vendorDetails?: VendorDetails; /** * The buyer reference number is a unique identifier generated by the buyer for all Collect and WePay shipments. * @type {string} * @memberof ShipmentInformation */ buyerReferenceNumber?: string; /** * * @type {PartyIdentification} * @memberof ShipmentInformation */ shipToParty?: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShipmentInformation */ shipFromParty?: PartyIdentification; /** * Vendor Warehouse ID from where the shipment is scheduled to be picked up by buyer / Carrier. * @type {string} * @memberof ShipmentInformation */ warehouseId?: string; /** * Unique Id with which the shipment can be tracked for Small Parcels. * @type {string} * @memberof ShipmentInformation */ masterTrackingId?: string; /** * Number of Labels that are created as part of this shipment. * @type {number} * @memberof ShipmentInformation */ totalLabelCount?: number; /** * Type of shipment whether it is Small Parcel * @type {string} * @memberof ShipmentInformation */ shipMode?: ShipmentInformationShipModeEnum | 'SmallParcel' | 'LTL'; } /** * @export * @enum {string} */ export declare enum ShipmentInformationShipModeEnum { SmallParcel = "SmallParcel", Ltl = "LTL" } /** * Shipment measurement details. * @export * @interface ShipmentMeasurements */ export interface ShipmentMeasurements { /** * * @type {Weight} * @memberof ShipmentMeasurements */ grossShipmentWeight?: Weight; /** * * @type {Volume} * @memberof ShipmentMeasurements */ shipmentVolume?: Volume; /** * Number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments. * @type {number} * @memberof ShipmentMeasurements */ cartonCount?: number; /** * Number of pallets present in the shipment. Provide the palletCount only for palletized shipments. * @type {number} * @memberof ShipmentMeasurements */ palletCount?: number; } /** * Shipment Status details. * @export * @interface ShipmentStatusDetails */ export interface ShipmentStatusDetails { /** * Current status of the shipment on whether it is picked up or scheduled. * @type {string} * @memberof ShipmentStatusDetails */ shipmentStatus?: ShipmentStatusDetailsShipmentStatusEnum | 'Created' | 'TransportationRequested' | 'CarrierAssigned' | 'Shipped'; /** * Date and time on last status update received for the shipment * @type {string} * @memberof ShipmentStatusDetails */ shipmentStatusDate?: string; } /** * @export * @enum {string} */ export declare enum ShipmentStatusDetailsShipmentStatusEnum { Created = "Created", TransportationRequested = "TransportationRequested", CarrierAssigned = "CarrierAssigned", Shipped = "Shipped" } /** * Contractual or operational port or point relevant to the movement of the cargo. * @export * @interface Stop */ export interface Stop { /** * Provide the function code. * @type {string} * @memberof Stop */ functionCode: StopFunctionCodeEnum | 'PortOfDischarge' | 'FreightPayableAt' | 'PortOfLoading'; /** * * @type {Location} * @memberof Stop */ locationIdentification?: Location; /** * Date and time of the arrival of the cargo. * @type {string} * @memberof Stop */ arrivalTime?: string; /** * Date and time of the departure of the cargo. * @type {string} * @memberof Stop */ departureTime?: string; } /** * @export * @enum {string} */ export declare enum StopFunctionCodeEnum { PortOfDischarge = "PortOfDischarge", FreightPayableAt = "FreightPayableAt", PortOfLoading = "PortOfLoading" } /** * The request schema for the SubmitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsRequest */ export interface SubmitShipmentConfirmationsRequest { /** * A list of one or more shipment confirmations. * @type {Array} * @memberof SubmitShipmentConfirmationsRequest */ shipmentConfirmations?: Array; } /** * The response schema for the SubmitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsResponse */ export interface SubmitShipmentConfirmationsResponse { /** * * @type {TransactionReference} * @memberof SubmitShipmentConfirmationsResponse */ payload?: TransactionReference; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof SubmitShipmentConfirmationsResponse */ errors?: Array; } /** * The request schema for the SubmitShipments operation. * @export * @interface SubmitShipments */ export interface SubmitShipments { /** * A list of one or more shipments with underlying details. * @type {Array} * @memberof SubmitShipments */ shipments?: Array; } /** * Tax registration details of the entity. * @export * @interface TaxRegistrationDetails */ export interface TaxRegistrationDetails { /** * Tax registration type for the entity. * @type {string} * @memberof TaxRegistrationDetails */ taxRegistrationType: TaxRegistrationDetailsTaxRegistrationTypeEnum | 'VAT' | 'GST'; /** * Tax registration number for the entity. For example, VAT ID. * @type {string} * @memberof TaxRegistrationDetails */ taxRegistrationNumber: string; } /** * @export * @enum {string} */ export declare enum TaxRegistrationDetailsTaxRegistrationTypeEnum { Vat = "VAT", Gst = "GST" } /** * The total weight of units that are sold by weight in a shipment. * @export * @interface TotalWeight */ export interface TotalWeight { /** * The unit of measure for the weight of items that are ordered by cases and support pricing by weight. * @type {string} * @memberof TotalWeight */ unitOfMeasure: TotalWeightUnitOfMeasureEnum | 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS'; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof TotalWeight */ amount: string; } /** * @export * @enum {string} */ export declare enum TotalWeightUnitOfMeasureEnum { Pounds = "POUNDS", Ounces = "OUNCES", Grams = "GRAMS", Kilograms = "KILOGRAMS" } /** * The response payload for the SubmitShipmentConfirmations operation. * @export * @interface TransactionReference */ export interface TransactionReference { /** * GUID assigned by Buyer to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction. * @type {string} * @memberof TransactionReference */ transactionId?: string; } /** * A list of one or more ShipmentLabels. * @export * @interface TransportLabel */ export interface TransportLabel { /** * Date on which label is created. * @type {string} * @memberof TransportLabel */ labelCreateDateTime?: string; /** * * @type {ShipmentInformation} * @memberof TransportLabel */ shipmentInformation?: ShipmentInformation; /** * Indicates the label data,format and type associated . * @type {Array} * @memberof TransportLabel */ labelData?: Array; } /** * Shipment measurement details. * @export * @interface TransportShipmentMeasurements */ export interface TransportShipmentMeasurements { /** * Total number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments. * @type {number} * @memberof TransportShipmentMeasurements */ totalCartonCount?: number; /** * Total number of Stackable Pallets present in the shipment. * @type {number} * @memberof TransportShipmentMeasurements */ totalPalletStackable?: number; /** * Total number of Non Stackable Pallets present in the shipment. * @type {number} * @memberof TransportShipmentMeasurements */ totalPalletNonStackable?: number; /** * * @type {Weight} * @memberof TransportShipmentMeasurements */ shipmentWeight?: Weight; /** * * @type {Volume} * @memberof TransportShipmentMeasurements */ shipmentVolume?: Volume; } /** * Transportation details for this shipment. * @export * @interface TransportationDetails */ export interface TransportationDetails { /** * The type of shipment. * @type {string} * @memberof TransportationDetails */ shipMode?: TransportationDetailsShipModeEnum | 'TruckLoad' | 'LessThanTruckLoad' | 'SmallParcel'; /** * The mode of transportation for this shipment. * @type {string} * @memberof TransportationDetails */ transportationMode?: TransportationDetailsTransportationModeEnum | 'Road' | 'Air' | 'Ocean'; /** * Date when shipment is performed by the Vendor to Buyer * @type {string} * @memberof TransportationDetails */ shippedDate?: string; /** * Estimated Date on which shipment will be delivered from Vendor to Buyer * @type {string} * @memberof TransportationDetails */ estimatedDeliveryDate?: string; /** * Date on which shipment will be delivered from Vendor to Buyer * @type {string} * @memberof TransportationDetails */ shipmentDeliveryDate?: string; /** * * @type {CarrierDetails} * @memberof TransportationDetails */ carrierDetails?: CarrierDetails; /** * The Bill of Lading (BOL) number is a unique number assigned to each shipment of goods by the vendor or shipper during the creation of the Bill of Lading. This number must be unique for every shipment and cannot be a date/time or single character. The BOL numer is mandatory in Shipment Confirmation message for FTL and LTL shipments, and must match the paper BOL provided with the shipment. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field. * @type {string} * @memberof TransportationDetails */ billOfLadingNumber?: string; } /** * @export * @enum {string} */ export declare enum TransportationDetailsShipModeEnum { TruckLoad = "TruckLoad", LessThanTruckLoad = "LessThanTruckLoad", SmallParcel = "SmallParcel" } /** * @export * @enum {string} */ export declare enum TransportationDetailsTransportationModeEnum { Road = "Road", Air = "Air", Ocean = "Ocean" } /** * Transportation details for this shipment. * @export * @interface TransportationDetailsForShipmentConfirmation */ export interface TransportationDetailsForShipmentConfirmation { /** * Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association). This field is mandatory for US, CA, MX shipment confirmations. * @type {string} * @memberof TransportationDetailsForShipmentConfirmation */ carrierScac?: string; /** * The field also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for UA, CA, MX shipment confirmations. * @type {string} * @memberof TransportationDetailsForShipmentConfirmation */ carrierShipmentReferenceNumber?: string; /** * The mode of transportation for this shipment. * @type {string} * @memberof TransportationDetailsForShipmentConfirmation */ transportationMode?: TransportationDetailsForShipmentConfirmationTransportationModeEnum | 'Road' | 'Air' | 'Ocean'; /** * The Bill of Lading (BOL) number is a unique number assigned to each shipment of goods by the vendor or shipper during the creation of the Bill of Lading. This number must be unique for every shipment and cannot be a date/time or single character. The BOL numer is mandatory in Shipment Confirmation message for FTL and LTL shipments, and must match the paper BOL provided with the shipment. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field. * @type {string} * @memberof TransportationDetailsForShipmentConfirmation */ billOfLadingNumber?: string; } /** * @export * @enum {string} */ export declare enum TransportationDetailsForShipmentConfirmationTransportationModeEnum { Road = "Road", Air = "Air", Ocean = "Ocean" } /** * The request schema for the GetShipmentLabels operation. * @export * @interface TransportationLabels */ export interface TransportationLabels { /** * * @type {Pagination} * @memberof TransportationLabels */ pagination?: Pagination; /** * A list of one or more ShipmentLabels. * @type {Array} * @memberof TransportationLabels */ transportLabels?: Array; } /** * Vendor Details as part of Label response. * @export * @interface VendorDetails */ export interface VendorDetails { /** * * @type {PartyIdentification} * @memberof VendorDetails */ sellingParty?: PartyIdentification; /** * Unique vendor shipment id which is not used in last 365 days * @type {string} * @memberof VendorDetails */ vendorShipmentIdentifier?: string; } /** * The volume of the shipment. * @export * @interface Volume */ export interface Volume { /** * The unit of measurement. * @type {string} * @memberof Volume */ unitOfMeasure: VolumeUnitOfMeasureEnum | 'CuFt' | 'CuIn' | 'CuM' | 'CuY'; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Volume */ value: string; } /** * @export * @enum {string} */ export declare enum VolumeUnitOfMeasureEnum { CuFt = "CuFt", CuIn = "CuIn", CuM = "CuM", CuY = "CuY" } /** * The weight of the shipment. * @export * @interface Weight */ export interface Weight { /** * The unit of measurement. * @type {string} * @memberof Weight */ unitOfMeasure: WeightUnitOfMeasureEnum | 'G' | 'Kg' | 'Oz' | 'Lb'; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Weight */ value: string; } /** * @export * @enum {string} */ export declare enum WeightUnitOfMeasureEnum { G = "G", Kg = "Kg", Oz = "Oz", Lb = "Lb" } /** * VendorShippingApi - axios parameter creator * @export */ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary GetShipmentDetails * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more shipments than the specified result size limit. * @param {string} [createdAfter] Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [createdBefore] Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentConfirmedBefore] Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentConfirmedAfter] Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [packageLabelCreatedBefore] Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [packageLabelCreatedAfter] Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shippedBefore] Get Shipment Details by passing Shipped Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shippedAfter] Get Shipment Details by passing Shipped Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [estimatedDeliveryBefore] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [estimatedDeliveryAfter] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentDeliveryBefore] Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentDeliveryAfter] Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [requestedPickUpBefore] Get Shipment Details by passing Before Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [requestedPickUpAfter] Get Shipment Details by passing After Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [scheduledPickUpBefore] Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [scheduledPickUpAfter] Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [currentShipmentStatus] Get Shipment Details by passing Current shipment status. * @param {string} [vendorShipmentIdentifier] Get Shipment Details by passing Vendor Shipment ID * @param {string} [buyerReferenceNumber] Get Shipment Details by passing buyer Reference ID * @param {string} [buyerWarehouseCode] Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment. * @param {string} [sellerWarehouseCode] Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentDetails: (limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: any) => Promise; /** * Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort the list by shipment label creation date in ascending or descending order. * @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. * @param {string} [labelCreatedAfter] Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @param {string} [labelCreatedBefore] Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @param {string} [buyerReferenceNumber] Get Shipment labels by passing buyer reference number. * @param {string} [vendorShipmentIdentifier] Get Shipment labels by passing vendor shipment identifier. * @param {string} [sellerWarehouseCode] Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentLabels: (limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, labelCreatedAfter?: string, labelCreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: any) => Promise; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentConfirmations: (body: SubmitShipmentConfirmationsRequest, options?: any) => Promise; /** * Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipments * @param {SubmitShipments} body A request to submit shipment request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipments: (body: SubmitShipments, options?: any) => Promise; }; /** * VendorShippingApi - functional programming interface * @export */ export declare const VendorShippingApiFp: (configuration?: Configuration) => { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary GetShipmentDetails * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more shipments than the specified result size limit. * @param {string} [createdAfter] Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [createdBefore] Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentConfirmedBefore] Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentConfirmedAfter] Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [packageLabelCreatedBefore] Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [packageLabelCreatedAfter] Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shippedBefore] Get Shipment Details by passing Shipped Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shippedAfter] Get Shipment Details by passing Shipped Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [estimatedDeliveryBefore] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [estimatedDeliveryAfter] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentDeliveryBefore] Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentDeliveryAfter] Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [requestedPickUpBefore] Get Shipment Details by passing Before Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [requestedPickUpAfter] Get Shipment Details by passing After Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [scheduledPickUpBefore] Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [scheduledPickUpAfter] Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [currentShipmentStatus] Get Shipment Details by passing Current shipment status. * @param {string} [vendorShipmentIdentifier] Get Shipment Details by passing Vendor Shipment ID * @param {string} [buyerReferenceNumber] Get Shipment Details by passing buyer Reference ID * @param {string} [buyerWarehouseCode] Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment. * @param {string} [sellerWarehouseCode] Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentDetails(limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort the list by shipment label creation date in ascending or descending order. * @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. * @param {string} [labelCreatedAfter] Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @param {string} [labelCreatedBefore] Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @param {string} [buyerReferenceNumber] Get Shipment labels by passing buyer reference number. * @param {string} [vendorShipmentIdentifier] Get Shipment labels by passing vendor shipment identifier. * @param {string} [sellerWarehouseCode] Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentLabels(limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, labelCreatedAfter?: string, labelCreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipments * @param {SubmitShipments} body A request to submit shipment request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipments(body: SubmitShipments, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VendorShippingApi - factory interface * @export */ export declare const VendorShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary GetShipmentDetails * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more shipments than the specified result size limit. * @param {string} [createdAfter] Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [createdBefore] Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentConfirmedBefore] Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentConfirmedAfter] Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [packageLabelCreatedBefore] Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [packageLabelCreatedAfter] Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shippedBefore] Get Shipment Details by passing Shipped Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shippedAfter] Get Shipment Details by passing Shipped Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [estimatedDeliveryBefore] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [estimatedDeliveryAfter] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentDeliveryBefore] Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [shipmentDeliveryAfter] Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [requestedPickUpBefore] Get Shipment Details by passing Before Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [requestedPickUpAfter] Get Shipment Details by passing After Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [scheduledPickUpBefore] Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [scheduledPickUpAfter] Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [currentShipmentStatus] Get Shipment Details by passing Current shipment status. * @param {string} [vendorShipmentIdentifier] Get Shipment Details by passing Vendor Shipment ID * @param {string} [buyerReferenceNumber] Get Shipment Details by passing buyer Reference ID * @param {string} [buyerWarehouseCode] Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment. * @param {string} [sellerWarehouseCode] Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentDetails(limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: any): AxiosPromise; /** * Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort the list by shipment label creation date in ascending or descending order. * @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. * @param {string} [labelCreatedAfter] Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @param {string} [labelCreatedBefore] Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @param {string} [buyerReferenceNumber] Get Shipment labels by passing buyer reference number. * @param {string} [vendorShipmentIdentifier] Get Shipment labels by passing vendor shipment identifier. * @param {string} [sellerWarehouseCode] Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentLabels(limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, labelCreatedAfter?: string, labelCreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: any): AxiosPromise; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): AxiosPromise; /** * Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipments * @param {SubmitShipments} body A request to submit shipment request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipments(body: SubmitShipments, options?: any): AxiosPromise; }; /** * Request parameters for getShipmentDetails operation in VendorShippingApi. * @export * @interface VendorShippingApiGetShipmentDetailsRequest */ export interface VendorShippingApiGetShipmentDetailsRequest { /** * The limit to the number of records returned. Default value is 50 records. * @type {number} * @memberof VendorShippingApiGetShipmentDetails */ readonly limit?: number; /** * Sort in ascending or descending order by purchase order creation date. * @type {'ASC' | 'DESC'} * @memberof VendorShippingApiGetShipmentDetails */ readonly sortOrder?: 'ASC' | 'DESC'; /** * Used for pagination when there are more shipments than the specified result size limit. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly nextToken?: string; /** * Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly createdAfter?: string; /** * Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly createdBefore?: string; /** * Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly shipmentConfirmedBefore?: string; /** * Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly shipmentConfirmedAfter?: string; /** * Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly packageLabelCreatedBefore?: string; /** * Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly packageLabelCreatedAfter?: string; /** * Get Shipment Details by passing Shipped Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly shippedBefore?: string; /** * Get Shipment Details by passing Shipped Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly shippedAfter?: string; /** * Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly estimatedDeliveryBefore?: string; /** * Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly estimatedDeliveryAfter?: string; /** * Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly shipmentDeliveryBefore?: string; /** * Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly shipmentDeliveryAfter?: string; /** * Get Shipment Details by passing Before Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly requestedPickUpBefore?: string; /** * Get Shipment Details by passing After Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly requestedPickUpAfter?: string; /** * Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly scheduledPickUpBefore?: string; /** * Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly scheduledPickUpAfter?: string; /** * Get Shipment Details by passing Current shipment status. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly currentShipmentStatus?: string; /** * Get Shipment Details by passing Vendor Shipment ID * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly vendorShipmentIdentifier?: string; /** * Get Shipment Details by passing buyer Reference ID * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly buyerReferenceNumber?: string; /** * Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly buyerWarehouseCode?: string; /** * Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment. * @type {string} * @memberof VendorShippingApiGetShipmentDetails */ readonly sellerWarehouseCode?: string; } /** * Request parameters for getShipmentLabels operation in VendorShippingApi. * @export * @interface VendorShippingApiGetShipmentLabelsRequest */ export interface VendorShippingApiGetShipmentLabelsRequest { /** * The limit to the number of records returned. Default value is 50 records. * @type {number} * @memberof VendorShippingApiGetShipmentLabels */ readonly limit?: number; /** * Sort the list by shipment label creation date in ascending or descending order. * @type {'ASC' | 'DESC'} * @memberof VendorShippingApiGetShipmentLabels */ readonly sortOrder?: 'ASC' | 'DESC'; /** * A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. * @type {string} * @memberof VendorShippingApiGetShipmentLabels */ readonly nextToken?: string; /** * Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof VendorShippingApiGetShipmentLabels */ readonly labelCreatedAfter?: string; /** * Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof VendorShippingApiGetShipmentLabels */ readonly labelCreatedBefore?: string; /** * Get Shipment labels by passing buyer reference number. * @type {string} * @memberof VendorShippingApiGetShipmentLabels */ readonly buyerReferenceNumber?: string; /** * Get Shipment labels by passing vendor shipment identifier. * @type {string} * @memberof VendorShippingApiGetShipmentLabels */ readonly vendorShipmentIdentifier?: string; /** * Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. * @type {string} * @memberof VendorShippingApiGetShipmentLabels */ readonly sellerWarehouseCode?: string; } /** * Request parameters for submitShipmentConfirmations operation in VendorShippingApi. * @export * @interface VendorShippingApiSubmitShipmentConfirmationsRequest */ export interface VendorShippingApiSubmitShipmentConfirmationsRequest { /** * A request to submit shipment confirmation. * @type {SubmitShipmentConfirmationsRequest} * @memberof VendorShippingApiSubmitShipmentConfirmations */ readonly body: SubmitShipmentConfirmationsRequest; } /** * Request parameters for submitShipments operation in VendorShippingApi. * @export * @interface VendorShippingApiSubmitShipmentsRequest */ export interface VendorShippingApiSubmitShipmentsRequest { /** * A request to submit shipment request. * @type {SubmitShipments} * @memberof VendorShippingApiSubmitShipments */ readonly body: SubmitShipments; } /** * VendorShippingApi - object-oriented interface * @export * @class VendorShippingApi * @extends {BaseAPI} */ export declare class VendorShippingApi extends BaseAPI { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary GetShipmentDetails * @param {VendorShippingApiGetShipmentDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ getShipmentDetails(requestParameters?: VendorShippingApiGetShipmentDetailsRequest, options?: any): Promise>; /** * Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorShippingApiGetShipmentLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ getShipmentLabels(requestParameters?: VendorShippingApiGetShipmentLabelsRequest, options?: any): Promise>; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipmentConfirmations * @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise>; /** * Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary SubmitShipments * @param {VendorShippingApiSubmitShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ submitShipments(requestParameters: VendorShippingApiSubmitShipmentsRequest, options?: any): Promise>; }