@sp-api-sdk/fulfillment-inbound-api-2024-03-20
Version:
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 inte
117 lines (116 loc) • 3.92 kB
TypeScript
/**
* 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 type { ContactInformation } from './contact-information';
import type { Dates } from './dates';
import type { FreightInformation } from './freight-information';
import type { SelectedDeliveryWindow } from './selected-delivery-window';
import type { SelfShipAppointmentDetails } from './self-ship-appointment-details';
import type { ShipmentDestination } from './shipment-destination';
import type { ShipmentSource } from './shipment-source';
import type { TrackingDetails } from './tracking-details';
/**
* Contains information pertaining to a shipment in an inbound plan.
* @export
* @interface Shipment
*/
export interface Shipment {
/**
* A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.
* @type {string}
* @memberof Shipment
*/
'amazonReferenceId'?: string;
/**
*
* @type {ContactInformation}
* @memberof Shipment
*/
'contactInformation'?: ContactInformation;
/**
*
* @type {Dates}
* @memberof Shipment
*/
'dates'?: Dates;
/**
*
* @type {ShipmentDestination}
* @memberof Shipment
*/
'destination': ShipmentDestination;
/**
*
* @type {FreightInformation}
* @memberof Shipment
*/
'freightInformation'?: FreightInformation;
/**
* The name of the shipment.
* @type {string}
* @memberof Shipment
*/
'name'?: string;
/**
* The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
* @type {string}
* @memberof Shipment
*/
'placementOptionId': string;
/**
*
* @type {SelectedDeliveryWindow}
* @memberof Shipment
*/
'selectedDeliveryWindow'?: SelectedDeliveryWindow;
/**
* Identifier of a transportation option. A transportation option represent one option for how to send a shipment.
* @type {string}
* @memberof Shipment
*/
'selectedTransportationOptionId'?: string;
/**
* List of self ship appointment details.
* @type {Array<SelfShipAppointmentDetails>}
* @memberof Shipment
*/
'selfShipAppointmentDetails'?: Array<SelfShipAppointmentDetails>;
/**
* The confirmed shipment ID which shows up on labels (for example, `FBA1234ABCD`).
* @type {string}
* @memberof Shipment
*/
'shipmentConfirmationId'?: string;
/**
* Identifier of a shipment. A shipment contains the boxes and units being inbounded.
* @type {string}
* @memberof Shipment
*/
'shipmentId': string;
/**
*
* @type {ShipmentSource}
* @memberof Shipment
*/
'source': ShipmentSource;
/**
* The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`
* @type {string}
* @memberof Shipment
*/
'status'?: string;
/**
*
* @type {TrackingDetails}
* @memberof Shipment
*/
'trackingDetails'?: TrackingDetails;
}