Class Options

Class representing an EasyPost options set.

Inheritance

System.Object

EphemeralEasyPostObject

EasyPostObject

Options

Implements

IEasyPostObject

Inherited Members

EasyPostObject.CreatedAt

EasyPostObject.Id

EasyPostObject.UpdatedAt

EasyPostObject.Prefix

EasyPostObject.ToString()

EasyPostObject.Equals(Nullable<Object>)

EasyPostObject.GetHashCode()

EphemeralEasyPostObject.Mode

EphemeralEasyPostObject.AsJson()

Namespace: EasyPost.Models.API

Assembly: EasyPost.dll

Syntax

public class Options : EasyPostObject, IEasyPostObject

Properties

AdditionalHandling

When true, an additional handling fee will be applied to the shipment. An Additional Handling charge may be applied to the following:

• Any article that is encased in an outside shipping container made of metal or wood.
• Any item, such as a barrel, drum, pail or tire, that is not fully encased in a corrugated cardboard shipping container.
• Any package with the longest side exceeding 60 inches or its second longest side exceeding 30 inches.
• Any package with an actual weight greater than 70 pounds.

Declaration

public bool? AdditionalHandling { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AddressValidationLevel

Setting this option to "0", will allow the minimum amount of address information to pass the validation check. Only for USPS postage.

Declaration

public string? AddressValidationLevel { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Alcohol

Set this option to true if your shipment contains alcohol.

Carrier	Details
UPS	Only supported for US Domestic shipments.
FedEx	Only supported for US Domestic shipments.
Canada Post	Requires adult signature 19 years or older. If you want adult signature 18 years or older, instead set DeliveryConfirmation to "ADULT_SIGNATURE".

Declaration

public bool? Alcohol { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

BillingRef

A reference ID for aggregating DHL eCommerce billing data.

Declaration

public string? BillingRef { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ByDrone

Setting this option to true will indicate to the carrier to prefer delivery by drone, if the carrier supports drone delivery.

Declaration

public bool? ByDrone { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

CarrierInsuranceAmount

Class representing an EasyPost options set.

Declaration

public string? CarrierInsuranceAmount { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CarrierNotificationEmail

Assign an email address to receive carrier notifications.

Declaration

public string? CarrierNotificationEmail { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CarrierNotificationSms

Assign a phone number to receive carrier notifications.

Declaration

public string? CarrierNotificationSms { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CertifiedMail

Certified Mail provides the sender with a mailing receipt and, upon request, electronic verification that an article was delivered or that a delivery attempt was made.

Declaration

public bool? CertifiedMail { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

CodAddressId

The ID of the Address to which the COD payment should be returned. Defaults to the origin address. Only available on FedEx shipments.

Declaration

public string? CodAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CodAmount

Adding an amount will have the carrier collect the specified amount from the recipient.

Declaration

public string? CodAmount { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CodMethod

Method for payment.

• "CASH"
• "CHECK"
• "MONEY_ORDER"

Declaration

public string? CodMethod { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CommercialInvoiceFormat

Class representing an EasyPost options set.

Declaration

public string? CommercialInvoiceFormat { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CommercialInvoiceLetterhead

Class representing an EasyPost options set.

Declaration

public string? CommercialInvoiceLetterhead { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CommercialInvoiceSignature

Class representing an EasyPost options set.

Declaration

public string? CommercialInvoiceSignature { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CommercialInvoiceSize

Class representing an EasyPost options set.

Declaration

public string? CommercialInvoiceSize { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ContentDescription

A description of the content of the shipment.

Declaration

public string? ContentDescription { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CostCenter

Class representing an EasyPost options set.

Declaration

public string? CostCenter { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Currency

Which currency this Shipment will show for rates if carrier allows.

Declaration

public string? Currency { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CustomsBrokerAddressId

Class representing an EasyPost options set.

Declaration

public string? CustomsBrokerAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

CustomsIncludeShipping

Class representing an EasyPost options set.

Declaration

public string? CustomsIncludeShipping { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DeclaredValue

Class representing an EasyPost options set.

Declaration

public double? DeclaredValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

DeliveredDutyPaid

Class representing an EasyPost options set.

Declaration

public bool? DeliveredDutyPaid { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

DeliveryConfirmation

If you want to request a signature, you can pass "ADULT_SIGNATURE" or "SIGNATURE". You may also request "NO_SIGNATURE" to leave the package at the door. "NO_SIGNATURE" is equivalent to releasing liability. Some options may be limited for international shipments. Carrier specific delivery confirmation options are:

Carrier	Details
FedEx	"INDIRECT_SIGNATURE" Requires the signature of someone at the delivery address or from somebody nearby, such as a neighbor
USPS	"ADULT_SIGNATURE_RESTRICTED" Requires the signature of the addressee only, who must be 21 years of age or older "SIGNATURE_RESTRICTED" Requires the signature of the recipient or a responsible party
Canada Post	"DO_NOT_SAFE_DROP" Tells the carrier to not hide the package ("safe drop")
GSO	"STANDARD_SIGNATURE"
DHL Express	"SIGNATURE" DHL Express Direct Signature "NO_SIGNATURE" DHL Express Signature Release

Declaration

public string? DeliveryConfirmation { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DeliveryMaxDatetime

The latest a package should be delivered. Supported carriers vary.

Declaration

public string? DeliveryMaxDatetime { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DeliveryMinDatetime

The earliest a package should be delivered. Supported carriers vary.

Declaration

public string? DeliveryMinDatetime { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DeliveryTimePreference

Class representing an EasyPost options set.

Declaration

public string? DeliveryTimePreference { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DropoffMaxDatetime

Class representing an EasyPost options set.

Declaration

public DateTime? DropoffMaxDatetime { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

DropoffType

Method the customer will use to transfer the package to the carrier. Supported types and their corresponding carrier codes are:

Carrier	Details
FedEx	"REGULAR_PICKUP" Customer to transfer package during regular pickup (default) "SCHEDULED_PICKUP" Customer to transfer package during scheduled pickup "RETAIL_LOCATION" Customer to transfer package at FedEx retail location "STATION" "STATION" "DROP_BOX" Customer to use carrier drop box for package transfer

Declaration

public string? DropoffType { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DryIce

Package contents contain dry ice.

Carrier	Details
UPS	Needs DryIceWeight to be set.
UPS MailInnovations	Needs DryIceWeight to be set.
FedEx	Needs DryIceWeight to be set.

Declaration

public bool? DryIce { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

DryIceMedical

Whether the dry ice is for medical use.

Carrier	Details
UPS	Needs DryIceWeight to be set.
UPS MailInnovations	Needs DryIceWeight to be set.

Declaration

public string? DryIceMedical { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DryIceWeight

Weight of the dry ice, in ounces.

Carrier	Details
UPS	Needs DryIce to be set.
UPS MailInnovations	Needs DryIce to be set.
FedEx	Needs DryIce to be set.

Declaration

public string? DryIceWeight { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

DutyPayment

Set to bill the correct account for purchasing postage. This option is only available with FedEx and UPS.

Key	Value
type	One of the following: "THIRD_PARTY" "RECEIVER"
account	Account number
country	Country code that the account is based in
postage_code	Postal code that the account is based in

Declaration

public Dictionary<string, object?>? DutyPayment { get; set; }

Property Value

Type	Description
System.Nullable<Dictionary<System.String, System.Nullable<System.Object>>>

DutyPaymentAccount

Class representing an EasyPost options set.

Declaration

public string? DutyPaymentAccount { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Endorsement

Possible values are:

• "ADDRESS_SERVICE_REQUESTED"
• "FORWARDING_SERVICE_REQUESTED"
• "CHANGE_SERVICE_REQUESTED"
• "RETURN_SERVICE_REQUESTED"
• "LEAVE_IF_NO_RESPONSE"

Declaration

public string? Endorsement { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

EndShipperId

Specify the responsible EndShipper for the shipment.

Declaration

public string? EndShipperId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

FreightCharge

Additional cost to be added to the invoice of this Shipment. Only applies to UPS currently.

Declaration

public string? FreightCharge { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Group

Class representing an EasyPost options set.

Declaration

public string? Group { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

HandlingInstructions

This is to designate special instructions for the carrier, such as "Do not drop!".

Declaration

public string? HandlingInstructions { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Hazmat

Dangerous goods indicator. Possible values are:

• "PRIMARY_CONTAINED"
• "PRIMARY_PACKED"
• "PRIMARY"
• "SECONDARY_CONTAINED"
• "SECONDARY_PACKED"
• "SECONDARY"
• "ORMD"
• "LIMITED_QUANTITY"
• "LITHIUM"

Applies to USPS, FedEx and DHL eCommerce.

Declaration

public string? Hazmat { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

HoldForPickup

Package will wait at carrier facility for pickup.

Declaration

public bool? HoldForPickup { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ImageFormat

Class representing an EasyPost options set.

Declaration

public string? ImageFormat { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ImporterAddressId

Class representing an EasyPost options set.

Declaration

public string? ImporterAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ImportFederalTaxId

Class representing an EasyPost options set.

Declaration

public string? ImportFederalTaxId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ImportStateTaxId

Class representing an EasyPost options set.

Declaration

public string? ImportStateTaxId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Incoterm

Incoterm negotiated for shipment. Supported values are:

• "EXW"
• "FCA"
• "CPT"
• "CIP"
• "DAT"
• "DAP"
• "DDP"
• "FAS"
• "FOB"
• "CFR"
• "CIF"

Setting this value to anything other than "DDP" will pass the cost and responsibility of duties on to the recipient of the package(s), as specified by Incoterms rules.

Declaration

public string? Incoterm { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

InvoiceNumber

Invoice number to print on the postage label.

Declaration

public string? InvoiceNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

LabelDate

Set the date that will appear on the postage label. Accepts ISO 8601 formatted string including time zone offset. EasyPost stores all dates as UTC time.

Declaration

public DateTime? LabelDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

LabelFormat

Supported label formats are:

• "PNG"
• "PDF"
• "ZPL"
• "EPL2"

"PNG" is the only format that allows for conversion.

Declaration

public string? LabelFormat { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

LabelSize

Class representing an EasyPost options set.

Declaration

public string? LabelSize { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

LicenseNumber

Class representing an EasyPost options set.

Declaration

public string? LicenseNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Machinable

Whether or not the parcel can be processed by the carriers equipment.

Declaration

public string? Machinable { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

MerchantId

This is a required field for DHL eCommerce shipments and should be the merchant's name. It will be displayed on the shipping label and associated with the shipment throughout transit.

Declaration

public string? MerchantId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

NeutralDelivery

Class representing an EasyPost options set.

Declaration

public bool? NeutralDelivery { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

NonContract

Class representing an EasyPost options set.

Declaration

public bool? NonContract { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

OverlabelConstructCode

Class representing an EasyPost options set.

Declaration

public string? OverlabelConstructCode { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

OverlabelOriginalTrackingNumber

Class representing an EasyPost options set.

Declaration

public string? OverlabelOriginalTrackingNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PartiesToTransactionAreRelated

Class representing an EasyPost options set.

Declaration

public string? PartiesToTransactionAreRelated { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Payment

Setting payment type to bill the correct account for purchasing postage. "THIRD_PARTY" is only supported on passthrough billed carriers.

Key	Value
type	One of the following: "SENDER" "THIRD_PARTY" "RECEIVER" "COLLECT" Defaults to "SENDER".
account	Account number. Required for "RECEIVER" and "THIRD_PARTY".
country	Country code that the account is based in. Required for "THIRD_PARTY".
postage_code	Postal code that the account is based in. Required for "RECEIVER" and "THIRD_PARTY".

Declaration

public Dictionary<string, object>? Payment { get; set; }

Property Value

Type	Description
System.Nullable<Dictionary<System.String, System.Object>>

PeelAndReturn

Class representing an EasyPost options set.

Declaration

public bool? PeelAndReturn { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PickupMaxDatetime

The latest a package should be picked up. Supported carriers vary.

Declaration

public DateTime? PickupMaxDatetime { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

PickupMinDatetime

The earliest a package should be picked up. Supported carriers vary.

Declaration

public DateTime? PickupMinDatetime { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

PoSort

Class representing an EasyPost options set.

Declaration

public string? PoSort { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PostageLabelInline

Class representing an EasyPost options set.

Declaration

public bool? PostageLabelInline { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PrintCustom

Class representing an EasyPost options set.

Declaration

public List<Dictionary<string, object>>? PrintCustom { get; set; }

Property Value

Type	Description
System.Nullable<List<Dictionary<System.String, System.Object>>>

PrintCustom1

You can optionally print custom messages on labels. Message to print on the label in spot 1.

Declaration

public string? PrintCustom1 { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PrintCustom1Barcode

Create a barcode for this custom reference if supported by carrier.

Declaration

public bool? PrintCustom1Barcode { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PrintCustom1Code

Specify the type of PrintCustom1.

Carrier	Details
FedEx	(null) If PrintCustom1 is not provided, it defaults to Customer Reference PO Purchase Order Number DP Department Number RMA Return Merchandise Authorization
UPS	AJ Accounts Receivable Customer Account AT Appropriation Number BM Bill of Lading Number 9V Collect on Delivery (COD) Number ON Dealer Order Number DP Department Number 3Q Food and Drug Administration (FDA) Product Code IK Invoice Number MK Manifest Key Number MJ Model Number PM Part Number PC Production Code PO Purchase Order Number RQ Purchase Request Number RZ Return Authorization Number SA Salesperson Number SE Serial Number ST Store Number TN Transaction Reference Number EI Employer's ID Number TJ Federal Taxpayer ID No.

Declaration

public string? PrintCustom1Code { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PrintCustom2

You can optionally print custom messages on labels. Message to print on the label in spot 2.

Declaration

public string? PrintCustom2 { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PrintCustom2Barcode

Create a barcode for this custom reference if supported by carrier.

Declaration

public bool? PrintCustom2Barcode { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PrintCustom2Code

Specify the type of PrintCustom2. See PrintCustom1Code for a list of valid values.

Declaration

public string? PrintCustom2Code { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PrintCustom3

You can optionally print custom messages on labels. Message to print on the label in spot 3.

Declaration

public string? PrintCustom3 { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PrintCustom3Barcode

Create a barcode for this custom reference if supported by carrier.

Declaration

public bool? PrintCustom3Barcode { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PrintCustom3Code

Specify the type of PrintCustom3. See PrintCustom1Code for a list of valid values.

Declaration

public string? PrintCustom3Code { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PrintRate

Class representing an EasyPost options set.

Declaration

public bool? PrintRate { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ReceiverLiquorLicense

Class representing an EasyPost options set.

Declaration

public string? ReceiverLiquorLicense { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

RegisteredMail

Registered Mail is the most secure service that the USPS offers. It incorporates a system of receipts to monitor the movement of the mail from the point of acceptance to delivery.

Declaration

public bool? RegisteredMail { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RegisteredMailAmount

The value of the package contents for RegisteredMail purposes.

Declaration

public double? RegisteredMailAmount { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

ReturnReceipt

An electronic return receipt may be purchased at the time of mailing and provides a shipper with evidence of delivery (to whom the mail was delivered and date of delivery), and information about the recipient's actual delivery address. Only applies to the USPS.

Declaration

public bool? ReturnReceipt { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ReturnService

Class representing an EasyPost options set.

Declaration

public string? ReturnService { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SaturdayDelivery

Set this value to true for delivery on Saturday. When set, you will only get rates for services that are eligible for Saturday delivery. If no services are available for Saturday delivery, then you will not be returned any rates. You may need to create two shipments, one with the SaturdayDelivery option set and one without to get all your eligible rates.

Declaration

public bool? SaturdayDelivery { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

SettlementMethod

Class representing an EasyPost options set.

Declaration

public string? SettlementMethod { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SmartpostHub

You can use this to override the hub ID you have on your account.

Declaration

public string? SmartpostHub { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SmartpostManifest

The manifest ID is used to group SmartPost packages onto a manifest for each trailer.

Declaration

public string? SmartpostManifest { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SpecialRatesEligibility

This option allows you to request the following USPS mail classes:

Type	Code
Media Mail	USPS.MEDIAMAIL
Library Mail	USPS.LIBRARYMAIL

These mail classes have restrictions that must be followed. See the DMM (https://pe.usps.com/DMM300/Index) for eligibility rules.

Declaration

public string? SpecialRatesEligibility { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SuppressEtd

Class representing an EasyPost options set.

Declaration

public bool? SuppressEtd { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

TaxIdExpirationDate

The expiration date of the tax ID, in the format DD/MM/YYYY.

Declaration

public string? TaxIdExpirationDate { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Methods

AddAdditionalOption(String, Object)

Add an additional option that is not officially supported by the library.

Declaration

public void AddAdditionalOption(string key, object value)

Parameters

Type	Name	Description
System.String	key	JSON key of the option to add.
System.Object	value	Value of the option to add.

AsDictionary()

Gets this object as a JSON object (dictionary).

Declaration

public override Dictionary<string, object> AsDictionary()

Returns

Type	Description
Dictionary<System.String, System.Object>	A dictionary representation of this object's properties.

Overrides

EasyPostObject.AsDictionary()

FromDictionary(Dictionary<String, Object>)

Create an Options object from a dictionary. WARNING: This method involves serializing and deserializing the data, which can be slow. Use sparingly.

Declaration

public static Options FromDictionary(Dictionary<string, object> data)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	data	A of key-value pairs of options.

Returns

Type	Description
Options	An Options object.

Implements

IEasyPostObject