Class InboundShipment
- java.lang.Object
-
- software.amazon.spapi.models.awd.v2024_05_09.InboundShipment
-
public class InboundShipment extends java.lang.Object
Represents an AWD inbound shipment.
-
-
Constructor Summary
Constructors Constructor Description InboundShipment()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InboundShipment
addReceivedQuantityItem(InventoryQuantity receivedQuantityItem)
InboundShipment
addShipmentContainerQuantitiesItem(DistributionPackageQuantity shipmentContainerQuantitiesItem)
InboundShipment
addShipmentSkuQuantitiesItem(SkuQuantity shipmentSkuQuantitiesItem)
InboundShipment
carrierCode(CarrierCode carrierCode)
InboundShipment
createdAt(org.threeten.bp.OffsetDateTime createdAt)
InboundShipment
destinationAddress(Address destinationAddress)
InboundShipment
destinationRegion(java.lang.String destinationRegion)
boolean
equals(java.lang.Object o)
InboundShipment
externalReferenceId(java.lang.String externalReferenceId)
CarrierCode
getCarrierCode()
Get carrierCodeorg.threeten.bp.OffsetDateTime
getCreatedAt()
Timestamp when the shipment was created.Address
getDestinationAddress()
Get destinationAddressjava.lang.String
getDestinationRegion()
Assigned region where the order will be shipped.java.lang.String
getExternalReferenceId()
Client-provided reference ID that can correlate this shipment to client resources.java.lang.String
getOrderId()
The AWD inbound order ID that this inbound shipment belongs to.Address
getOriginAddress()
Get originAddressjava.util.List<InventoryQuantity>
getReceivedQuantity()
Quantity received (at the receiving end) as part of this shipment.org.threeten.bp.OffsetDateTime
getShipBy()
Timestamp when the shipment will be shipped.java.util.List<DistributionPackageQuantity>
getShipmentContainerQuantities()
Packages that are part of this shipment.java.lang.String
getShipmentId()
Unique shipment ID.java.util.List<SkuQuantity>
getShipmentSkuQuantities()
Quantity details at SKU level for the shipment.InboundShipmentStatus
getShipmentStatus()
Get shipmentStatusjava.lang.String
getTrackingId()
Carrier-unique tracking ID for this shipment.org.threeten.bp.OffsetDateTime
getUpdatedAt()
Timestamp when the shipment was updated.java.lang.String
getWarehouseReferenceId()
An AWD-provided reference ID that you can use to interact with the warehouse.int
hashCode()
InboundShipment
orderId(java.lang.String orderId)
InboundShipment
originAddress(Address originAddress)
InboundShipment
receivedQuantity(java.util.List<InventoryQuantity> receivedQuantity)
void
setCarrierCode(CarrierCode carrierCode)
void
setCreatedAt(org.threeten.bp.OffsetDateTime createdAt)
void
setDestinationAddress(Address destinationAddress)
void
setDestinationRegion(java.lang.String destinationRegion)
void
setExternalReferenceId(java.lang.String externalReferenceId)
void
setOrderId(java.lang.String orderId)
void
setOriginAddress(Address originAddress)
void
setReceivedQuantity(java.util.List<InventoryQuantity> receivedQuantity)
void
setShipBy(org.threeten.bp.OffsetDateTime shipBy)
void
setShipmentContainerQuantities(java.util.List<DistributionPackageQuantity> shipmentContainerQuantities)
void
setShipmentId(java.lang.String shipmentId)
void
setShipmentSkuQuantities(java.util.List<SkuQuantity> shipmentSkuQuantities)
void
setShipmentStatus(InboundShipmentStatus shipmentStatus)
void
setTrackingId(java.lang.String trackingId)
void
setUpdatedAt(org.threeten.bp.OffsetDateTime updatedAt)
void
setWarehouseReferenceId(java.lang.String warehouseReferenceId)
InboundShipment
shipBy(org.threeten.bp.OffsetDateTime shipBy)
InboundShipment
shipmentContainerQuantities(java.util.List<DistributionPackageQuantity> shipmentContainerQuantities)
InboundShipment
shipmentId(java.lang.String shipmentId)
InboundShipment
shipmentSkuQuantities(java.util.List<SkuQuantity> shipmentSkuQuantities)
InboundShipment
shipmentStatus(InboundShipmentStatus shipmentStatus)
java.lang.String
toString()
InboundShipment
trackingId(java.lang.String trackingId)
InboundShipment
updatedAt(org.threeten.bp.OffsetDateTime updatedAt)
InboundShipment
warehouseReferenceId(java.lang.String warehouseReferenceId)
-
-
-
Method Detail
-
carrierCode
public InboundShipment carrierCode(CarrierCode carrierCode)
-
getCarrierCode
public CarrierCode getCarrierCode()
Get carrierCode- Returns:
- carrierCode
-
setCarrierCode
public void setCarrierCode(CarrierCode carrierCode)
-
createdAt
public InboundShipment createdAt(org.threeten.bp.OffsetDateTime createdAt)
-
getCreatedAt
public org.threeten.bp.OffsetDateTime getCreatedAt()
Timestamp when the shipment was created. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.- Returns:
- createdAt
-
setCreatedAt
public void setCreatedAt(org.threeten.bp.OffsetDateTime createdAt)
-
destinationAddress
public InboundShipment destinationAddress(Address destinationAddress)
-
getDestinationAddress
public Address getDestinationAddress()
Get destinationAddress- Returns:
- destinationAddress
-
setDestinationAddress
public void setDestinationAddress(Address destinationAddress)
-
externalReferenceId
public InboundShipment externalReferenceId(java.lang.String externalReferenceId)
-
getExternalReferenceId
public java.lang.String getExternalReferenceId()
Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.- Returns:
- externalReferenceId
-
setExternalReferenceId
public void setExternalReferenceId(java.lang.String externalReferenceId)
-
orderId
public InboundShipment orderId(java.lang.String orderId)
-
getOrderId
public java.lang.String getOrderId()
The AWD inbound order ID that this inbound shipment belongs to.- Returns:
- orderId
-
setOrderId
public void setOrderId(java.lang.String orderId)
-
originAddress
public InboundShipment originAddress(Address originAddress)
-
getOriginAddress
public Address getOriginAddress()
Get originAddress- Returns:
- originAddress
-
setOriginAddress
public void setOriginAddress(Address originAddress)
-
receivedQuantity
public InboundShipment receivedQuantity(java.util.List<InventoryQuantity> receivedQuantity)
-
addReceivedQuantityItem
public InboundShipment addReceivedQuantityItem(InventoryQuantity receivedQuantityItem)
-
getReceivedQuantity
public java.util.List<InventoryQuantity> getReceivedQuantity()
Quantity received (at the receiving end) as part of this shipment.- Returns:
- receivedQuantity
-
setReceivedQuantity
public void setReceivedQuantity(java.util.List<InventoryQuantity> receivedQuantity)
-
shipBy
public InboundShipment shipBy(org.threeten.bp.OffsetDateTime shipBy)
-
getShipBy
public org.threeten.bp.OffsetDateTime getShipBy()
Timestamp when the shipment will be shipped.- Returns:
- shipBy
-
setShipBy
public void setShipBy(org.threeten.bp.OffsetDateTime shipBy)
-
shipmentContainerQuantities
public InboundShipment shipmentContainerQuantities(java.util.List<DistributionPackageQuantity> shipmentContainerQuantities)
-
addShipmentContainerQuantitiesItem
public InboundShipment addShipmentContainerQuantitiesItem(DistributionPackageQuantity shipmentContainerQuantitiesItem)
-
getShipmentContainerQuantities
public java.util.List<DistributionPackageQuantity> getShipmentContainerQuantities()
Packages that are part of this shipment.- Returns:
- shipmentContainerQuantities
-
setShipmentContainerQuantities
public void setShipmentContainerQuantities(java.util.List<DistributionPackageQuantity> shipmentContainerQuantities)
-
shipmentId
public InboundShipment shipmentId(java.lang.String shipmentId)
-
getShipmentId
public java.lang.String getShipmentId()
Unique shipment ID.- Returns:
- shipmentId
-
setShipmentId
public void setShipmentId(java.lang.String shipmentId)
-
shipmentSkuQuantities
public InboundShipment shipmentSkuQuantities(java.util.List<SkuQuantity> shipmentSkuQuantities)
-
addShipmentSkuQuantitiesItem
public InboundShipment addShipmentSkuQuantitiesItem(SkuQuantity shipmentSkuQuantitiesItem)
-
getShipmentSkuQuantities
public java.util.List<SkuQuantity> getShipmentSkuQuantities()
Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.- Returns:
- shipmentSkuQuantities
-
setShipmentSkuQuantities
public void setShipmentSkuQuantities(java.util.List<SkuQuantity> shipmentSkuQuantities)
-
destinationRegion
public InboundShipment destinationRegion(java.lang.String destinationRegion)
-
getDestinationRegion
public java.lang.String getDestinationRegion()
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]- Returns:
- destinationRegion
-
setDestinationRegion
public void setDestinationRegion(java.lang.String destinationRegion)
-
shipmentStatus
public InboundShipment shipmentStatus(InboundShipmentStatus shipmentStatus)
-
getShipmentStatus
public InboundShipmentStatus getShipmentStatus()
Get shipmentStatus- Returns:
- shipmentStatus
-
setShipmentStatus
public void setShipmentStatus(InboundShipmentStatus shipmentStatus)
-
trackingId
public InboundShipment trackingId(java.lang.String trackingId)
-
getTrackingId
public java.lang.String getTrackingId()
Carrier-unique tracking ID for this shipment.- Returns:
- trackingId
-
setTrackingId
public void setTrackingId(java.lang.String trackingId)
-
updatedAt
public InboundShipment updatedAt(org.threeten.bp.OffsetDateTime updatedAt)
-
getUpdatedAt
public org.threeten.bp.OffsetDateTime getUpdatedAt()
Timestamp when the shipment was updated. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.- Returns:
- updatedAt
-
setUpdatedAt
public void setUpdatedAt(org.threeten.bp.OffsetDateTime updatedAt)
-
warehouseReferenceId
public InboundShipment warehouseReferenceId(java.lang.String warehouseReferenceId)
-
getWarehouseReferenceId
public java.lang.String getWarehouseReferenceId()
An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.- Returns:
- warehouseReferenceId
-
setWarehouseReferenceId
public void setWarehouseReferenceId(java.lang.String warehouseReferenceId)
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-