Show / Hide Table of Contents

Namespace EasyPost.Models.API

Classes

Address

Class representing an EasyPost address.

AddressCollection

Class representing a collection of EasyPost Addresses.

AddressVerificationFieldError

Represents an error returned by the EasyPost API. These are typically informational about why a request failed (server-side validation issues, missing data, etc.). This is different than the EasyPostError class, which represents exceptions in the EasyPost library, such as bad HTTP status codes or local validation issues.

AiResults

AiResults model. Represents AI prediction results for a shipment.

ApiKey

Class representing an EasyPost API key.

ApiKeyCollection

Class representing a collection of EasyPost ApiKeys.

Batch

Class representing an EasyPost batch.

BatchCollection

Class representing a collection of EasyPost Batches.

BatchShipment

Class representing an EasyPost batch shipment.

Brand

Class representing an EasyPost brand.

Carrier

Class representing a carrier in an EasyPost carrier metadata summary.

CarrierAccount

Class representing an EasyPost carrier account.

CarrierAccountType

Enums representing specific carrier account types.

CarrierDetail

Class representing an EasyPost Tracker's carrier details.

CarrierField

Class representing a single EasyPost CarrierAccount's credentials entry details.

CarrierFields

Class representing an EasyPost CarrierAccount's credentials.

CarrierMetadata

Class representing an EasyPost carrier metadata summary.

CarrierMetadataType

Represents the types of metadata that can be retrieved for a carrier.

CarrierType

Class representing an EasyPost carrier type.

ChildUserCollection

Class representing a collection of EasyPost Child Users.

Claim

Class representing a EasyPost claim object.

ClaimCollection

Class representing a collection of EasyPost Claim objects.

ClaimHistoryEntry

Class representing an entry in a History property.

ClaimPaymentMethod

Claim payment method enum.

ClaimType

Claim type enum.

CustomsInfo

Class representing an EasyPost customs info object.

CustomsItem

Class representing an EasyPost customs item.

DeliveryDateForZipPairEstimate

Class representing time-in-transit estimates for a specific carrier-route-service level combination in a EstimateDeliveryDateForZipPairResult.

EndShipper

Class representing an EasyPost EndShipper.

EndShipperCollection

Class representing a collection of EasyPost EndShippers.

EstimateDeliveryDateForZipPairResult

Class representing delivery date estimates for carrier-route-service level combinations.

Event

Class representing an EasyPost event.

EventCollection

Class representing a collection of EasyPost Events.

Fee

Class representing an EasyPost fee.

FieldError

Represents an error returned by the EasyPost API. These are typically informational about why a request failed (server-side validation issues, missing data, etc.). This is different than the EasyPostError class, which represents exceptions in the EasyPost library, such as bad HTTP status codes or local validation issues.

Form

Class representing an EasyPost form.

Insurance

Class representing an EasyPost insurance object.

InsuranceCollection

Class representing a collection of EasyPost Insurance objects.

LumaInfo

LumaInfo model. Represents Luma information including AI results and selected rate.

Message

Class representing an EasyPost Shipment or Pickup message.

Options

Class representing an EasyPost options set.

Order

Class representing an EasyPost order.

Parcel

Class representing an EasyPost parcel.

Payload

Class representing an EasyPost event payload.

PaymentMethod

Represents a credit card or a bank account.

PaymentMethod.Priority

Payment method priority.

PaymentMethodsSummary

Represents a summary of the primary and secondary payment methods on the user's account.

PaymentMethodType

Enum representing an EasyPost payment method type.

Pickup

Class representing an EasyPost pickup.

PickupCollection

Class representing a collection of EasyPost Pickup objects.

PickupRate

Class representing an EasyPost pickup rate.

PostageLabel

Class representing an EasyPost postage label.

PredefinedPackage

Class representing a predefined package in an EasyPost carrier metadata summary.

Rate

Class representing an EasyPost rate.

RateWithEstimatedDeliveryDate

Class representing a Rate with an estimated delivery date.

RecommendShipDateForShipmentResult

Class representing a Rate with time-in-transit details based on a desired delivery date.

RecommendShipDateForZipPairResult

Class representing ship date recommendations for carrier-route-service level combinations.

ReferralCustomer

Class representing an EasyPost referral customer.

ReferralCustomerCollection

Class representing a collection of EasyPost ReferralCustomers.

Refund

Class representing an EasyPost refund.

RefundCollection

Class representing a collection of EasyPost Refunds.

Report

Class representing an EasyPost report.

ReportCollection

Class representing a collection of EasyPost Reports.

ScanForm

Class representing an EasyPost scan form.

ScanFormCollection

Class representing a collection of EasyPost ScanForms.

ServiceLevel

Class representing a service level in an EasyPost carrier metadata summary.

ShipDateForZipPairRecommendation

Class representing time-in-transit estimates for a specific carrier-route-service level combination in a RecommendShipDateForZipPairResult.

Shipment

Class representing an EasyPost shipment.

ShipmentCollection

Class representing a collection of EasyPost Shipments.

ShipmentOption

Class representing a shipment option in an EasyPost carrier metadata summary.

SmartRate

Class representing an EasyPost SmartRate.

SortDirection

Enum representing the sort direction for records.

StripeClientSecret

Class representing a client secret to securely collect credit card details.

SupportedFeature

Class representing a supported feature in an EasyPost carrier metadata summary.

TaxIdentifier

Class representing an EasyPost tax identifier.

TimeInTransit

Class representing an EasyPost time in transit summary.

TimeInTransitDetailsForDeliveryDateEstimate

Class representing estimated transit times for a EstimateDeliveryDateForZipPairResult or RateWithEstimatedDeliveryDate.

TimeInTransitDetailsForShipDateRecommendation

Class representing estimated transit times for a RecommendShipDateForShipmentResult.

Tracker

Class representing an EasyPost tracker.

TrackerCollection

Class representing a collection of EasyPost Trackers.

TrackingDetail

Class representing an EasyPost tracker detail object.

TrackingLocation

Class representing an EasyPost tracking location.

User

Class representing an EasyPost user.

Verification

Class representing an EasyPost verification object.

VerificationDetails

Class representing an EasyPost verification details object.

Verifications

Class representing an EasyPost verifications object.

Webhook

Class representing an EasyPost webhook.

WebhookCustomHeader

Class for webhook custom header.

Enums

SmartRateAccuracy

Enum representing the available smart rate accuracy levels.

In This Article
Back to top Generated by DocFX