/** * The Selling Partner API for Amazon Warehousing and Distribution * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. * * The version of the OpenAPI document: 2024-05-09 * * * 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'; /** * Shipping address that represents the origin or destination location. * @export * @interface Address */ export interface Address { /** * First line of the address text. * @type {string} * @memberof Address */ addressLine1: string; /** * Optional second line of the address text. * @type {string} * @memberof Address */ addressLine2?: string; /** * Optional third line of the address text. * @type {string} * @memberof Address */ addressLine3?: string; /** * Optional city where this address is located. * @type {string} * @memberof Address */ city?: string; /** * Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located. * @type {string} * @memberof Address */ countryCode: string; /** * Optional county where this address is located. * @type {string} * @memberof Address */ county?: string; /** * Optional district where this address is located. * @type {string} * @memberof Address */ district?: string; /** * Name of the person, business, or institution at this address. * @type {string} * @memberof Address */ name: string; /** * Optional E.164-formatted phone number for an available contact at this address. * @type {string} * @memberof Address */ phoneNumber?: string; /** * Optional postal code where this address is located. * @type {string} * @memberof Address */ postalCode?: string; /** * State or region where this address is located. Note that this is contextual to the specified country code. * @type {string} * @memberof Address */ stateOrRegion: string; } /** * Identifies the carrier that will deliver the shipment. * @export * @interface CarrierCode */ export interface CarrierCode { /** * * @type {CarrierCodeType} * @memberof CarrierCode */ carrierCodeType?: CarrierCodeType | 'SCAC'; /** * Value of the carrier code. * @type {string} * @memberof CarrierCode */ carrierCodeValue?: string; } /** * Denotes the type for the carrier. * @export * @enum {string} */ export declare enum CarrierCodeType { Scac = "SCAC" } /** * Unit of measurement for package dimensions. * @export * @enum {string} */ export declare enum DimensionUnitOfMeasurement { Inches = "INCHES", Centimeters = "CENTIMETERS" } /** * Represents an AWD distribution package. * @export * @interface DistributionPackage */ export interface DistributionPackage { /** * * @type {DistributionPackageContents} * @memberof DistributionPackage */ contents: DistributionPackageContents; /** * * @type {MeasurementData} * @memberof DistributionPackage */ measurements: MeasurementData; /** * * @type {DistributionPackageType} * @memberof DistributionPackage */ type: DistributionPackageType | 'CASE' | 'PALLET'; } /** * Represents the contents inside a package, which can be products or a nested package. * @export * @interface DistributionPackageContents */ export interface DistributionPackageContents { /** * This is required only when `DistributionPackageType=PALLET`. * @type {Array} * @memberof DistributionPackageContents */ packages?: Array; /** * This is required only when `DistributionPackageType=CASE`. * @type {Array} * @memberof DistributionPackageContents */ products?: Array; } /** * Represents a distribution package with its respective quantity. * @export * @interface DistributionPackageQuantity */ export interface DistributionPackageQuantity { /** * Number of cases or pallets with the same package configuration. * @type {number} * @memberof DistributionPackageQuantity */ count: number; /** * * @type {DistributionPackage} * @memberof DistributionPackageQuantity */ distributionPackage: DistributionPackage; } /** * Type of distribution packages. * @export * @enum {string} */ export declare enum DistributionPackageType { Case = "CASE", Pallet = "PALLET" } /** * This exception is thrown when client inputs are invalid. * @export * @interface ErrorList */ export interface ErrorList { /** * A list of errors describing the failures. * @type {Array} * @memberof ErrorList */ errors: Array; } /** * The expiration details of the inventory. This object will only appear if the details parameter in the request is set to `SHOW`. * @export * @interface ExpirationDetails */ export interface ExpirationDetails { /** * The expiration date of the SKU. * @type {string} * @memberof ExpirationDetails */ expiration?: string; /** * The quantity that is present in AWD. * @type {number} * @memberof ExpirationDetails */ onhandQuantity?: number; } /** * The label format type extension. * @export * @enum {string} */ export declare enum FormatType { Pdf = "PDF" } /** * Represents the eligibility status of the inbound packages. * @export * @interface InboundEligibility */ export interface InboundEligibility { /** * If there are order level eligibility issues, then this list will contain those error codes and descriptions. * @type {Array} * @memberof InboundEligibility */ ineligibilityReasons?: Array; /** * Details on SKU eligibility for each inbound package. * @type {Array} * @memberof InboundEligibility */ packagesToInbound: Array; /** * Timestamp when the eligibility check is performed. * @type {string} * @memberof InboundEligibility */ previewedAt: string; /** * * @type {InboundEligibilityStatus} * @memberof InboundEligibility */ status: InboundEligibilityStatus | 'ELIGIBLE' | 'INELIGIBLE'; } /** * Enum denoting the package inbound eligibility. * @export * @enum {string} */ export declare enum InboundEligibilityStatus { Eligible = "ELIGIBLE", Ineligible = "INELIGIBLE" } /** * Represents an AWD inbound order. * @export * @interface InboundOrder */ export interface InboundOrder { /** * List of inbound shipments part of this order. * @type {Array} * @memberof InboundOrder */ channelPlacedInboundShipments: Array; /** * Date when this order was created. * @type {string} * @memberof InboundOrder */ createdAt: string; /** * Reference ID that can be used to correlate the order with partner resources. * @type {string} * @memberof InboundOrder */ externalReferenceId?: string; /** * Inbound order ID. * @type {string} * @memberof InboundOrder */ orderId: string; /** * * @type {InboundStatus} * @memberof InboundOrder */ orderStatus: InboundStatus | 'DRAFT' | 'VALIDATING' | 'CONFIRMED' | 'CLOSED' | 'EXPIRED' | 'CANCELLED'; /** * Inbound order version. * @type {string} * @memberof InboundOrder */ orderVersion: string; /** * * @type {Address} * @memberof InboundOrder */ originAddress: Address; /** * List of packages to be inbounded. * @type {Array} * @memberof InboundOrder */ packagesToInbound: Array; /** * * @type {InboundPreferences} * @memberof InboundOrder */ preferences?: InboundPreferences; /** * Date by which this order will be shipped. * @type {string} * @memberof InboundOrder */ shipBy?: string; /** * Date when this order was last updated. * @type {string} * @memberof InboundOrder */ updatedAt?: string; } /** * Payload for creating an inbound order. * @export * @interface InboundOrderCreationData */ export interface InboundOrderCreationData { /** * Reference ID that can be used to correlate the order with partner resources. * @type {string} * @memberof InboundOrderCreationData */ externalReferenceId?: string; /** * * @type {Address} * @memberof InboundOrderCreationData */ originAddress: Address; /** * List of packages to be inbounded. * @type {Array} * @memberof InboundOrderCreationData */ packagesToInbound: Array; /** * * @type {InboundPreferences} * @memberof InboundOrderCreationData */ preferences?: InboundPreferences; /** * Estimated date by when goods have to be picked up. * @type {string} * @memberof InboundOrderCreationData */ shipBy?: string; } /** * A response that contains the reference identifiers for the newly created or updated inbound order. Consists of an order ID and version. * @export * @interface InboundOrderReference */ export interface InboundOrderReference { /** * Order ID of the inbound order. * @type {string} * @memberof InboundOrderReference */ orderId: string; /** * Order version of the inbound order. * @type {string} * @memberof InboundOrderReference */ orderVersion: string; } /** * Represents the packages to inbound. * @export * @interface InboundPackages */ export interface InboundPackages { /** * List of packages to be inbounded. * @type {Array} * @memberof InboundPackages */ packagesToInbound: Array; } /** * Preferences that can be passed in context of an inbound order * @export * @interface InboundPreferences */ export interface InboundPreferences { /** * Pass a preferred region so that the inbound order can be shipped to an AWD warehouse located in that region. This doesn\'t guarantee the order to be assigned in the specified destination region as it depends on warehouse capacity availability. AWD currently supports following region IDs: [us-west, us-east] * @type {string} * @memberof InboundPreferences */ destinationRegion?: string; } /** * Represents an AWD inbound shipment. * @export * @interface InboundShipment */ export interface InboundShipment { /** * * @type {CarrierCode} * @memberof InboundShipment */ carrierCode?: CarrierCode; /** * Timestamp when the shipment was created. The date is returned in ISO 8601 format. * @type {string} * @memberof InboundShipment */ createdAt?: string; /** * * @type {Address} * @memberof InboundShipment */ destinationAddress: Address; /** * Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record. * @type {string} * @memberof InboundShipment */ externalReferenceId?: string; /** * The AWD inbound order ID that this inbound shipment belongs to. * @type {string} * @memberof InboundShipment */ orderId: string; /** * * @type {Address} * @memberof InboundShipment */ originAddress: Address; /** * Quantity received (at the receiving end) as part of this shipment. * @type {Array} * @memberof InboundShipment */ receivedQuantity?: Array; /** * Timestamp when the shipment will be shipped. * @type {string} * @memberof InboundShipment */ shipBy?: string; /** * Packages that are part of this shipment. * @type {Array} * @memberof InboundShipment */ shipmentContainerQuantities: Array; /** * Unique shipment ID. * @type {string} * @memberof InboundShipment */ shipmentId: string; /** * Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW. * @type {Array} * @memberof InboundShipment */ shipmentSkuQuantities?: Array; /** * Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east] * @type {string} * @memberof InboundShipment */ destinationRegion?: string; /** * * @type {InboundShipmentStatus} * @memberof InboundShipment */ shipmentStatus: InboundShipmentStatus | 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'; /** * Carrier-unique tracking ID for this shipment. * @type {string} * @memberof InboundShipment */ trackingId?: string; /** * Timestamp when the shipment was updated. The date is returned in ISO 8601 format. * @type {string} * @memberof InboundShipment */ updatedAt?: string; /** * An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking. * @type {string} * @memberof InboundShipment */ warehouseReferenceId?: string; } /** * Possible shipment statuses used by shipments. * @export * @enum {string} */ export declare enum InboundShipmentStatus { Created = "CREATED", Shipped = "SHIPPED", InTransit = "IN_TRANSIT", Receiving = "RECEIVING", Delivered = "DELIVERED", Closed = "CLOSED", Cancelled = "CANCELLED" } /** * Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment. * @export * @interface InboundShipmentSummary */ export interface InboundShipmentSummary { /** * Timestamp when the shipment was created. * @type {string} * @memberof InboundShipmentSummary */ createdAt?: string; /** * Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record. * @type {string} * @memberof InboundShipmentSummary */ externalReferenceId?: string; /** * The AWD inbound order ID that this inbound shipment belongs to. * @type {string} * @memberof InboundShipmentSummary */ orderId: string; /** * A unique shipment ID. * @type {string} * @memberof InboundShipmentSummary */ shipmentId: string; /** * * @type {InboundShipmentStatus} * @memberof InboundShipmentSummary */ shipmentStatus: InboundShipmentStatus | 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'; /** * Timestamp when the shipment was updated. * @type {string} * @memberof InboundShipmentSummary */ updatedAt?: string; } /** * The supported statuses for an inbound order. * @export * @enum {string} */ export declare enum InboundStatus { Draft = "DRAFT", Validating = "VALIDATING", Confirmed = "CONFIRMED", Closed = "CLOSED", Expired = "EXPIRED", Cancelled = "CANCELLED" } /** * Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`. * @export * @interface InventoryDetails */ export interface InventoryDetails { /** * Quantity that is available for downstream channel replenishment. * @type {number} * @memberof InventoryDetails */ availableDistributableQuantity?: number; /** * Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment. * @type {number} * @memberof InventoryDetails */ reservedDistributableQuantity?: number; } /** * Enum to specify if returned summaries should include additional summarized inventory details and quantities. * @export * @enum {string} */ export declare enum InventoryDetailsVisibility { Show = "SHOW", Hide = "HIDE" } /** * AWD inventory payload. * @export * @interface InventoryListing */ export interface InventoryListing { /** * List of inventory summaries. * @type {Array} * @memberof InventoryListing */ inventory: Array; /** * A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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 InventoryListing */ nextToken?: string; } /** * Quantity of inventory with an associated measurement unit context. * @export * @interface InventoryQuantity */ export interface InventoryQuantity { /** * Quantity of the respective inventory. * @type {number} * @memberof InventoryQuantity */ quantity: number; /** * * @type {InventoryUnitOfMeasurement} * @memberof InventoryQuantity */ unitOfMeasurement: InventoryUnitOfMeasurement | 'PRODUCT_UNITS' | 'CASES' | 'PALLETS'; } /** * Summary of inventory per SKU. * @export * @interface InventorySummary */ export interface InventorySummary { /** * The expiration details of the inventory. This object will only appear if the `details` parameter in the request is set to `SHOW`. * @type {Array} * @memberof InventorySummary */ expirationDetails?: Array; /** * * @type {InventoryDetails} * @memberof InventorySummary */ inventoryDetails?: InventoryDetails; /** * The seller or merchant SKU. * @type {string} * @memberof InventorySummary */ sku: string; /** * Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center * @type {number} * @memberof InventorySummary */ totalInboundQuantity?: number; /** * Total quantity that is present in AWD distribution centers. * @type {number} * @memberof InventorySummary */ totalOnhandQuantity?: number; } /** * Unit of measurement for the inventory. * @export * @enum {string} */ export declare enum InventoryUnitOfMeasurement { ProductUnits = "PRODUCT_UNITS", Cases = "CASES", Pallets = "PALLETS" } /** * The entity that labels the products. * @export * @enum {string} */ export declare enum LabelOwner { Amazon = "AMAZON", Self = "SELF" } /** * The status of your label. * @export * @enum {string} */ export declare enum LabelStatus { Generating = "GENERATING", Generated = "GENERATED", GenerationFailed = "GENERATION_FAILED", NotReady = "NOT_READY" } /** * Package weight and dimension. * @export * @interface MeasurementData */ export interface MeasurementData { /** * * @type {PackageDimensions} * @memberof MeasurementData */ dimensions?: PackageDimensions; /** * * @type {PackageVolume} * @memberof MeasurementData */ volume?: PackageVolume; /** * * @type {PackageWeight} * @memberof MeasurementData */ weight: PackageWeight; } /** * 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; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; /** * A message that describes the error condition. * @type {string} * @memberof ModelError */ message: string; } /** * Consists of the order preference and corresponding preference value. * @export * @interface OrderAttribute */ export interface OrderAttribute { /** * * @type {OrderPreference} * @memberof OrderAttribute */ orderPreference: OrderPreference | 'PARTIAL_ORDER'; /** * * @type {OrderPreferenceValue} * @memberof OrderAttribute */ orderPreferenceValue: OrderPreferenceValue | 'SET' | 'UNSET'; } /** * Represents one ineligibility reason for the order (there can be multiple reasons). * @export * @interface OrderIneligibilityReason */ export interface OrderIneligibilityReason { /** * Code for the order ineligibility. * @type {string} * @memberof OrderIneligibilityReason */ code: string; /** * Description detailing the ineligibility reason of the order. * @type {string} * @memberof OrderIneligibilityReason */ description: string; } /** * Supported preferences for the distribution order. * @export * @enum {string} */ export declare enum OrderPreference { PartialOrder = "PARTIAL_ORDER" } /** * Value for the order preference. * @export * @enum {string} */ export declare enum OrderPreferenceValue { Set = "SET", Unset = "UNSET" } /** * Execution errors associated with the outbound order. This field will be populated if the order failed validation. * @export * @interface OutboundExecutionError */ export interface OutboundExecutionError { /** * Failure code details for the error. * @type {string} * @memberof OutboundExecutionError */ failureCode: string; /** * Failure reasons for the error. * @type {Array} * @memberof OutboundExecutionError */ failureReasons: Array; /** * MSKU associated with the error. * @type {string} * @memberof OutboundExecutionError */ sku?: string; } /** * A list of paginated outbound orders filtered by the attributes passed in the request. * @export * @interface OutboundListing */ export interface OutboundListing { /** * TA token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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 OutboundListing */ nextToken?: string; /** * List of outbound orders. * @type {Array} * @memberof OutboundListing */ outboundOrders?: Array; } /** * Represents an AWD outbound order. * @export * @interface OutboundOrder */ export interface OutboundOrder { /** * Date on which this outbound order was confirmed. * @type {string} * @memberof OutboundOrder */ confirmedOn?: string; /** * Date on which this outbound order was created. * @type {string} * @memberof OutboundOrder */ createdAt?: string; /** * List of packages that are eligible for outbound. * @type {Array} * @memberof OutboundOrder */ eligiblePackagesToOutbound?: Array; /** * List of product units that are eligible for outbound. * @type {Array} * @memberof OutboundOrder */ eligibleProductsToOutbound?: Array; /** * Execution errors associated with the outbound order. This field will be populated if the order failed validation. * @type {Array} * @memberof OutboundOrder */ executionErrors?: Array; /** * Order ID for the outbound order. * @type {string} * @memberof OutboundOrder */ orderId: string; /** * Order preferences for this outbound order. * @type {Array} * @memberof OutboundOrder */ orderPreferences?: Array; /** * * @type {OutboundStatus} * @memberof OutboundOrder */ orderStatus: OutboundStatus | 'CONFIRMED' | 'DRAFT' | 'ELIGIBLE' | 'EXECUTING' | 'FAILURE' | 'INELIGIBLE' | 'INVENTORY_OUTBOUND' | 'SUCCESS' | 'VALIDATING'; /** * List of outbound shipments that are part of this order. * @type {Array} * @memberof OutboundOrder */ outboundShipments: Array; /** * List of packages to be outbound. * @type {Array} * @memberof OutboundOrder */ packagesToOutbound?: Array; /** * List of product units to be outbound. * @type {Array} * @memberof OutboundOrder */ productsToOutbound?: Array; /** * Outbound packages that are shipped after the execution has completed post confirmation. * @type {Array} * @memberof OutboundOrder */ shippedOutboundPackages?: Array; /** * Outbound product units that are shipped after the execution has completed post confirmation. * @type {Array} * @memberof OutboundOrder */ shippedOutboundProducts?: Array; /** * Date on which this outbound order was last updated. * @type {string} * @memberof OutboundOrder */ updatedAt?: string; } /** * Payload for creating an outbound order. * @export * @interface OutboundOrderCreationData */ export interface OutboundOrderCreationData { /** * Order preferences for the outbound order. * @type {Array} * @memberof OutboundOrderCreationData */ orderPreferences?: Array; /** * List of packages to be outbound. * @type {Array} * @memberof OutboundOrderCreationData */ packagesToOutbound?: Array; /** * List of product units to be outbound. * @type {Array} * @memberof OutboundOrderCreationData */ productsToOutbound?: Array; } /** * A response that contains the reference identifier for the newly created or updated outbound order. This includes an order ID. * @export * @interface OutboundOrderReference */ export interface OutboundOrderReference { /** * outbound order ID. * @type {string} * @memberof OutboundOrderReference */ orderId: string; } /** * Represents an AWD outbound shipment. * @export * @interface OutboundShipment */ export interface OutboundShipment { /** * Timestamp when the shipment was created. * @type {string} * @memberof OutboundShipment */ createdAt?: string; /** * * @type {Address} * @memberof OutboundShipment */ destinationAddress: Address; /** * Outbound order ID this outbound shipment belongs to. * @type {string} * @memberof OutboundShipment */ orderId: string; /** * * @type {Address} * @memberof OutboundShipment */ originAddress: Address; /** * Specific distribution packages that are included in the context of this shipment. * @type {Array} * @memberof OutboundShipment */ shipmentPackageQuantities?: Array; /** * Unique shipment ID. * @type {string} * @memberof OutboundShipment */ shipmentId: string; /** * Specific product units that are included in the context of this shipment. * @type {Array} * @memberof OutboundShipment */ shipmentProductQuantities?: Array; /** * * @type {OutboundShipmentStatus} * @memberof OutboundShipment */ shipmentStatus: OutboundShipmentStatus | 'CREATED' | 'IN_TRANSIT' | 'DELIVERED' | 'RECEIVING' | 'RECEIVED' | 'CLOSED' | 'CANCELLED' | 'FAILED'; /** * Timestamp when the shipment was updated. * @type {string} * @memberof OutboundShipment */ updatedAt?: string; } /** * Possible shipment statuses for outbound shipments. * @export * @enum {string} */ export declare enum OutboundShipmentStatus { Created = "CREATED", InTransit = "IN_TRANSIT", Delivered = "DELIVERED", Receiving = "RECEIVING", Received = "RECEIVED", Closed = "CLOSED", Cancelled = "CANCELLED", Failed = "FAILED" } /** * Statuses supported for an outbound order. * @export * @enum {string} */ export declare enum OutboundStatus { Confirmed = "CONFIRMED", Draft = "DRAFT", Eligible = "ELIGIBLE", Executing = "EXECUTING", Failure = "FAILURE", Ineligible = "INELIGIBLE", InventoryOutbound = "INVENTORY_OUTBOUND", Success = "SUCCESS", Validating = "VALIDATING" } /** * Dimensions of the package. * @export * @interface PackageDimensions */ export interface PackageDimensions { /** * Height of the package. * @type {number} * @memberof PackageDimensions */ height: number; /** * Length of the package. * @type {number} * @memberof PackageDimensions */ length: number; /** * * @type {DimensionUnitOfMeasurement} * @memberof PackageDimensions */ unitOfMeasurement: DimensionUnitOfMeasurement | 'INCHES' | 'CENTIMETERS'; /** * Width of the package. * @type {number} * @memberof PackageDimensions */ width: number; } /** * Represents the volume of the package with a unit of measurement. * @export * @interface PackageVolume */ export interface PackageVolume { /** * * @type {VolumeUnitOfMeasurement} * @memberof PackageVolume */ unitOfMeasurement: VolumeUnitOfMeasurement | 'CU_IN' | 'CBM' | 'CC'; /** * The package volume value. * @type {number} * @memberof PackageVolume */ volume: number; } /** * Represents the weight of the package with a unit of measurement. * @export * @interface PackageWeight */ export interface PackageWeight { /** * * @type {WeightUnitOfMeasurement} * @memberof PackageWeight */ unitOfMeasurement: WeightUnitOfMeasurement | 'POUNDS' | 'KILOGRAMS'; /** * The package weight value. * @type {number} * @memberof PackageWeight */ weight: number; } /** * Label page type. * @export * @enum {string} */ export declare enum PageType { ThermalNonpcp = "THERMAL_NONPCP", PlainPaper = "PLAIN_PAPER", Letter6 = "LETTER_6" } /** * The preparation details for a product. This contains the prep category, prep owner, and label owner. Prep instructions are generated based on the specified category. * @export * @interface PrepDetails */ export interface PrepDetails { /** * * @type {LabelOwner} * @memberof PrepDetails */ labelOwner?: LabelOwner | 'AMAZON' | 'SELF'; /** * The preparation category for shipping an item to Amazon\'s fulfillment network. * @type {string} * @memberof PrepDetails */ prepCategory?: string; /** * Information that pertains to the preparation of inbound products. This is generated based on the specified category. * @type {Array} * @memberof PrepDetails */ prepInstructions?: Array; /** * * @type {PrepOwner} * @memberof PrepDetails */ prepOwner?: PrepOwner | 'AMAZON' | 'SELF'; } /** * Information pertaining to the preparation of inbound products. * @export * @interface PrepInstruction */ export interface PrepInstruction { /** * * @type {PrepOwner} * @memberof PrepInstruction */ prepOwner?: PrepOwner | 'AMAZON' | 'SELF'; /** * The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central. * @type {string} * @memberof PrepInstruction */ prepType?: string; } /** * The owner of the preparations, if special preparations are required. * @export * @enum {string} */ export declare enum PrepOwner { Amazon = "AMAZON", Self = "SELF" } /** * Product instance attribute that is not described at the SKU level in the catalog. * @export * @interface ProductAttribute */ export interface ProductAttribute { /** * Product attribute name. * @type {string} * @memberof ProductAttribute */ name?: string; /** * Product attribute value. * @type {string} * @memberof ProductAttribute */ value?: string; } /** * Represents a product with the SKU details and the corresponding quantity. * @export * @interface ProductQuantity */ export interface ProductQuantity { /** * Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU. * @type {Array} * @memberof ProductQuantity */ attributes?: Array; /** * Product quantity. * @type {number} * @memberof ProductQuantity */ quantity: number; /** * The seller or merchant SKU. * @type {string} * @memberof ProductQuantity */ sku: string; /** * The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof ProductQuantity */ expiration?: string; /** * * @type {PrepDetails} * @memberof ProductQuantity */ prepDetails?: PrepDetails; } /** * Shipment labels. * @export * @interface ShipmentLabels */ export interface ShipmentLabels { /** * URL to download generated labels. * @type {string} * @memberof ShipmentLabels */ labelDownloadURL?: string; /** * * @type {LabelStatus} * @memberof ShipmentLabels */ labelStatus: LabelStatus | 'GENERATING' | 'GENERATED' | 'GENERATION_FAILED' | 'NOT_READY'; } /** * A list of inbound shipment summaries filtered by the attributes specified in the request. * @export * @interface ShipmentListing */ export interface ShipmentListing { /** * A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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 ShipmentListing */ nextToken?: string; /** * List of inbound shipment summaries. * @type {Array} * @memberof ShipmentListing */ shipments?: Array; } /** * Denotes the field name on which the shipments are to be sorted. * @export * @enum {string} */ export declare enum ShipmentSortableField { UpdatedAt = "UPDATED_AT", CreatedAt = "CREATED_AT" } /** * Represents eligibility of one SKU. * @export * @interface SkuEligibility */ export interface SkuEligibility { /** * If not eligible, these are list of error codes and descriptions. * @type {Array} * @memberof SkuEligibility */ ineligibilityReasons?: Array; /** * * @type {DistributionPackageQuantity} * @memberof SkuEligibility */ packageQuantity: DistributionPackageQuantity; /** * * @type {InboundEligibilityStatus} * @memberof SkuEligibility */ status: InboundEligibilityStatus | 'ELIGIBLE' | 'INELIGIBLE'; } /** * Represents the ineligibility reason for one SKU. * @export * @interface SkuIneligibilityReason */ export interface SkuIneligibilityReason { /** * Code for the SKU ineligibility. * @type {string} * @memberof SkuIneligibilityReason */ code: string; /** * Detailed description of the SKU ineligibility. * @type {string} * @memberof SkuIneligibilityReason */ description: string; } /** * Enum to specify if returned shipment should include SKU quantity details * @export * @enum {string} */ export declare enum SkuQuantitiesVisibility { Show = "SHOW", Hide = "HIDE" } /** * Quantity details for a SKU as part of a shipment * @export * @interface SkuQuantity */ export interface SkuQuantity { /** * * @type {InventoryQuantity} * @memberof SkuQuantity */ expectedQuantity: InventoryQuantity; /** * * @type {InventoryQuantity} * @memberof SkuQuantity */ receivedQuantity?: InventoryQuantity; /** * The merchant stock keeping unit * @type {string} * @memberof SkuQuantity */ sku: string; } /** * Sort order for a collection of items. For example, order or shipment. * @export * @enum {string} */ export declare enum SortOrder { Ascending = "ASCENDING", Descending = "DESCENDING" } /** * Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment. * @export * @interface TrackingDetails */ export interface TrackingDetails { /** * * @type {CarrierCode} * @memberof TrackingDetails */ carrierCode?: CarrierCode; /** * Timestamp denoting when the shipment will be shipped Date should be in ISO 8601 format as defined by date-time. * @type {string} * @memberof TrackingDetails */ shipBy: string; /** * The identifier that is received from transportation to uniquely identify a booking. * @type {string} * @memberof TrackingDetails */ bookingId?: string; } /** * Transportation details for the shipment. * @export * @interface TransportationDetails */ export interface TransportationDetails { /** * Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment. * @type {Array} * @memberof TransportationDetails */ trackingDetails: Array; } /** * Unit of measurement for the package volume. * @export * @enum {string} */ export declare enum VolumeUnitOfMeasurement { CuIn = "CU_IN", Cbm = "CBM", Cc = "CC" } /** * Unit of measurement for the package weight. * @export * @enum {string} */ export declare enum WeightUnitOfMeasurement { Pounds = "POUNDS", Kilograms = "KILOGRAMS" } /** * AwdApi - axios parameter creator * @export */ export declare const AwdApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. * @param {'SHOW' | 'HIDE'} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundShipment: (shipmentId: string, skuQuantities?: "SHOW" | "HIDE", options?: any) => Promise; /** * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {number} [maxResults] Maximum number of results to return. * @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 `maxResults` 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 {*} [options] Override http request option. * @throws {RequiredError} */ listInboundShipments: (sortBy?: "UPDATED_AT" | "CREATED_AT", sortOrder?: "ASCENDING" | "DESCENDING", shipmentStatus?: "CREATED" | "SHIPPED" | "IN_TRANSIT" | "RECEIVING" | "DELIVERED" | "CLOSED" | "CANCELLED", updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: any) => Promise; /** * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} [sku] Filter by seller or merchant SKU for the item. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. * @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 `maxResults` 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 {number} [maxResults] Maximum number of results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInventory: (sku?: string, sortOrder?: "ASCENDING" | "DESCENDING", details?: "SHOW" | "HIDE", nextToken?: string, maxResults?: number, options?: any) => Promise; }; /** * AwdApi - functional programming interface * @export */ export declare const AwdApiFp: (configuration?: Configuration) => { /** * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. * @param {'SHOW' | 'HIDE'} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundShipment(shipmentId: string, skuQuantities?: "SHOW" | "HIDE", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {number} [maxResults] Maximum number of results to return. * @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 `maxResults` 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 {*} [options] Override http request option. * @throws {RequiredError} */ listInboundShipments(sortBy?: "UPDATED_AT" | "CREATED_AT", sortOrder?: "ASCENDING" | "DESCENDING", shipmentStatus?: "CREATED" | "SHIPPED" | "IN_TRANSIT" | "RECEIVING" | "DELIVERED" | "CLOSED" | "CANCELLED", updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} [sku] Filter by seller or merchant SKU for the item. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. * @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 `maxResults` 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 {number} [maxResults] Maximum number of results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInventory(sku?: string, sortOrder?: "ASCENDING" | "DESCENDING", details?: "SHOW" | "HIDE", nextToken?: string, maxResults?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AwdApi - factory interface * @export */ export declare const AwdApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. * @param {'SHOW' | 'HIDE'} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundShipment(shipmentId: string, skuQuantities?: "SHOW" | "HIDE", options?: any): AxiosPromise; /** * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {number} [maxResults] Maximum number of results to return. * @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 `maxResults` 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 {*} [options] Override http request option. * @throws {RequiredError} */ listInboundShipments(sortBy?: "UPDATED_AT" | "CREATED_AT", sortOrder?: "ASCENDING" | "DESCENDING", shipmentStatus?: "CREATED" | "SHIPPED" | "IN_TRANSIT" | "RECEIVING" | "DELIVERED" | "CLOSED" | "CANCELLED", updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: any): AxiosPromise; /** * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} [sku] Filter by seller or merchant SKU for the item. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. * @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 `maxResults` 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 {number} [maxResults] Maximum number of results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInventory(sku?: string, sortOrder?: "ASCENDING" | "DESCENDING", details?: "SHOW" | "HIDE", nextToken?: string, maxResults?: number, options?: any): AxiosPromise; }; /** * Request parameters for getInboundShipment operation in AwdApi. * @export * @interface AwdApiGetInboundShipmentRequest */ export interface AwdApiGetInboundShipmentRequest { /** * ID for the shipment. A shipment contains the cases being inbounded. * @type {string} * @memberof AwdApiGetInboundShipment */ readonly shipmentId: string; /** * If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @type {'SHOW' | 'HIDE'} * @memberof AwdApiGetInboundShipment */ readonly skuQuantities?: 'SHOW' | 'HIDE'; } /** * Request parameters for listInboundShipments operation in AwdApi. * @export * @interface AwdApiListInboundShipmentsRequest */ export interface AwdApiListInboundShipmentsRequest { /** * Field to sort results by. By default, the response will be sorted by UPDATED_AT. * @type {'UPDATED_AT' | 'CREATED_AT'} * @memberof AwdApiListInboundShipments */ readonly sortBy?: 'UPDATED_AT' | 'CREATED_AT'; /** * Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @type {'ASCENDING' | 'DESCENDING'} * @memberof AwdApiListInboundShipments */ readonly sortOrder?: 'ASCENDING' | 'DESCENDING'; /** * Filter by inbound shipment status. * @type {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} * @memberof AwdApiListInboundShipments */ readonly shipmentStatus?: 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'; /** * List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof AwdApiListInboundShipments */ readonly updatedAfter?: string; /** * List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} * @memberof AwdApiListInboundShipments */ readonly updatedBefore?: string; /** * Maximum number of results to return. * @type {number} * @memberof AwdApiListInboundShipments */ readonly maxResults?: number; /** * A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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 AwdApiListInboundShipments */ readonly nextToken?: string; } /** * Request parameters for listInventory operation in AwdApi. * @export * @interface AwdApiListInventoryRequest */ export interface AwdApiListInventoryRequest { /** * Filter by seller or merchant SKU for the item. * @type {string} * @memberof AwdApiListInventory */ readonly sku?: string; /** * Sort the response in `ASCENDING` or `DESCENDING` order. * @type {'ASCENDING' | 'DESCENDING'} * @memberof AwdApiListInventory */ readonly sortOrder?: 'ASCENDING' | 'DESCENDING'; /** * Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. * @type {'SHOW' | 'HIDE'} * @memberof AwdApiListInventory */ readonly details?: 'SHOW' | 'HIDE'; /** * A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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 AwdApiListInventory */ readonly nextToken?: string; /** * Maximum number of results to return. * @type {number} * @memberof AwdApiListInventory */ readonly maxResults?: number; } /** * AwdApi - object-oriented interface * @export * @class AwdApi * @extends {BaseAPI} */ export declare class AwdApi extends BaseAPI { /** * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {AwdApiGetInboundShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AwdApi */ getInboundShipment(requestParameters: AwdApiGetInboundShipmentRequest, options?: any): Promise>; /** * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {AwdApiListInboundShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AwdApi */ listInboundShipments(requestParameters?: AwdApiListInboundShipmentsRequest, options?: any): Promise>; /** * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {AwdApiListInventoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AwdApi */ listInventory(requestParameters?: AwdApiListInventoryRequest, options?: any): Promise>; }