UNPKG

@scaleleap/selling-partner-api-sdk

Version:

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

1,826 lines • 372 kB
/** * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 * * * 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'; /** * Specific details to identify a place. * @export * @interface Address */ export interface Address { /** * Street address information. * @type {string} * @memberof Address */ addressLine1: string; /** * Additional street address information. * @type {string} * @memberof Address */ addressLine2?: string; /** * The city. * @type {string} * @memberof Address */ city: string; /** * The name of the business. * @type {string} * @memberof Address */ companyName?: string; /** * The country code in two-character ISO 3166-1 alpha-2 format. * @type {string} * @memberof Address */ countryCode: string; /** * The email address. * @type {string} * @memberof Address */ email?: string; /** * The name of the individual who is the primary contact. * @type {string} * @memberof Address */ name: string; /** * The phone number. * @type {string} * @memberof Address */ phoneNumber?: string; /** * The postal code. * @type {string} * @memberof Address */ postalCode: string; /** * The state or province code. * @type {string} * @memberof Address */ stateOrProvinceCode?: string; } /** * Specific details to identify a place. * @export * @interface AddressInput */ export interface AddressInput { /** * Street address information. * @type {string} * @memberof AddressInput */ addressLine1: string; /** * Additional street address information. * @type {string} * @memberof AddressInput */ addressLine2?: string; /** * The city. * @type {string} * @memberof AddressInput */ city: string; /** * The name of the business. * @type {string} * @memberof AddressInput */ companyName?: string; /** * The country code in two-character ISO 3166-1 alpha-2 format. * @type {string} * @memberof AddressInput */ countryCode: string; /** * The email address. * @type {string} * @memberof AddressInput */ email?: string; /** * The name of the individual who is the primary contact. * @type {string} * @memberof AddressInput */ name: string; /** * The phone number. * @type {string} * @memberof AddressInput */ phoneNumber: string; /** * The postal code. * @type {string} * @memberof AddressInput */ postalCode: string; /** * The state or province code. * @type {string} * @memberof AddressInput */ stateOrProvinceCode?: string; } /** * A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints. * @export * @enum {string} */ export declare enum AllOwnersConstraint { MustMatch = "MUST_MATCH" } /** * The fulfillment center appointment slot for the transportation option. * @export * @interface AppointmentSlot */ export interface AppointmentSlot { /** * An identifier to a self-ship appointment slot. * @type {string} * @memberof AppointmentSlot */ slotId: string; /** * * @type {AppointmentSlotTime} * @memberof AppointmentSlot */ slotTime: AppointmentSlotTime; } /** * An appointment slot time with start and end. * @export * @interface AppointmentSlotTime */ export interface AppointmentSlotTime { /** * The end timestamp of the appointment in UTC. * @type {string} * @memberof AppointmentSlotTime */ endTime: string; /** * The start timestamp of the appointment in UTC. * @type {string} * @memberof AppointmentSlotTime */ startTime: string; } /** * Contains information about a box that is used in the inbound plan. The box is a container that holds multiple items. * @export * @interface Box */ export interface Box { /** * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. * @type {string} * @memberof Box */ boxId?: string; /** * * @type {BoxContentInformationSource} * @memberof Box */ contentInformationSource?: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; /** * * @type {Region} * @memberof Box */ destinationRegion?: Region; /** * * @type {Dimensions} * @memberof Box */ dimensions?: Dimensions; /** * Items contained within the box. * @type {Array<Item>} * @memberof Box */ items?: Array<Item>; /** * Primary key to uniquely identify a Package (Box or Pallet). * @type {string} * @memberof Box */ packageId: string; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} * @memberof Box */ quantity?: number; /** * Template name of the box. * @type {string} * @memberof Box */ templateName?: string; /** * * @type {Weight} * @memberof Box */ weight?: Weight; } /** * Indication of how box content is meant to be provided. * @export * @enum {string} */ export declare enum BoxContentInformationSource { BoxContentProvided = "BOX_CONTENT_PROVIDED", ManualProcess = "MANUAL_PROCESS", Barcode2D = "BARCODE_2D" } /** * Input information for a given box. * @export * @interface BoxInput */ export interface BoxInput { /** * * @type {BoxContentInformationSource} * @memberof BoxInput */ contentInformationSource: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; /** * * @type {Dimensions} * @memberof BoxInput */ dimensions: Dimensions; /** * The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`. * @type {Array<ItemInput>} * @memberof BoxInput */ items?: Array<ItemInput>; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} * @memberof BoxInput */ quantity: number; /** * * @type {Weight} * @memberof BoxInput */ weight: Weight; } /** * Input information for updating a box * @export * @interface BoxUpdateInput */ export interface BoxUpdateInput { /** * * @type {BoxContentInformationSource} * @memberof BoxUpdateInput */ contentInformationSource: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; /** * * @type {Dimensions} * @memberof BoxUpdateInput */ dimensions: Dimensions; /** * The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`. * @type {Array<ItemInput>} * @memberof BoxUpdateInput */ items?: Array<ItemInput>; /** * Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed * @type {string} * @memberof BoxUpdateInput */ packageId?: string; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} * @memberof BoxUpdateInput */ quantity: number; /** * * @type {Weight} * @memberof BoxUpdateInput */ weight: Weight; } /** * The `cancelInboundPlan` response. * @export * @interface CancelInboundPlanResponse */ export interface CancelInboundPlanResponse { /** * UUID for the given operation. * @type {string} * @memberof CancelInboundPlanResponse */ operationId: string; } /** * The `cancelSelfShipAppointment` request. * @export * @interface CancelSelfShipAppointmentRequest */ export interface CancelSelfShipAppointmentRequest { /** * * @type {ReasonComment} * @memberof CancelSelfShipAppointmentRequest */ reasonComment?: ReasonComment | 'APPOINTMENT_REQUESTED_BY_MISTAKE' | 'VEHICLE_DELAY' | 'SLOT_NOT_SUITABLE' | 'OUTSIDE_CARRIER_BUSINESS_HOURS' | 'UNFAVOURABLE_EXTERNAL_CONDITIONS' | 'PROCUREMENT_DELAY' | 'SHIPPING_PLAN_CHANGED' | 'INCREASED_QUANTITY' | 'OTHER'; } /** * The `CancelSelfShipAppointment` response. * @export * @interface CancelSelfShipAppointmentResponse */ export interface CancelSelfShipAppointmentResponse { /** * UUID for the given operation. * @type {string} * @memberof CancelSelfShipAppointmentResponse */ operationId: string; } /** * The carrier for the inbound shipment. * @export * @interface Carrier */ export interface Carrier { /** * The carrier code. For example, USPS or DHLEX. * @type {string} * @memberof Carrier */ alphaCode?: string; /** * The name of the carrier. * @type {string} * @memberof Carrier */ name?: string; } /** * Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up. * @export * @interface CarrierAppointment */ export interface CarrierAppointment { /** * The end timestamp of the appointment in UTC. * @type {string} * @memberof CarrierAppointment */ endTime: string; /** * The start timestamp of the appointment in UTC. * @type {string} * @memberof CarrierAppointment */ startTime: string; } /** * Contains item identifiers and related tax information. * @export * @interface ComplianceDetail */ export interface ComplianceDetail { /** * The Amazon Standard Identification Number, which identifies the detail page identifier. * @type {string} * @memberof ComplianceDetail */ asin?: string; /** * The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition. * @type {string} * @memberof ComplianceDetail */ fnsku?: string; /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof ComplianceDetail */ msku?: string; /** * * @type {TaxDetails} * @memberof ComplianceDetail */ taxDetails?: TaxDetails; } /** * The `confirmDeliveryWindowOptions` response. * @export * @interface ConfirmDeliveryWindowOptionsResponse */ export interface ConfirmDeliveryWindowOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmDeliveryWindowOptionsResponse */ operationId: string; } /** * The `confirmPackingOption` response. * @export * @interface ConfirmPackingOptionResponse */ export interface ConfirmPackingOptionResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmPackingOptionResponse */ operationId: string; } /** * The `confirmPlacementOption` response. * @export * @interface ConfirmPlacementOptionResponse */ export interface ConfirmPlacementOptionResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmPlacementOptionResponse */ operationId: string; } /** * The `confirmShipmentContentUpdatePreview` response. * @export * @interface ConfirmShipmentContentUpdatePreviewResponse */ export interface ConfirmShipmentContentUpdatePreviewResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmShipmentContentUpdatePreviewResponse */ operationId: string; } /** * The `confirmTransportationOptions` request. * @export * @interface ConfirmTransportationOptionsRequest */ export interface ConfirmTransportationOptionsRequest { /** * Information needed to confirm one of the available transportation options. * @type {Array<TransportationSelection>} * @memberof ConfirmTransportationOptionsRequest */ transportationSelections: Array<TransportationSelection>; } /** * The `confirmTransportationOptions` response. * @export * @interface ConfirmTransportationOptionsResponse */ export interface ConfirmTransportationOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmTransportationOptionsResponse */ operationId: string; } /** * The seller\'s contact information. * @export * @interface ContactInformation */ export interface ContactInformation { /** * The email address. * @type {string} * @memberof ContactInformation */ email?: string; /** * The contact\'s name. * @type {string} * @memberof ContactInformation */ name: string; /** * The phone number. * @type {string} * @memberof ContactInformation */ phoneNumber: string; } /** * Preview of the changes that will be applied to the shipment. * @export * @interface ContentUpdatePreview */ export interface ContentUpdatePreview { /** * Identifier of a content update preview. * @type {string} * @memberof ContentUpdatePreview */ contentUpdatePreviewId: string; /** * The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof ContentUpdatePreview */ expiration: string; /** * * @type {RequestedUpdates} * @memberof ContentUpdatePreview */ requestedUpdates: RequestedUpdates; /** * * @type {TransportationOption} * @memberof ContentUpdatePreview */ transportationOption: TransportationOption; } /** * The `createInboundPlan` request. * @export * @interface CreateInboundPlanRequest */ export interface CreateInboundPlanRequest { /** * Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request. * @type {Array<string>} * @memberof CreateInboundPlanRequest */ destinationMarketplaces: Array<string>; /** * Items included in this plan. * @type {Array<ItemInput>} * @memberof CreateInboundPlanRequest */ items: Array<ItemInput>; /** * Name for the Inbound Plan. If one isn\'t provided, a default name will be provided. * @type {string} * @memberof CreateInboundPlanRequest */ name?: string; /** * * @type {AddressInput} * @memberof CreateInboundPlanRequest */ sourceAddress: AddressInput; } /** * The `createInboundPlan` response. * @export * @interface CreateInboundPlanResponse */ export interface CreateInboundPlanResponse { /** * Identifier of an inbound plan. * @type {string} * @memberof CreateInboundPlanResponse */ inboundPlanId: string; /** * UUID for the given operation. * @type {string} * @memberof CreateInboundPlanResponse */ operationId: string; } /** * The `createMarketplaceItemLabels` request. * @export * @interface CreateMarketplaceItemLabelsRequest */ export interface CreateMarketplaceItemLabelsRequest { /** * The height of the item label. * @type {number} * @memberof CreateMarketplaceItemLabelsRequest */ height?: number; /** * * @type {LabelPrintType} * @memberof CreateMarketplaceItemLabelsRequest */ labelType: LabelPrintType | 'STANDARD_FORMAT' | 'THERMAL_PRINTING'; /** * The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character. * @type {string} * @memberof CreateMarketplaceItemLabelsRequest */ localeCode?: string; /** * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} * @memberof CreateMarketplaceItemLabelsRequest */ marketplaceId: string; /** * Represents the quantity of an MSKU to print item labels for. * @type {Array<MskuQuantity>} * @memberof CreateMarketplaceItemLabelsRequest */ mskuQuantities: Array<MskuQuantity>; /** * * @type {ItemLabelPageType} * @memberof CreateMarketplaceItemLabelsRequest */ pageType?: ItemLabelPageType | 'A4_21' | 'A4_24' | 'A4_24_64x33' | 'A4_24_66x35' | 'A4_24_70x36' | 'A4_24_70x37' | 'A4_24i' | 'A4_27' | 'A4_40_52x29' | 'A4_44_48x25' | 'Letter_30'; /** * The width of the item label. * @type {number} * @memberof CreateMarketplaceItemLabelsRequest */ width?: number; } /** * The `createMarketplaceItemLabels` response. * @export * @interface CreateMarketplaceItemLabelsResponse */ export interface CreateMarketplaceItemLabelsResponse { /** * Resources to download the requested document. * @type {Array<DocumentDownload>} * @memberof CreateMarketplaceItemLabelsResponse */ documentDownloads: Array<DocumentDownload>; } /** * The type and amount of currency. * @export * @interface Currency */ export interface Currency { /** * Decimal value of the currency. * @type {number} * @memberof Currency */ amount: number; /** * ISO 4217 standard of a currency code. * @type {string} * @memberof Currency */ code: string; } /** * Provide units going to the warehouse. * @export * @interface CustomPlacementInput */ export interface CustomPlacementInput { /** * Items included while creating Inbound Plan. * @type {Array<ItemInput>} * @memberof CustomPlacementInput */ items: Array<ItemInput>; /** * Warehouse Id. * @type {string} * @memberof CustomPlacementInput */ warehouseId: string; } /** * Specifies the date that the seller expects their shipment will be shipped. * @export * @interface Dates */ export interface Dates { /** * * @type {Window} * @memberof Dates */ readyToShipWindow?: Window; } /** * Contains information pertaining to a delivery window option. * @export * @interface DeliveryWindowOption */ export interface DeliveryWindowOption { /** * Identifies type of Delivery Window Availability. Values: `AVAILABLE`, `CONGESTED` * @type {string} * @memberof DeliveryWindowOption */ availabilityType: string; /** * Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered. * @type {string} * @memberof DeliveryWindowOption */ deliveryWindowOptionId: string; /** * The time at which this delivery window option ends. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`. * @type {string} * @memberof DeliveryWindowOption */ endDate: string; /** * The time at which this delivery window option starts. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`. * @type {string} * @memberof DeliveryWindowOption */ startDate: string; /** * The time at which this window delivery option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`. * @type {string} * @memberof DeliveryWindowOption */ validUntil: string; } /** * Measurement of a package\'s dimensions. * @export * @interface Dimensions */ export interface Dimensions { /** * The height of a package. * @type {number} * @memberof Dimensions */ height: number; /** * The length of a package. * @type {number} * @memberof Dimensions */ length: number; /** * * @type {UnitOfMeasurement} * @memberof Dimensions */ unitOfMeasurement: UnitOfMeasurement | 'IN' | 'CM'; /** * The width of a package. * @type {number} * @memberof Dimensions */ width: number; } /** * Resource to download the requested document. * @export * @interface DocumentDownload */ export interface DocumentDownload { /** * The type of download. Possible values: `URL`. * @type {string} * @memberof DocumentDownload */ downloadType: string; /** * The URI\'s expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof DocumentDownload */ expiration?: string; /** * Uniform resource identifier to identify where the document is located. * @type {string} * @memberof DocumentDownload */ uri: string; } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * List of errors. * @type {Array<Error>} * @memberof ErrorList */ errors: Array<Error>; } /** * Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided. * @export * @interface FreightInformation */ export interface FreightInformation { /** * * @type {Currency} * @memberof FreightInformation */ declaredValue?: Currency; /** * Freight class. Possible values: `NONE`, `FC_50`, `FC_55`, `FC_60`, `FC_65`, `FC_70`, `FC_77_5`, `FC_85`, `FC_92_5`, `FC_100`, `FC_110`, `FC_125`, `FC_150`, `FC_175`, `FC_200`, `FC_250`, `FC_300`, `FC_400`, `FC_500`. * @type {string} * @memberof FreightInformation */ freightClass?: string; } /** * The `generateDeliveryWindowOptions` response. * @export * @interface GenerateDeliveryWindowOptionsResponse */ export interface GenerateDeliveryWindowOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof GenerateDeliveryWindowOptionsResponse */ operationId: string; } /** * The `generatePackingOptions` response. * @export * @interface GeneratePackingOptionsResponse */ export interface GeneratePackingOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof GeneratePackingOptionsResponse */ operationId: string; } /** * The `generatePlacementOptions` request. * @export * @interface GeneratePlacementOptionsRequest */ export interface GeneratePlacementOptionsRequest { /** * Custom placement options you want to add to the plan. This is only used for the India (IN - A21TJRUUN4KGV) marketplace. * @type {Array<CustomPlacementInput>} * @memberof GeneratePlacementOptionsRequest */ customPlacement?: Array<CustomPlacementInput>; } /** * The `generatePlacementOptions` response. * @export * @interface GeneratePlacementOptionsResponse */ export interface GeneratePlacementOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof GeneratePlacementOptionsResponse */ operationId: string; } /** * The `generateSelfShipAppointmentSlots` request. * @export * @interface GenerateSelfShipAppointmentSlotsRequest */ export interface GenerateSelfShipAppointmentSlotsRequest { /** * The desired end date. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof GenerateSelfShipAppointmentSlotsRequest */ desiredEndDate?: string; /** * The desired start date. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof GenerateSelfShipAppointmentSlotsRequest */ desiredStartDate?: string; } /** * The `generateSelfShipAppointmentSlots` response. * @export * @interface GenerateSelfShipAppointmentSlotsResponse */ export interface GenerateSelfShipAppointmentSlotsResponse { /** * UUID for the given operation. * @type {string} * @memberof GenerateSelfShipAppointmentSlotsResponse */ operationId: string; } /** * The `GenerateShipmentContentUpdatePreviews` request. * @export * @interface GenerateShipmentContentUpdatePreviewsRequest */ export interface GenerateShipmentContentUpdatePreviewsRequest { /** * A list of boxes that will be present in the shipment after the update. * @type {Array<BoxUpdateInput>} * @memberof GenerateShipmentContentUpdatePreviewsRequest */ boxes: Array<BoxUpdateInput>; /** * A list of all items that will be present in the shipment after the update. * @type {Array<ItemInput>} * @memberof GenerateShipmentContentUpdatePreviewsRequest */ items: Array<ItemInput>; } /** * The `GenerateShipmentContentUpdatePreviews` response. * @export * @interface GenerateShipmentContentUpdatePreviewsResponse */ export interface GenerateShipmentContentUpdatePreviewsResponse { /** * UUID for the given operation. * @type {string} * @memberof GenerateShipmentContentUpdatePreviewsResponse */ operationId: string; } /** * The `generateTransportationOptions` request. * @export * @interface GenerateTransportationOptionsRequest */ export interface GenerateTransportationOptionsRequest { /** * The placement option to generate transportation options for. * @type {string} * @memberof GenerateTransportationOptionsRequest */ placementOptionId: string; /** * List of shipment transportation configurations. * @type {Array<ShipmentTransportationConfiguration>} * @memberof GenerateTransportationOptionsRequest */ shipmentTransportationConfigurations: Array<ShipmentTransportationConfiguration>; } /** * The `generateTransportationOptions` response. * @export * @interface GenerateTransportationOptionsResponse */ export interface GenerateTransportationOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof GenerateTransportationOptionsResponse */ operationId: string; } /** * The `getDeliveryChallanDocumentResponse` response. * @export * @interface GetDeliveryChallanDocumentResponse */ export interface GetDeliveryChallanDocumentResponse { /** * * @type {DocumentDownload} * @memberof GetDeliveryChallanDocumentResponse */ documentDownload: DocumentDownload; } /** * The `getSelfShipAppointmentSlots` response. * @export * @interface GetSelfShipAppointmentSlotsResponse */ export interface GetSelfShipAppointmentSlotsResponse { /** * * @type {Pagination} * @memberof GetSelfShipAppointmentSlotsResponse */ pagination?: Pagination; /** * * @type {SelfShipAppointmentSlotsAvailability} * @memberof GetSelfShipAppointmentSlotsResponse */ selfShipAppointmentSlotsAvailability: SelfShipAppointmentSlotsAvailability; } /** * GetInboundOperationStatus response. * @export * @interface InboundOperationStatus */ export interface InboundOperationStatus { /** * The name of the operation in the asynchronous API call. * @type {string} * @memberof InboundOperationStatus */ operation: string; /** * The operation ID returned by the asynchronous API call. * @type {string} * @memberof InboundOperationStatus */ operationId: string; /** * The problems in the processing of the asynchronous operation. * @type {Array<OperationProblem>} * @memberof InboundOperationStatus */ operationProblems: Array<OperationProblem>; /** * * @type {OperationStatus} * @memberof InboundOperationStatus */ operationStatus: OperationStatus | 'SUCCESS' | 'FAILED' | 'IN_PROGRESS'; } /** * Inbound plan containing details of the inbound workflow. * @export * @interface InboundPlan */ export interface InboundPlan { /** * The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlan */ createdAt: string; /** * Identifier of an inbound plan. * @type {string} * @memberof InboundPlan */ inboundPlanId: string; /** * The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlan */ lastUpdatedAt: string; /** * A list of marketplace IDs. * @type {Array<string>} * @memberof InboundPlan */ marketplaceIds: Array<string>; /** * Human-readable name of the inbound plan. * @type {string} * @memberof InboundPlan */ name: string; /** * Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details. * @type {Array<PackingOptionSummary>} * @memberof InboundPlan */ packingOptions?: Array<PackingOptionSummary>; /** * Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details. * @type {Array<PlacementOptionSummary>} * @memberof InboundPlan */ placementOptions?: Array<PlacementOptionSummary>; /** * A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details. * @type {Array<ShipmentSummary>} * @memberof InboundPlan */ shipments?: Array<ShipmentSummary>; /** * * @type {Address} * @memberof InboundPlan */ sourceAddress: Address; /** * Current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`. * @type {string} * @memberof InboundPlan */ status: string; } /** * A light-weight inbound plan. * @export * @interface InboundPlanSummary */ export interface InboundPlanSummary { /** * The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlanSummary */ createdAt: string; /** * Identifier of an inbound plan. * @type {string} * @memberof InboundPlanSummary */ inboundPlanId: string; /** * The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlanSummary */ lastUpdatedAt: string; /** * A list of marketplace IDs. * @type {Array<string>} * @memberof InboundPlanSummary */ marketplaceIds: Array<string>; /** * Human-readable name of the inbound plan. * @type {string} * @memberof InboundPlanSummary */ name: string; /** * * @type {Address} * @memberof InboundPlanSummary */ sourceAddress: Address; /** * The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`. * @type {string} * @memberof InboundPlanSummary */ status: string; } /** * Contains details about cost related modifications to the placement cost. * @export * @interface Incentive */ export interface Incentive { /** * Description of the incentive. * @type {string} * @memberof Incentive */ description: string; /** * Target of the incentive. Possible values: \'Placement Services\', \'Fulfillment Fee Discount\'. * @type {string} * @memberof Incentive */ target: string; /** * Type of incentive. Possible values: `FEE`, `DISCOUNT`. * @type {string} * @memberof Incentive */ type: string; /** * * @type {Currency} * @memberof Incentive */ value: Currency; } /** * Information associated with a single SKU in the seller\'s catalog. * @export * @interface Item */ export interface Item { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof Item */ asin: string; /** * The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box. * @type {string} * @memberof Item */ expiration?: string; /** * A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. * @type {string} * @memberof Item */ fnsku: string; /** * Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. * @type {string} * @memberof Item */ labelOwner: string; /** * The manufacturing lot code. * @type {string} * @memberof Item */ manufacturingLotCode?: string; /** * The merchant SKU, a merchant-supplied identifier of a specific SKU. * @type {string} * @memberof Item */ msku: string; /** * Special preparations that are required for an item. * @type {Array<PrepInstruction>} * @memberof Item */ prepInstructions: Array<PrepInstruction>; /** * The number of the specified MSKU. * @type {number} * @memberof Item */ quantity: number; } /** * Defines an item\'s input parameters. * @export * @interface ItemInput */ export interface ItemInput { /** * The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box. * @type {string} * @memberof ItemInput */ expiration?: string; /** * * @type {LabelOwner} * @memberof ItemInput */ labelOwner: LabelOwner | 'AMAZON' | 'SELLER' | 'NONE'; /** * The manufacturing lot code. * @type {string} * @memberof ItemInput */ manufacturingLotCode?: string; /** * The merchant SKU, a merchant-supplied identifier of a specific SKU. * @type {string} * @memberof ItemInput */ msku: string; /** * * @type {PrepOwner} * @memberof ItemInput */ prepOwner: PrepOwner | 'AMAZON' | 'SELLER' | 'NONE'; /** * The number of units of the specified MSKU that will be shipped. * @type {number} * @memberof ItemInput */ quantity: number; } /** * The page type to use to print the labels. Possible values: \'A4_21\', \'A4_24\', \'A4_24_64x33\', \'A4_24_66x35\', \'A4_24_70x36\', \'A4_24_70x37\', \'A4_24i\', \'A4_27\', \'A4_40_52x29\', \'A4_44_48x25\', \'Letter_30\'. * @export * @enum {string} */ export declare enum ItemLabelPageType { A421 = "A4_21", A424 = "A4_24", A42464x33 = "A4_24_64x33", A42466x35 = "A4_24_66x35", A42470x36 = "A4_24_70x36", A42470x37 = "A4_24_70x37", A424i = "A4_24i", A427 = "A4_27", A44052x29 = "A4_40_52x29", A44448x25 = "A4_44_48x25", Letter30 = "Letter_30" } /** * Specifies who will label the items. Options include `AMAZON`, `SELLER` or `NONE`. * @export * @enum {string} */ export declare enum LabelOwner { Amazon = "AMAZON", Seller = "SELLER", None = "NONE" } /** * Indicates the type of print type for a given label. * @export * @enum {string} */ export declare enum LabelPrintType { StandardFormat = "STANDARD_FORMAT", ThermalPrinting = "THERMAL_PRINTING" } /** * The `listDeliveryWindowOptions` response. * @export * @interface ListDeliveryWindowOptionsResponse */ export interface ListDeliveryWindowOptionsResponse { /** * Delivery window options generated for the placement option. * @type {Array<DeliveryWindowOption>} * @memberof ListDeliveryWindowOptionsResponse */ deliveryWindowOptions: Array<DeliveryWindowOption>; /** * * @type {Pagination} * @memberof ListDeliveryWindowOptionsResponse */ pagination?: Pagination; } /** * The `listInboundPlanBoxes` response. * @export * @interface ListInboundPlanBoxesResponse */ export interface ListInboundPlanBoxesResponse { /** * A list of boxes in an inbound plan. * @type {Array<Box>} * @memberof ListInboundPlanBoxesResponse */ boxes: Array<Box>; /** * * @type {Pagination} * @memberof ListInboundPlanBoxesResponse */ pagination?: Pagination; } /** * The `listInboundPlanItems` response. * @export * @interface ListInboundPlanItemsResponse */ export interface ListInboundPlanItemsResponse { /** * The items in an inbound plan. * @type {Array<Item>} * @memberof ListInboundPlanItemsResponse */ items: Array<Item>; /** * * @type {Pagination} * @memberof ListInboundPlanItemsResponse */ pagination?: Pagination; } /** * The `listInboundPlanPallets` response. * @export * @interface ListInboundPlanPalletsResponse */ export interface ListInboundPlanPalletsResponse { /** * * @type {Pagination} * @memberof ListInboundPlanPalletsResponse */ pagination?: Pagination; /** * The pallets in an inbound plan. * @type {Array<Pallet>} * @memberof ListInboundPlanPalletsResponse */ pallets: Array<Pallet>; } /** * The `listInboundPlans` response. * @export * @interface ListInboundPlansResponse */ export interface ListInboundPlansResponse { /** * A list of inbound plans with minimal information. * @type {Array<InboundPlanSummary>} * @memberof ListInboundPlansResponse */ inboundPlans?: Array<InboundPlanSummary>; /** * * @type {Pagination} * @memberof ListInboundPlansResponse */ pagination?: Pagination; } /** * The `listItemComplianceDetails` response. * @export * @interface ListItemComplianceDetailsResponse */ export interface ListItemComplianceDetailsResponse { /** * List of compliance details. * @type {Array<ComplianceDetail>} * @memberof ListItemComplianceDetailsResponse */ complianceDetails?: Array<ComplianceDetail>; } /** * The `listPackingGroupBoxes` response. * @export * @interface ListPackingGroupBoxesResponse */ export interface ListPackingGroupBoxesResponse { /** * Provides the information about the list of boxes in the packing group. * @type {Array<Box>} * @memberof ListPackingGroupBoxesResponse */ boxes: Array<Box>; /** * * @type {Pagination} * @memberof ListPackingGroupBoxesResponse */ pagination?: Pagination; } /** * The `listPackingGroupItems` response. * @export * @interface ListPackingGroupItemsResponse */ export interface ListPackingGroupItemsResponse { /** * Provides the information about the list of items in the packing group. * @type {Array<Item>} * @memberof ListPackingGroupItemsResponse */ items: Array<Item>; /** * * @type {Pagination} * @memberof ListPackingGroupItemsResponse */ pagination?: Pagination; } /** * The `listPlacementOptions` response. * @export * @interface ListPackingOptionsResponse */ export interface ListPackingOptionsResponse { /** * List of packing options. * @type {Array<PackingOption>} * @memberof ListPackingOptionsResponse */ packingOptions: Array<PackingOption>; /** * * @type {Pagination} * @memberof ListPackingOptionsResponse */ pagination?: Pagination; } /** * The `listPlacementOptions` response. * @export * @interface ListPlacementOptionsResponse */ export interface ListPlacementOptionsResponse { /** * * @type {Pagination} * @memberof ListPlacementOptionsResponse */ pagination?: Pagination; /** * Placement options generated for the inbound plan. * @type {Array<PlacementOption>} * @memberof ListPlacementOptionsResponse */ placementOptions: Array<PlacementOption>; } /** * The response to the `listPrepDetails` operation. * @export * @interface ListPrepDetailsResponse */ export interface ListPrepDetailsResponse { /** * A list of MSKUs and related prep details. * @type {Array<MskuPrepDetail>} * @memberof ListPrepDetailsResponse */ mskuPrepDetails: Array<MskuPrepDetail>; } /** * The `listShipmentBoxes` response. * @export * @interface ListShipmentBoxesResponse */ export interface ListShipmentBoxesResponse { /** * A list of boxes in a shipment. * @type {Array<Box>} * @memberof ListShipmentBoxesResponse */ boxes: Array<Box>; /** * * @type {Pagination} * @memberof ListShipmentBoxesResponse */ pagination?: Pagination; } /** * The `ListShipmentContentUpdatePreviews` response. * @export * @interface ListShipmentContentUpdatePreviewsResponse */ export interface ListShipmentContentUpdatePreviewsResponse { /** * A list of content update previews in a shipment. * @type {Array<ContentUpdatePreview>} * @memberof ListShipmentContentUpdatePreviewsResponse */ contentUpdatePreviews: Array<ContentUpdatePreview>; /** * * @type {Pagination} * @memberof ListShipmentContentUpdatePreviewsResponse */ pagination?: Pagination; } /** * The `listShipmentItems` response. * @export * @interface ListShipmentItemsResponse */ export interface ListShipmentItemsResponse { /** * The items in a shipment. * @type {Array<Item>} * @memberof ListShipmentItemsResponse */ items: Array<Item>; /** * * @type {Pagination} * @memberof ListShipmentItemsResponse */ pagination?: Pagination; } /** * The `listShipmentPallets` response. * @export * @interface ListShipmentPalletsResponse */ export interface ListShipmentPalletsResponse { /** * * @type {Pagination} * @memberof ListShipmentPalletsResponse */ pagination?: Pagination; /** * The pallets in a shipment. * @type {Array<Pallet>} * @memberof ListShipmentPalletsResponse */ pallets: Array<Pallet>; } /** * The `listTransportationOptions` response. * @export * @interface ListTransportationOptionsResponse */ export interface ListTransportationOptionsResponse { /** * * @type {Pagination} * @memberof ListTransportationOptionsResponse */ pagination?: Pagination; /** * Transportation options generated for the placement option. * @type {Array<TransportationOption>} * @memberof ListTransportationOptionsResponse */ transportationOptions: Array<TransportationOption>; } /** * Contains information related to Less-Than-Truckload (LTL) shipment tracking. * @export * @interface LtlTrackingDetail */ export interface LtlTrackingDetail { /** * The number of the carrier shipment acknowledgement document. * @type {string} * @memberof LtlTrackingDetail */ billOfLadingNumber?: string; /** * The number associated with the freight bill. * @type {Array<string>} * @memberof LtlTrackingDetail */ freightBillNumber?: Array<string>; } /** * Contains input information to update Less-Than-Truckload (LTL) tracking information. * @export * @interface LtlTrackingDetailInput */ export interface LtlTrackingDetailInput { /** * The number of the carrier shipment acknowledgement document. * @type {string} * @memberof LtlTrackingDetailInput */ billOfLadingNumber?: string; /** * Number associated with the freight bill. * @type {Array<string>} * @memberof LtlTrackingDetailInput */ freightBillNumber: Array<string>; } /** * Error object containing information about what went wrong. * @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; } /** * An MSKU and its related prep details. * @export * @interface MskuPrepDetail */ export interface MskuPrepDetail { /** * * @type {AllOwnersConstraint} * @memberof MskuPrepDetail */ allOwnersConstraint?: AllOwnersConstraint | 'MUST_MATCH'; /** * * @type {OwnerConstraint} * @memberof MskuPrepDetail */ labelOwnerConstraint?: OwnerConstraint | 'AMAZON_ONLY' | 'NONE_ONLY' | 'SELLER_ONLY'; /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof MskuPrepDetail */ msku: string; /** * * @type {PrepCategory} * @memberof MskuPrepDetail */ prepCategory: PrepCategory | 'ADULT' | 'BABY' | 'FC_PROVIDED' | 'FRAGILE' | 'GRANULAR' | 'HANGER' | 'LIQUID' | 'PERFORATED' | 'SET' | 'SHARP' | 'SMALL' | 'TEXTILE' | 'UNKNOWN' | 'NONE'; /** * * @type {OwnerConstraint} * @memberof MskuPrepDetail */ prepOwnerConstraint?: OwnerConstraint | 'AMAZON_ONLY' | 'NONE_ONLY' | 'SELLER_ONLY'; /** * A list of preparation types associated with a preparation category. * @type {Array<PrepType>} * @memberof MskuPrepDetail */ prepTypes: Array<(PrepType | 'ITEM_BLACK_SHRINKWRAP' | 'ITEM_BLANKSTK' | 'ITEM_BOXING' | 'ITEM_BUBBLEWRAP' | 'ITEM_CAP_SEALING' | 'ITEM_DEBUNDLE' | 'ITEM_HANG_GARMENT' | 'ITEM_LABELING' | 'ITEM_NO_PREP' | 'ITEM_POLYBAGGING' | 'ITEM_RMOVHANG' | 'ITEM_SETCREAT' | 'ITEM_SETSTK' | 'ITEM_SIOC' | 'ITEM_SUFFOSTK' | 'ITEM_TAPING')>; } /** * An MSKU and its related prep details. * @export * @interface MskuPrepDetailInput */ export interface MskuPrepDetailInput { /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof MskuPrepDetailInput */ msku: string; /** * * @type {PrepCategory} * @memberof MskuPrepDetailInput */ prepCategory: PrepCategory | 'ADULT' | 'BABY' | 'FC_PROVIDED' | 'FRAGILE' | 'GRANULAR' | 'HANGER' | 'LIQUID' | 'PERFORATED' | 'SET' | 'SHARP' | 'SMALL' | 'TEXTILE' | 'UNKNOWN' | 'NONE'; /** * A list of preparation types associated with a preparation category. * @type {Array<PrepType>} * @memberof MskuPrepDetailInput */ prepTypes: Array<(PrepType | 'ITEM_BLACK_SHRINKWRAP' | 'ITEM_BLANKSTK' | 'ITEM_BOXING' | 'ITEM_BUBBLEWRAP' | 'ITEM_CAP_SEALING' | 'ITEM_DEBUNDLE' | 'ITEM_HANG_GARMENT' | 'ITEM_LABELING' | 'ITEM_NO_PREP' | 'ITEM_POLYBAGGING' | 'ITEM_RMOVHANG' | 'ITEM_SETCREAT' | 'ITEM_SETSTK' | 'ITEM_SIOC' | 'ITEM_SUFFOSTK' | 'ITEM_TAPING')>; } /** * Represents an MSKU and the related quantity. * @export * @interface MskuQuantity */ export interface MskuQuantity { /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof MskuQuantity */ msku: string; /** * A positive integer. * @type {number} * @memberof MskuQuantity */ quantity: number; } /** * A problem with additional properties persisted to an operation. * @export * @interface OperationProblem */ export interface OperationProblem { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof OperationProblem */ code: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof Operation