Class Pickup

Class representing an EasyPost pickup.

Inheritance
System.Object
EphemeralEasyPostObject
EasyPostObject
Pickup
Implements
Inherited Members
Namespace: EasyPost.Models.API
Assembly: EasyPost.dll
Syntax
public class Pickup : EasyPostObject, IEasyPostObject, IPickupParameter, IParameter

Properties

| Improve this Doc View Source

Address

The Address associated with this Pickup.

Declaration
public Address Address { get; set; }
Property Value
Type Description
Address
| Improve this Doc View Source

CarrierAccounts

The list of CarrierAccounts used to generate rates for this Pickup. If empty, all of the account's carrier accounts will be used.

Declaration
public List<CarrierAccount>? CarrierAccounts { get; set; }
Property Value
Type Description
System.Nullable<List<CarrierAccount>>
| Improve this Doc View Source

Confirmation

The confirmation number for this booked Pickup.

Declaration
public string? Confirmation { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Instructions

Additional text to help the driver successfully obtain the package.

Declaration
public string? Instructions { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

IsAccountAddress

Whether the Address is the account address.

Declaration
public bool? IsAccountAddress { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

MaxDatetime

The latest time at which the package is available to pick up. Must be later than MinDatetime.

Declaration
public DateTime? MaxDatetime { get; set; }
Property Value
Type Description
System.Nullable<DateTime>
| Improve this Doc View Source

Messages

A list of messages containing carrier errors encountered during pickup rate generation.

Declaration
public List<Message>? Messages { get; set; }
Property Value
Type Description
System.Nullable<List<Message>>
| Improve this Doc View Source

MinDatetime

The earliest time at which the package is available to pick up. Must be earlier than MaxDatetime.

Declaration
public DateTime? MinDatetime { get; set; }
Property Value
Type Description
System.Nullable<DateTime>
| Improve this Doc View Source

Name

Class representing an EasyPost pickup.

Declaration
public string? Name { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

PickupRates

A list of different pickup rates across valid carrier accounts for the shipment.

Declaration
public List<PickupRate>? PickupRates { get; set; }
Property Value
Type Description
System.Nullable<List<PickupRate>>
| Improve this Doc View Source

Reference

An optional field that may be used in place of ID in some API endpoints.

Declaration
public string? Reference { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Status

Current status of the Pickup. One of:

  • "scheduled"
  • "canceled"
  • "unknown"
Declaration
public string? Status { get; set; }
Property Value
Type Description
System.Nullable<System.String>

Methods

| Improve this Doc View Source

LowestRate(Nullable<List<String>>, Nullable<List<String>>, Nullable<List<String>>, Nullable<List<String>>)

Get the lowest rate for this Pickup.

Declaration
public PickupRate LowestRate(List<string>? includeCarriers = null, List<string>? includeServices = null, List<string>? excludeCarriers = null, List<string>? excludeServices = null)
Parameters
Type Name Description
System.Nullable<List<System.String>> includeCarriers

Carriers to include in the filter.
System.Nullable<List<System.String>> includeServices

Services to include in the filter.
System.Nullable<List<System.String>> excludeCarriers

Carriers to exclude in the filter.
System.Nullable<List<System.String>> excludeServices

Services to exclude in the filter.
Returns
Type Description
PickupRate

Lowest EasyPost.PickupRate object instance.

Implements