Class Shipment
- java.lang.Object
-
- software.amazon.spapi.models.vendor.shipments.v1.Shipment
-
public class Shipment extends java.lang.Object
A list of one or more shipments with respective details.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Shipment.CurrentShipmentStatusEnum
Indicates the current shipment status.static class
Shipment.ShipmentFreightTermEnum
Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid.static class
Shipment.TransactionTypeEnum
Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest).
-
Constructor Summary
Constructors Constructor Description Shipment()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Shipment
addContainersItem(Containers containersItem)
Shipment
addPurchaseOrdersItem(PurchaseOrders purchaseOrdersItem)
Shipment
addShipmentStatusDetailsItem(ShipmentStatusDetails shipmentStatusDetailsItem)
Shipment
buyerReferenceNumber(java.lang.String buyerReferenceNumber)
Shipment
collectFreightPickupDetails(CollectFreightPickupDetails collectFreightPickupDetails)
Shipment
containers(java.util.List<Containers> containers)
Shipment
currentShipmentStatus(Shipment.CurrentShipmentStatusEnum currentShipmentStatus)
Shipment
currentshipmentStatusDate(org.threeten.bp.OffsetDateTime currentshipmentStatusDate)
boolean
equals(java.lang.Object o)
java.lang.String
getBuyerReferenceNumber()
The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request.CollectFreightPickupDetails
getCollectFreightPickupDetails()
Get collectFreightPickupDetailsjava.util.List<Containers>
getContainers()
A list of the items in this transportation and their associated inner container details.Shipment.CurrentShipmentStatusEnum
getCurrentShipmentStatus()
Indicates the current shipment status.org.threeten.bp.OffsetDateTime
getCurrentshipmentStatusDate()
Date and time when the last status was updated.ImportDetails
getImportDetails()
Get importDetailsorg.threeten.bp.OffsetDateTime
getPackageLabelCreateDate()
The date and time of the package label created for the shipment by buyer.java.util.List<PurchaseOrders>
getPurchaseOrders()
Indicates the purchase orders involved for the transportation request.PartyIdentification
getSellingParty()
Get sellingPartyPartyIdentification
getShipFromParty()
Get shipFromPartyorg.threeten.bp.OffsetDateTime
getShipmentConfirmDate()
The date and time of the departure of the shipment from the vendor's location.org.threeten.bp.OffsetDateTime
getShipmentCreateDate()
The date and time of the shipment request created by vendor.Shipment.ShipmentFreightTermEnum
getShipmentFreightTerm()
Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid.TransportShipmentMeasurements
getShipmentMeasurements()
Get shipmentMeasurementsjava.util.List<ShipmentStatusDetails>
getShipmentStatusDetails()
Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response.PartyIdentification
getShipToParty()
Get shipToPartyorg.threeten.bp.OffsetDateTime
getTransactionDate()
Date on which the transportation request was submitted.Shipment.TransactionTypeEnum
getTransactionType()
Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest).TransportationDetails
getTransportationDetails()
Get transportationDetailsjava.lang.String
getVendorShipmentIdentifier()
Unique Transportation ID created by Vendor (Should not be used over the last 365 days).int
hashCode()
Shipment
importDetails(ImportDetails importDetails)
Shipment
packageLabelCreateDate(org.threeten.bp.OffsetDateTime packageLabelCreateDate)
Shipment
purchaseOrders(java.util.List<PurchaseOrders> purchaseOrders)
Shipment
sellingParty(PartyIdentification sellingParty)
void
setBuyerReferenceNumber(java.lang.String buyerReferenceNumber)
void
setCollectFreightPickupDetails(CollectFreightPickupDetails collectFreightPickupDetails)
void
setContainers(java.util.List<Containers> containers)
void
setCurrentShipmentStatus(Shipment.CurrentShipmentStatusEnum currentShipmentStatus)
void
setCurrentshipmentStatusDate(org.threeten.bp.OffsetDateTime currentshipmentStatusDate)
void
setImportDetails(ImportDetails importDetails)
void
setPackageLabelCreateDate(org.threeten.bp.OffsetDateTime packageLabelCreateDate)
void
setPurchaseOrders(java.util.List<PurchaseOrders> purchaseOrders)
void
setSellingParty(PartyIdentification sellingParty)
void
setShipFromParty(PartyIdentification shipFromParty)
void
setShipmentConfirmDate(org.threeten.bp.OffsetDateTime shipmentConfirmDate)
void
setShipmentCreateDate(org.threeten.bp.OffsetDateTime shipmentCreateDate)
void
setShipmentFreightTerm(Shipment.ShipmentFreightTermEnum shipmentFreightTerm)
void
setShipmentMeasurements(TransportShipmentMeasurements shipmentMeasurements)
void
setShipmentStatusDetails(java.util.List<ShipmentStatusDetails> shipmentStatusDetails)
void
setShipToParty(PartyIdentification shipToParty)
void
setTransactionDate(org.threeten.bp.OffsetDateTime transactionDate)
void
setTransactionType(Shipment.TransactionTypeEnum transactionType)
void
setTransportationDetails(TransportationDetails transportationDetails)
void
setVendorShipmentIdentifier(java.lang.String vendorShipmentIdentifier)
Shipment
shipFromParty(PartyIdentification shipFromParty)
Shipment
shipmentConfirmDate(org.threeten.bp.OffsetDateTime shipmentConfirmDate)
Shipment
shipmentCreateDate(org.threeten.bp.OffsetDateTime shipmentCreateDate)
Shipment
shipmentFreightTerm(Shipment.ShipmentFreightTermEnum shipmentFreightTerm)
Shipment
shipmentMeasurements(TransportShipmentMeasurements shipmentMeasurements)
Shipment
shipmentStatusDetails(java.util.List<ShipmentStatusDetails> shipmentStatusDetails)
Shipment
shipToParty(PartyIdentification shipToParty)
java.lang.String
toString()
Shipment
transactionDate(org.threeten.bp.OffsetDateTime transactionDate)
Shipment
transactionType(Shipment.TransactionTypeEnum transactionType)
Shipment
transportationDetails(TransportationDetails transportationDetails)
Shipment
vendorShipmentIdentifier(java.lang.String vendorShipmentIdentifier)
-
-
-
Method Detail
-
vendorShipmentIdentifier
public Shipment vendorShipmentIdentifier(java.lang.String vendorShipmentIdentifier)
-
getVendorShipmentIdentifier
public java.lang.String getVendorShipmentIdentifier()
Unique Transportation ID created by Vendor (Should not be used over the last 365 days).- Returns:
- vendorShipmentIdentifier
-
setVendorShipmentIdentifier
public void setVendorShipmentIdentifier(java.lang.String vendorShipmentIdentifier)
-
transactionType
public Shipment transactionType(Shipment.TransactionTypeEnum transactionType)
-
getTransactionType
public Shipment.TransactionTypeEnum getTransactionType()
Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation.- Returns:
- transactionType
-
setTransactionType
public void setTransactionType(Shipment.TransactionTypeEnum transactionType)
-
buyerReferenceNumber
public Shipment buyerReferenceNumber(java.lang.String buyerReferenceNumber)
-
getBuyerReferenceNumber
public java.lang.String getBuyerReferenceNumber()
The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments.- Returns:
- buyerReferenceNumber
-
setBuyerReferenceNumber
public void setBuyerReferenceNumber(java.lang.String buyerReferenceNumber)
-
transactionDate
public Shipment transactionDate(org.threeten.bp.OffsetDateTime transactionDate)
-
getTransactionDate
public org.threeten.bp.OffsetDateTime getTransactionDate()
Date on which the transportation request was submitted.- Returns:
- transactionDate
-
setTransactionDate
public void setTransactionDate(org.threeten.bp.OffsetDateTime transactionDate)
-
currentShipmentStatus
public Shipment currentShipmentStatus(Shipment.CurrentShipmentStatusEnum currentShipmentStatus)
-
getCurrentShipmentStatus
public Shipment.CurrentShipmentStatusEnum getCurrentShipmentStatus()
Indicates the current shipment status.- Returns:
- currentShipmentStatus
-
setCurrentShipmentStatus
public void setCurrentShipmentStatus(Shipment.CurrentShipmentStatusEnum currentShipmentStatus)
-
currentshipmentStatusDate
public Shipment currentshipmentStatusDate(org.threeten.bp.OffsetDateTime currentshipmentStatusDate)
-
getCurrentshipmentStatusDate
public org.threeten.bp.OffsetDateTime getCurrentshipmentStatusDate()
Date and time when the last status was updated.- Returns:
- currentshipmentStatusDate
-
setCurrentshipmentStatusDate
public void setCurrentshipmentStatusDate(org.threeten.bp.OffsetDateTime currentshipmentStatusDate)
-
shipmentStatusDetails
public Shipment shipmentStatusDetails(java.util.List<ShipmentStatusDetails> shipmentStatusDetails)
-
addShipmentStatusDetailsItem
public Shipment addShipmentStatusDetailsItem(ShipmentStatusDetails shipmentStatusDetailsItem)
-
getShipmentStatusDetails
public java.util.List<ShipmentStatusDetails> getShipmentStatusDetails()
Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response.- Returns:
- shipmentStatusDetails
-
setShipmentStatusDetails
public void setShipmentStatusDetails(java.util.List<ShipmentStatusDetails> shipmentStatusDetails)
-
shipmentCreateDate
public Shipment shipmentCreateDate(org.threeten.bp.OffsetDateTime shipmentCreateDate)
-
getShipmentCreateDate
public org.threeten.bp.OffsetDateTime getShipmentCreateDate()
The date and time of the shipment request created by vendor.- Returns:
- shipmentCreateDate
-
setShipmentCreateDate
public void setShipmentCreateDate(org.threeten.bp.OffsetDateTime shipmentCreateDate)
-
shipmentConfirmDate
public Shipment shipmentConfirmDate(org.threeten.bp.OffsetDateTime shipmentConfirmDate)
-
getShipmentConfirmDate
public org.threeten.bp.OffsetDateTime getShipmentConfirmDate()
The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.- Returns:
- shipmentConfirmDate
-
setShipmentConfirmDate
public void setShipmentConfirmDate(org.threeten.bp.OffsetDateTime shipmentConfirmDate)
-
packageLabelCreateDate
public Shipment packageLabelCreateDate(org.threeten.bp.OffsetDateTime packageLabelCreateDate)
-
getPackageLabelCreateDate
public org.threeten.bp.OffsetDateTime getPackageLabelCreateDate()
The date and time of the package label created for the shipment by buyer.- Returns:
- packageLabelCreateDate
-
setPackageLabelCreateDate
public void setPackageLabelCreateDate(org.threeten.bp.OffsetDateTime packageLabelCreateDate)
-
shipmentFreightTerm
public Shipment shipmentFreightTerm(Shipment.ShipmentFreightTermEnum shipmentFreightTerm)
-
getShipmentFreightTerm
public Shipment.ShipmentFreightTermEnum getShipmentFreightTerm()
Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information.- Returns:
- shipmentFreightTerm
-
setShipmentFreightTerm
public void setShipmentFreightTerm(Shipment.ShipmentFreightTermEnum shipmentFreightTerm)
-
sellingParty
public Shipment sellingParty(PartyIdentification sellingParty)
-
getSellingParty
public PartyIdentification getSellingParty()
Get sellingParty- Returns:
- sellingParty
-
setSellingParty
public void setSellingParty(PartyIdentification sellingParty)
-
shipFromParty
public Shipment shipFromParty(PartyIdentification shipFromParty)
-
getShipFromParty
public PartyIdentification getShipFromParty()
Get shipFromParty- Returns:
- shipFromParty
-
setShipFromParty
public void setShipFromParty(PartyIdentification shipFromParty)
-
shipToParty
public Shipment shipToParty(PartyIdentification shipToParty)
-
getShipToParty
public PartyIdentification getShipToParty()
Get shipToParty- Returns:
- shipToParty
-
setShipToParty
public void setShipToParty(PartyIdentification shipToParty)
-
shipmentMeasurements
public Shipment shipmentMeasurements(TransportShipmentMeasurements shipmentMeasurements)
-
getShipmentMeasurements
public TransportShipmentMeasurements getShipmentMeasurements()
Get shipmentMeasurements- Returns:
- shipmentMeasurements
-
setShipmentMeasurements
public void setShipmentMeasurements(TransportShipmentMeasurements shipmentMeasurements)
-
collectFreightPickupDetails
public Shipment collectFreightPickupDetails(CollectFreightPickupDetails collectFreightPickupDetails)
-
getCollectFreightPickupDetails
public CollectFreightPickupDetails getCollectFreightPickupDetails()
Get collectFreightPickupDetails- Returns:
- collectFreightPickupDetails
-
setCollectFreightPickupDetails
public void setCollectFreightPickupDetails(CollectFreightPickupDetails collectFreightPickupDetails)
-
purchaseOrders
public Shipment purchaseOrders(java.util.List<PurchaseOrders> purchaseOrders)
-
addPurchaseOrdersItem
public Shipment addPurchaseOrdersItem(PurchaseOrders purchaseOrdersItem)
-
getPurchaseOrders
public java.util.List<PurchaseOrders> getPurchaseOrders()
Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect)- Returns:
- purchaseOrders
-
setPurchaseOrders
public void setPurchaseOrders(java.util.List<PurchaseOrders> purchaseOrders)
-
importDetails
public Shipment importDetails(ImportDetails importDetails)
-
getImportDetails
public ImportDetails getImportDetails()
Get importDetails- Returns:
- importDetails
-
setImportDetails
public void setImportDetails(ImportDetails importDetails)
-
containers
public Shipment containers(java.util.List<Containers> containers)
-
addContainersItem
public Shipment addContainersItem(Containers containersItem)
-
getContainers
public java.util.List<Containers> getContainers()
A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.- Returns:
- containers
-
setContainers
public void setContainers(java.util.List<Containers> containers)
-
transportationDetails
public Shipment transportationDetails(TransportationDetails transportationDetails)
-
getTransportationDetails
public TransportationDetails getTransportationDetails()
Get transportationDetails- Returns:
- transportationDetails
-
setTransportationDetails
public void setTransportationDetails(TransportationDetails transportationDetails)
-
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
-
-