Class Order

Class representing an EasyPost order.

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

Properties

| Improve this Doc View Source

BuyerAddress

The Address object representing the buyer's address. Defaults to ToAddress.

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

CarrierAccounts

The CarrierAccounts used for this order.

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

CustomsInfo

The CustomsInfo object representing the customs information for this order.

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

FromAddress

The Address object representing the destination address for this order.

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

IsReturn

Whether or not this order is a return.

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

Messages

Any carrier errors encountered while rating the order.

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

Rates

The Rates for the order.

Declaration
public List<Rate>? Rates { get; set; }
Property Value
Type Description
System.Nullable<List<Rate>>
| 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

ReturnAddress

The Address object representing the return address for the order. Defaults to FromAddress.

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

Service

The service level used for the order.

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

Shipments

The Shipments in the order.

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

ToAddress

The Address object representing the destination address for this order.

Declaration
public Address ToAddress { get; set; }
Property Value
Type Description
Address

Methods

| Improve this Doc View Source

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

Get the lowest rate for the order.

Declaration
public Rate 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
Rate

Lowest EasyPost.Rate object instance.

Implements