OrderFulfillmentPickupDetails (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`OrderFulfillmentPickupDetails(OrderFulfillmentRecipient recipient, String expiresAt, String autoCompleteDuration, String scheduleType, String pickupAt, String pickupWindowDuration, String prepTimeDuration, String note, String placedAt, String acceptedAt, String rejectedAt, String readyAt, String expiredAt, String pickedUpAt, String canceledAt, String cancelReason, Boolean isCurbsidePickup, OrderFulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAcceptedAt()` Getter for AcceptedAt.
`String`	`getAutoCompleteDuration()` Getter for AutoCompleteDuration.
`String`	`getCanceledAt()` Getter for CanceledAt.
`String`	`getCancelReason()` Getter for CancelReason.
`OrderFulfillmentPickupDetailsCurbsidePickupDetails`	`getCurbsidePickupDetails()` Getter for CurbsidePickupDetails.
`String`	`getExpiredAt()` Getter for ExpiredAt.
`String`	`getExpiresAt()` Getter for ExpiresAt.
`Boolean`	`getIsCurbsidePickup()` Getter for IsCurbsidePickup.
`String`	`getNote()` Getter for Note.
`String`	`getPickedUpAt()` Getter for PickedUpAt.
`String`	`getPickupAt()` Getter for PickupAt.
`String`	`getPickupWindowDuration()` Getter for PickupWindowDuration.
`String`	`getPlacedAt()` Getter for PlacedAt.
`String`	`getPrepTimeDuration()` Getter for PrepTimeDuration.
`String`	`getReadyAt()` Getter for ReadyAt.
`OrderFulfillmentRecipient`	`getRecipient()` Getter for Recipient.
`String`	`getRejectedAt()` Getter for RejectedAt.
`String`	`getScheduleType()` Getter for ScheduleType.
`int`	`hashCode()`
`OrderFulfillmentPickupDetails.Builder`	`toBuilder()` Builds a new `OrderFulfillmentPickupDetails.Builder` object.
`String`	`toString()` Converts this OrderFulfillmentPickupDetails into string format.

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

- Constructor Detail
  - OrderFulfillmentPickupDetails
```
public OrderFulfillmentPickupDetails(OrderFulfillmentRecipient recipient,
                                     String expiresAt,
                                     String autoCompleteDuration,
                                     String scheduleType,
                                     String pickupAt,
                                     String pickupWindowDuration,
                                     String prepTimeDuration,
                                     String note,
                                     String placedAt,
                                     String acceptedAt,
                                     String rejectedAt,
                                     String readyAt,
                                     String expiredAt,
                                     String pickedUpAt,
                                     String canceledAt,
                                     String cancelReason,
                                     Boolean isCurbsidePickup,
                                     OrderFulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails)
```
    Initialization constructor.
    
    Parameters:
    
    recipient - OrderFulfillmentRecipient value for recipient.
    
    expiresAt - String value for expiresAt.
    
    autoCompleteDuration - String value for autoCompleteDuration.
    
    scheduleType - String value for scheduleType.
    
    pickupAt - String value for pickupAt.
    
    pickupWindowDuration - String value for pickupWindowDuration.
    
    prepTimeDuration - String value for prepTimeDuration.
    
    note - String value for note.
    
    placedAt - String value for placedAt.
    
    acceptedAt - String value for acceptedAt.
    
    rejectedAt - String value for rejectedAt.
    
    readyAt - String value for readyAt.
    
    expiredAt - String value for expiredAt.
    
    pickedUpAt - String value for pickedUpAt.
    
    canceledAt - String value for canceledAt.
    
    cancelReason - String value for cancelReason.
    
    isCurbsidePickup - Boolean value for isCurbsidePickup.
    
    curbsidePickupDetails - OrderFulfillmentPickupDetailsCurbsidePickupDetails value for curbsidePickupDetails.
- Method Detail
  - getRecipient
```
public OrderFulfillmentRecipient getRecipient()
```
    Getter for Recipient. Contains information about the recipient of a fulfillment.
    
    Returns:
    
    Returns the OrderFulfillmentRecipient
  - getExpiresAt
```
public String getExpiresAt()
```
    Getter for ExpiresAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment is automatically accepted when placed.
    
    Returns:
    
    Returns the String
  - getAutoCompleteDuration
```
public String getAutoCompleteDuration()
```
    Getter for AutoCompleteDuration. The duration of time after which an open and accepted pickup fulfillment is automatically moved to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D"). If not set, this pickup fulfillment remains accepted until it is canceled or completed.
    
    Returns:
    
    Returns the String
  - getScheduleType
```
public String getScheduleType()
```
    Getter for ScheduleType. The schedule type of the pickup fulfillment.
    
    Returns:
    
    Returns the String
  - getPickupAt
```
public String getPickupAt()
```
    Getter for PickupAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.
    
    Returns:
    
    Returns the String
  - getPickupWindowDuration
```
public String getPickupWindowDuration()
```
    Getter for PickupWindowDuration. The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants.
    
    Returns:
    
    Returns the String
  - getPrepTimeDuration
```
public String getPrepTimeDuration()
```
    Getter for PrepTimeDuration. The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D").
    
    Returns:
    
    Returns the String
  - getNote
```
public String getNote()
```
    Getter for Note. A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.
    
    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 fulfillment was placed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getAcceptedAt
```
public String getAcceptedAt()
```
    Getter for AcceptedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was accepted. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getRejectedAt
```
public String getRejectedAt()
```
    Getter for RejectedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getReadyAt
```
public String getReadyAt()
```
    Getter for ReadyAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getExpiredAt
```
public String getExpiredAt()
```
    Getter for ExpiredAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getPickedUpAt
```
public String getPickedUpAt()
```
    Getter for PickedUpAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was picked up by the recipient. 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 when the fulfillment 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 pickup was canceled. The maximum length: 100 characters.
    
    Returns:
    
    Returns the String
  - getIsCurbsidePickup
```
public Boolean getIsCurbsidePickup()
```
    Getter for IsCurbsidePickup. If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.
    
    Returns:
    
    Returns the Boolean
  - getCurbsidePickupDetails
```
public OrderFulfillmentPickupDetailsCurbsidePickupDetails getCurbsidePickupDetails()
```
    Getter for CurbsidePickupDetails. Specific details for curbside pickup.
    
    Returns:
    
    Returns the OrderFulfillmentPickupDetailsCurbsidePickupDetails
  - 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 OrderFulfillmentPickupDetails into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public OrderFulfillmentPickupDetails.Builder toBuilder()
```
    Builds a new OrderFulfillmentPickupDetails.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new OrderFulfillmentPickupDetails.Builder object

Class OrderFulfillmentPickupDetails

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderFulfillmentPickupDetails

Method Detail

getRecipient

getExpiresAt

getAutoCompleteDuration

getScheduleType

getPickupAt

getPickupWindowDuration

getPrepTimeDuration

getNote

getPlacedAt

getAcceptedAt

getRejectedAt

getReadyAt

getExpiredAt

getPickedUpAt

getCanceledAt

getCancelReason

getIsCurbsidePickup

getCurbsidePickupDetails

hashCode

equals

toString

toBuilder