@sp-api-sdk/fulfillment-inbound-api-2024-03-20 1.0.1

package/dist/types/src/api-model/models/placement-option-summary.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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.
+ */
+/**
+ * Summary information about a placement option.
+ * @export
+ * @interface PlacementOptionSummary
+ */
+export interface PlacementOptionSummary {
+    /**
+     * Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
+     * @type {string}
+     * @memberof PlacementOptionSummary
+     */
+    'placementOptionId': string;
+    /**
+     * The status of a placement option. Can be `OFFERED` or `ACCEPTED`.
+     * @type {string}
+     * @memberof PlacementOptionSummary
+     */
+    'status': string;
+}

package/dist/types/src/api-model/models/placement-option.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { Incentive } from './incentive';
+/**
+ * Contains information pertaining to the placement of the contents of an inbound plan and the related costs.
+ * @export
+ * @interface PlacementOption
+ */
+export interface PlacementOption {
+    /**
+     * Discount for the offered option.
+     * @type {Array<Incentive>}
+     * @memberof PlacementOption
+     */
+    'discounts': Array<Incentive>;
+    /**
+     * The expiration date of the placement option. This is in ISO 8601 datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof PlacementOption
+     */
+    'expiration'?: string;
+    /**
+     * Fee for the offered option.
+     * @type {Array<Incentive>}
+     * @memberof PlacementOption
+     */
+    'fees': Array<Incentive>;
+    /**
+     * Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
+     * @type {string}
+     * @memberof PlacementOption
+     */
+    'placementOptionId': string;
+    /**
+     * Shipment ids.
+     * @type {Array<string>}
+     * @memberof PlacementOption
+     */
+    'shipmentIds': Array<string>;
+    /**
+     * The status of a placement option. Can be `OFFERED`, `ACCEPTED`, or `EXPIRED`.
+     * @type {string}
+     * @memberof PlacementOption
+     */
+    'status': string;
+}

package/dist/types/src/api-model/models/prep-instruction.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { Currency } from './currency';
+/**
+ * Information pertaining to the preparation of inbound goods.
+ * @export
+ * @interface PrepInstruction
+ */
+export interface PrepInstruction {
+    /**
+     *
+     * @type {Currency}
+     * @memberof PrepInstruction
+     */
+    'fee'?: Currency;
+    /**
+     * In some situations, special preparations are required for items and this field reflects the owner of the         preparations. Options include `AMAZON` or `SELLER`.
+     * @type {string}
+     * @memberof PrepInstruction
+     */
+    'prepOwner'?: string;
+    /**
+     * Type of preparation that should be done. Can be `ITEM_LABELING`, `ITEM_BUBBLEWRAP`, `ITEM_POLYBAGGING`, `ITEM_TAPING`, `ITEM_BLACK_SHRINKWRAP`, `ITEM_HANG_GARMENT`, `ITEM_BOXING`, `ITEM_SETCREAT`, `ITEM_RMOVHANG`, `ITEM_SUFFOSTK`, `ITEM_CAP_SEALING`, `ITEM_DEBUNDLE`, `ITEM_SETSTK`, `ITEM_SIOC`, `ITEM_NO_PREP`, `ADULT`, `BABY`, `TEXTILE`, `HANGER`, `FRAGILE`, `LIQUID`, `SHARP`, `SMALL`, `PERFORATED`, `GRANULAR`, `SET`, `FC_PROVIDED`, `UNKNOWN`, or `NONE`.
+     * @type {string}
+     * @memberof PrepInstruction
+     */
+    'prepType'?: string;
+}

package/dist/types/src/api-model/models/prep-owner.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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.
+ */
+/**
+ * In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON` or `SELLER`.
+ * @export
+ * @enum {string}
+ */
+export declare const PrepOwner: {
+    readonly Amazon: "AMAZON";
+    readonly Seller: "SELLER";
+};
+export type PrepOwner = typeof PrepOwner[keyof typeof PrepOwner];

package/dist/types/src/api-model/models/quote.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { Currency } from './currency';
+/**
+ * The estimated shipping cost associated with the transportation option.
+ * @export
+ * @interface Quote
+ */
+export interface Quote {
+    /**
+     *
+     * @type {Currency}
+     * @memberof Quote
+     */
+    'cost': Currency;
+    /**
+     * The timestamp at which this transportation option quote becomes no longer valid. This is in ISO 8601 datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof Quote
+     */
+    'expiration'?: string;
+    /**
+     * Voidable until timestamp.
+     * @type {string}
+     * @memberof Quote
+     */
+    'voidableUntil'?: string;
+}

package/dist/types/src/api-model/models/reason-comment.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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.
+ */
+/**
+ * Reason for cancelling or rescheduling a self-ship appointment.
+ * @export
+ * @enum {string}
+ */
+export declare const ReasonComment: {
+    readonly AppointmentRequestedByMistake: "APPOINTMENT_REQUESTED_BY_MISTAKE";
+    readonly VehicleDelay: "VEHICLE_DELAY";
+    readonly SlotNotSuitable: "SLOT_NOT_SUITABLE";
+    readonly OutsideCarrierBusinessHours: "OUTSIDE_CARRIER_BUSINESS_HOURS";
+    readonly UnfavourableExternalConditions: "UNFAVOURABLE_EXTERNAL_CONDITIONS";
+    readonly ProcurementDelay: "PROCUREMENT_DELAY";
+    readonly ShippingPlanChanged: "SHIPPING_PLAN_CHANGED";
+    readonly IncreasedQuantity: "INCREASED_QUANTITY";
+    readonly Other: "OTHER";
+};
+export type ReasonComment = typeof ReasonComment[keyof typeof ReasonComment];

package/dist/types/src/api-model/models/region.d.ts

@@ -0,0 +1,36 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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.
+ */
+/**
+ * Representation of a location used within the inbounding experience.
+ * @export
+ * @interface Region
+ */
+export interface Region {
+    /**
+     * ISO 3166 standard alpha-2 country code.
+     * @type {string}
+     * @memberof Region
+     */
+    'countryCode'?: string;
+    /**
+     * State.
+     * @type {string}
+     * @memberof Region
+     */
+    'state'?: string;
+    /**
+     * An identifier for a warehouse, such as a FC, IXD, upstream storage.
+     * @type {string}
+     * @memberof Region
+     */
+    'warehouseId'?: string;
+}

package/dist/types/src/api-model/models/schedule-self-ship-appointment-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { ReasonComment } from './reason-comment';
+/**
+ * `scheduleSelfShipAppointment` request.
+ * @export
+ * @interface ScheduleSelfShipAppointmentRequest
+ */
+export interface ScheduleSelfShipAppointmentRequest {
+    /**
+     *
+     * @type {ReasonComment}
+     * @memberof ScheduleSelfShipAppointmentRequest
+     */
+    'reasonComment'?: ReasonComment;
+}

package/dist/types/src/api-model/models/schedule-self-ship-appointment-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { SelfShipAppointmentDetails } from './self-ship-appointment-details';
+/**
+ * `scheduleSelfShipAppointment` response.
+ * @export
+ * @interface ScheduleSelfShipAppointmentResponse
+ */
+export interface ScheduleSelfShipAppointmentResponse {
+    /**
+     *
+     * @type {SelfShipAppointmentDetails}
+     * @memberof ScheduleSelfShipAppointmentResponse
+     */
+    'selfShipAppointmentDetails': SelfShipAppointmentDetails;
+}

package/dist/types/src/api-model/models/self-ship-appointment-details.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { AppointmentSlotTime } from './appointment-slot-time';
+/**
+ * Appointment details for carrier pickup or fulfillment center appointments.
+ * @export
+ * @interface SelfShipAppointmentDetails
+ */
+export interface SelfShipAppointmentDetails {
+    /**
+     * Identifier for appointment.
+     * @type {number}
+     * @memberof SelfShipAppointmentDetails
+     */
+    'appointmentId'?: number;
+    /**
+     *
+     * @type {AppointmentSlotTime}
+     * @memberof SelfShipAppointmentDetails
+     */
+    'appointmentSlotTime'?: AppointmentSlotTime;
+    /**
+     * Status of the appointment.
+     * @type {string}
+     * @memberof SelfShipAppointmentDetails
+     */
+    'appointmentStatus'?: string;
+}

package/dist/types/src/api-model/models/self-ship-appointment-slots-availability.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { AppointmentSlot } from './appointment-slot';
+/**
+ * The self ship appointment time slots availability and an expiration date for which the slots can be scheduled.
+ * @export
+ * @interface SelfShipAppointmentSlotsAvailability
+ */
+export interface SelfShipAppointmentSlotsAvailability {
+    /**
+     * ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof SelfShipAppointmentSlotsAvailability
+     */
+    'expiresAt'?: string;
+    /**
+     * List of appointment slots.
+     * @type {Array<AppointmentSlot>}
+     * @memberof SelfShipAppointmentSlotsAvailability
+     */
+    'slots'?: Array<AppointmentSlot>;
+}

package/dist/types/src/api-model/models/set-packing-information-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { PackageGroupingInput } from './package-grouping-input';
+/**
+ * `setPackingInformation` request.
+ * @export
+ * @interface SetPackingInformationRequest
+ */
+export interface SetPackingInformationRequest {
+    /**
+     * List of packing information for the inbound plan.
+     * @type {Array<PackageGroupingInput>}
+     * @memberof SetPackingInformationRequest
+     */
+    'packageGroupings'?: Array<PackageGroupingInput>;
+}

package/dist/types/src/api-model/models/set-packing-information-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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.
+ */
+/**
+ * `setPackingInformation` response.
+ * @export
+ * @interface SetPackingInformationResponse
+ */
+export interface SetPackingInformationResponse {
+    /**
+     * UUID for the given operation.
+     * @type {string}
+     * @memberof SetPackingInformationResponse
+     */
+    'operationId': string;
+}

package/dist/types/src/api-model/models/shipment-destination.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { Address } from './address';
+/**
+ * The Amazon fulfillment center address and warehouse ID.
+ * @export
+ * @interface ShipmentDestination
+ */
+export interface ShipmentDestination {
+    /**
+     *
+     * @type {Address}
+     * @memberof ShipmentDestination
+     */
+    'address'?: Address;
+    /**
+     * The type of destination for this shipment. Can be `AMAZON_OPTIMIZED`, or `AMAZON_WAREHOUSE`.
+     * @type {string}
+     * @memberof ShipmentDestination
+     */
+    'destinationType': string;
+    /**
+     * The warehouse that the shipment should be sent to.  Empty if the destination type is `AMAZON_OPTIMIZED`.
+     * @type {string}
+     * @memberof ShipmentDestination
+     */
+    'warehouseId'?: string;
+}

package/dist/types/src/api-model/models/shipment-source.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { Address } from './address';
+/**
+ * Specifies the \'ship from\' address for the shipment.
+ * @export
+ * @interface ShipmentSource
+ */
+export interface ShipmentSource {
+    /**
+     *
+     * @type {Address}
+     * @memberof ShipmentSource
+     */
+    'address'?: Address;
+    /**
+     * The type of source for this shipment. Can be `SELLER_FACILITY`.
+     * @type {string}
+     * @memberof ShipmentSource
+     */
+    'sourceType': string;
+}

package/dist/types/src/api-model/models/shipment-summary.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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.
+ */
+/**
+ * Summary information about a shipment.
+ * @export
+ * @interface ShipmentSummary
+ */
+export interface ShipmentSummary {
+    /**
+     * Identifier to a shipment. A shipment contains the boxes and units being inbounded.
+     * @type {string}
+     * @memberof ShipmentSummary
+     */
+    'shipmentId': string;
+    /**
+     * The status of a shipment. The state of the shipment will typically start in `WORKING` and transition to `READY_TO_SHIP` once required actions are complete prior to being picked up or shipped out. Can be `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, or `WORKING`.
+     * @type {string}
+     * @memberof ShipmentSummary
+     */
+    'status': string;
+}

package/dist/types/src/api-model/models/shipment-transportation-configuration.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * 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 { ContactInformation } from './contact-information';
+import { PalletInformation } from './pallet-information';
+import { WindowInput } from './window-input';
+/**
+ * Details needed to generate the transportation options.
+ * @export
+ * @interface ShipmentTransportationConfiguration
+ */
+export interface ShipmentTransportationConfiguration {
+    /**
+     *
+     * @type {ContactInformation}
+     * @memberof ShipmentTransportationConfiguration
+     */
+    'contactInformation'?: ContactInformation;
+    /**
+     *
+     * @type {PalletInformation}
+     * @memberof ShipmentTransportationConfiguration
+     */
+    'palletInformation'?: PalletInformation;
+    /**
+     *
+     * @type {WindowInput}
+     * @memberof ShipmentTransportationConfiguration
+     */
+    'readyToShipWindow': WindowInput;
+    /**
+     * Identifier to a shipment. A shipment contains the boxes and units being inbounded.
+     * @type {string}
+     * @memberof ShipmentTransportationConfiguration
+     */
+    'shipmentId': string;
+}