OrderFulfillmentShipmentDetails (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.OrderFulfillmentShipmentDetails

```
public class OrderFulfillmentShipmentDetails
extends Object
```
This is a model class for OrderFulfillmentShipmentDetails type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OrderFulfillmentShipmentDetails.Builder
Class to build instances of OrderFulfillmentShipmentDetails.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrderFulfillmentShipmentDetails.Builder` Class to build instances of `OrderFulfillmentShipmentDetails`.

Constructor Summary

Constructors
Constructor and Description
`OrderFulfillmentShipmentDetails(OrderFulfillmentRecipient recipient, String carrier, String shippingNote, String shippingType, String trackingNumber, String trackingUrl, String placedAt, String inProgressAt, String packagedAt, String expectedShippedAt, String shippedAt, String canceledAt, String cancelReason, String failedAt, String failureReason)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getCanceledAt()` Getter for CanceledAt.
`String`	`getCancelReason()` Getter for CancelReason.
`String`	`getCarrier()` Getter for Carrier.
`String`	`getExpectedShippedAt()` Getter for ExpectedShippedAt.
`String`	`getFailedAt()` Getter for FailedAt.
`String`	`getFailureReason()` Getter for FailureReason.
`String`	`getInProgressAt()` Getter for InProgressAt.
`String`	`getPackagedAt()` Getter for PackagedAt.
`String`	`getPlacedAt()` Getter for PlacedAt.
`OrderFulfillmentRecipient`	`getRecipient()` Getter for Recipient.
`String`	`getShippedAt()` Getter for ShippedAt.
`String`	`getShippingNote()` Getter for ShippingNote.
`String`	`getShippingType()` Getter for ShippingType.
`String`	`getTrackingNumber()` Getter for TrackingNumber.
`String`	`getTrackingUrl()` Getter for TrackingUrl.
`int`	`hashCode()`
`OrderFulfillmentShipmentDetails.Builder`	`toBuilder()` Builds a new `OrderFulfillmentShipmentDetails.Builder` object.
`String`	`toString()` Converts this OrderFulfillmentShipmentDetails into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OrderFulfillmentShipmentDetails
```
public OrderFulfillmentShipmentDetails(OrderFulfillmentRecipient recipient,
                                       String carrier,
                                       String shippingNote,
                                       String shippingType,
                                       String trackingNumber,
                                       String trackingUrl,
                                       String placedAt,
                                       String inProgressAt,
                                       String packagedAt,
                                       String expectedShippedAt,
                                       String shippedAt,
                                       String canceledAt,
                                       String cancelReason,
                                       String failedAt,
                                       String failureReason)
```
    Initialization constructor.
    
    Parameters:
    
    recipient - OrderFulfillmentRecipient value for recipient.
    
    carrier - String value for carrier.
    
    shippingNote - String value for shippingNote.
    
    shippingType - String value for shippingType.
    
    trackingNumber - String value for trackingNumber.
    
    trackingUrl - String value for trackingUrl.
    
    placedAt - String value for placedAt.
    
    inProgressAt - String value for inProgressAt.
    
    packagedAt - String value for packagedAt.
    
    expectedShippedAt - String value for expectedShippedAt.
    
    shippedAt - String value for shippedAt.
    
    canceledAt - String value for canceledAt.
    
    cancelReason - String value for cancelReason.
    
    failedAt - String value for failedAt.
    
    failureReason - String value for failureReason.
- Method Detail
  - getRecipient
```
public OrderFulfillmentRecipient getRecipient()
```
    Getter for Recipient. Contains information about the recipient of a fulfillment.
    
    Returns:
    
    Returns the OrderFulfillmentRecipient
  - getCarrier
```
public String getCarrier()
```
    Getter for Carrier. The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).
    
    Returns:
    
    Returns the String
  - getShippingNote
```
public String getShippingNote()
```
    Getter for ShippingNote. A note with additional information for the shipping carrier.
    
    Returns:
    
    Returns the String
  - getShippingType
```
public String getShippingType()
```
    Getter for ShippingType. A description of the type of shipping product purchased from the carrier (such as First Class, Priority, or Express).
    
    Returns:
    
    Returns the String
  - getTrackingNumber
```
public String getTrackingNumber()
```
    Getter for TrackingNumber. The reference number provided by the carrier to track the shipment's progress.
    
    Returns:
    
    Returns the String
  - getTrackingUrl
```
public String getTrackingUrl()
```
    Getter for TrackingUrl. A link to the tracking webpage on the carrier's website.
    
    Returns:
    
    Returns the String
  - getPlacedAt
```
public String getPlacedAt()
```
    Getter for PlacedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment was requested. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getInProgressAt
```
public String getInProgressAt()
```
    Getter for InProgressAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation of this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getPackagedAt
```
public String getPackagedAt()
```
    Getter for PackagedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getExpectedShippedAt
```
public String getExpectedShippedAt()
```
    Getter for ExpectedShippedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment is expected to be delivered to the shipping carrier. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getShippedAt
```
public String getShippedAt()
```
    Getter for ShippedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getCanceledAt
```
public String getCanceledAt()
```
    Getter for CanceledAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating the shipment was canceled. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getCancelReason
```
public String getCancelReason()
```
    Getter for CancelReason. A description of why the shipment was canceled.
    
    Returns:
    
    Returns the String
  - getFailedAt
```
public String getFailedAt()
```
    Getter for FailedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getFailureReason
```
public String getFailureReason()
```
    Getter for FailureReason. A description of why the shipment failed to be completed.
    
    Returns:
    
    Returns the String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this OrderFulfillmentShipmentDetails into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public OrderFulfillmentShipmentDetails.Builder toBuilder()
```
    Builds a new OrderFulfillmentShipmentDetails.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new OrderFulfillmentShipmentDetails.Builder object

Class OrderFulfillmentShipmentDetails

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderFulfillmentShipmentDetails

Method Detail

getRecipient

getCarrier

getShippingNote

getShippingType

getTrackingNumber

getTrackingUrl

getPlacedAt

getInProgressAt

getPackagedAt

getExpectedShippedAt

getShippedAt

getCanceledAt

getCancelReason

getFailedAt

getFailureReason

hashCode

equals

toString

toBuilder