easypost

package module

Go to main page

Versions in this module

v2

v2.20.0

Jul 27, 2023

Changes in this version

type Client

+ Hooks Hooks

+ type HookEvent struct

+ type HookEventSubscriber struct

+ ID string

+ type Hooks struct

+ RequestHookEventSubscriptions []RequestHookEventSubscriber

+ ResponseHookEventSubscriptions []ResponseHookEventSubscriber

+ func (h *Hooks) AddRequestEventSubscriber(subscriber RequestHookEventSubscriber)

+ func (h *Hooks) AddResponseEventSubscriber(subscriber ResponseHookEventSubscriber)

+ func (h *Hooks) RemoveRequestEventSubscriber(subscriber RequestHookEventSubscriber)

+ func (h *Hooks) RemoveResponseEventSubscriber(subscriber ResponseHookEventSubscriber)

+ type RequestHookEvent struct

+ Headers map[string][]string

+ Id uuid.UUID

+ Method string

+ RequestBody io.ReadCloser

+ RequestTimestamp time.Time

+ Url *url.URL

+ type RequestHookEventSubscriber struct

+ Callback RequestHookEventSubscriberCallback

+ func (s RequestHookEventSubscriber) Execute(ctx context.Context, event RequestHookEvent)

+ type RequestHookEventSubscriberCallback func(ctx context.Context, event RequestHookEvent) error

+ type ResponseHookEvent struct

+ Headers map[string][]string

+ HttpStatus int

+ Id uuid.UUID

+ Method string

+ RequestTimestamp time.Time

+ ResponseBody io.ReadCloser

+ ResponseTimestamp time.Time

+ Url *url.URL

+ type ResponseHookEventSubscriber struct

+ Callback ResponseHookEventSubscriberCallback

+ func (s ResponseHookEventSubscriber) Execute(ctx context.Context, event ResponseHookEvent)

+ type ResponseHookEventSubscriberCallback func(ctx context.Context, event ResponseHookEvent) error

v2.19.0

Jun 6, 2023

Changes in this version

+ type CarrierMetadata struct

+ HumanReadable string

+ Name string

+ PredefinedPackages []*MetadataPredefinedPackage

+ ServiceLevels []*MetadataServiceLevel

+ ShipmentOptions []*MetadataShipmentOption

+ SupportedFeatures []*MetadataSupportedFeature

type Client

+ func (c *Client) GetCarrierMetadata() (out []*CarrierMetadata, err error)

+ func (c *Client) GetCarrierMetadataWithCarriers(carriers []string) (out []*CarrierMetadata, err error)

+ func (c *Client) GetCarrierMetadataWithCarriersAndTypes(carriers []string, types []string) (out []*CarrierMetadata, err error)

+ func (c *Client) GetCarrierMetadataWithContext(ctx context.Context, carriers []string, types []string) (out []*CarrierMetadata, err error)

+ func (c *Client) GetCarrierMetadataWithTypes(types []string) (out []*CarrierMetadata, err error)

+ type MetadataPredefinedPackage struct

+ Carrier string

+ Description string

+ Dimensions []string

+ HumanReadable string

+ MaxWeight float64

+ Name string

+ type MetadataServiceLevel struct

+ Carrier string

+ Description string

+ Dimensions []string

+ HumanReadable string

+ MaxWeight float64

+ Name string

+ type MetadataShipmentOption struct

+ Carrier string

+ Deprecated bool

+ Description string

+ HumanReadable string

+ Name string

+ Type string

+ type MetadataSupportedFeature struct

+ Carrier string

+ Description string

+ Name string

+ Supported bool

v2.18.0

May 1, 2023

Changes in this version

type Client

+ func (c *Client) GetShipmentEstimatedDeliveryDate(shipmentID, plannedShipDate string) (out []*EstimatedDeliveryDate, err error)

+ func (c *Client) GetShipmentEstimatedDeliveryDateWithContext(ctx context.Context, shipmentID string, plannedShipDate string) (out []*EstimatedDeliveryDate, err error)

+ type EasyPostTimeInTransitData struct

+ DaysInTransit TimeInTransit

+ EasyPostEstimatedDeliveryDate string

+ PlannedShipDate string

+ type EstimatedDeliveryDate struct

+ EasyPostTimeInTransitData EasyPostTimeInTransitData

+ Rate SmartRate

v2.17.0

Apr 26, 2023

Changes in this version

type ShipmentOptions

+ SuppressETD bool

v2.16.0

Apr 26, 2023

Changes in this version

type Order

+ CustomsInfo *CustomsInfo

v2.15.0

Apr 19, 2023

Changes in this version

type APIError

+ func (e *APIError) UnmarshalJSON(data []byte) error

+ type BetaCarrierMetadata struct

+ HumanReadable string

+ Name string

+ PredefinedPackages []*BetaMetadataPredefinedPackage

+ ServiceLevels []*BetaMetadataServiceLevel

+ ShipmentOptions []*BetaMetadataShipmentOption

+ SupportedFeatures []*BetaMetadataSupportedFeature

+ type BetaMetadataPredefinedPackage struct

+ Carrier string

+ Description string

+ Dimensions []string

+ HumanReadable string

+ MaxWeight float64

+ Name string

+ type BetaMetadataServiceLevel struct

+ Carrier string

+ Description string

+ Dimensions []string

+ HumanReadable string

+ MaxWeight float64

+ Name string

+ type BetaMetadataShipmentOption struct

+ Carrier string

+ Deprecated bool

+ Description string

+ HumanReadable string

+ Name string

+ Type string

+ type BetaMetadataSupportedFeature struct

+ Carrier string

+ Description string

+ Name string

+ Supported bool

type Client

+ func (c *Client) BetaGetCarrierMetadata() (out []*BetaCarrierMetadata, err error)

+ func (c *Client) BetaGetCarrierMetadataWithCarriers(carriers []string) (out []*BetaCarrierMetadata, err error)

+ func (c *Client) BetaGetCarrierMetadataWithCarriersAndTypes(carriers []string, types []string) (out []*BetaCarrierMetadata, err error)

+ func (c *Client) BetaGetCarrierMetadataWithContext(ctx context.Context, carriers []string, types []string) (out []*BetaCarrierMetadata, err error)

+ func (c *Client) BetaGetCarrierMetadataWithTypes(types []string) (out []*BetaCarrierMetadata, err error)

v2.14.0

Apr 4, 2023

Changes in this version

+ var EndOfPaginationError = errors.New("there are no more pages to retrieve")

type Client

+ func (c *Client) GetNextAddressPage(collection *ListAddressResult) (out *ListAddressResult, err error)

+ func (c *Client) GetNextAddressPageWithContext(ctx context.Context, collection *ListAddressResult) (out *ListAddressResult, err error)

+ func (c *Client) GetNextAddressPageWithPageSize(collection *ListAddressResult, pageSize int) (out *ListAddressResult, err error)

+ func (c *Client) GetNextAddressPageWithPageSizeWithContext(ctx context.Context, collection *ListAddressResult, pageSize int) (out *ListAddressResult, err error)

+ func (c *Client) GetNextEventPage(collection *ListEventsResult) (out *ListEventsResult, err error)

+ func (c *Client) GetNextEventPageWithContext(ctx context.Context, collection *ListEventsResult) (out *ListEventsResult, err error)

+ func (c *Client) GetNextEventPageWithPageSize(collection *ListEventsResult, pageSize int) (out *ListEventsResult, err error)

+ func (c *Client) GetNextEventPageWithPageSizeWithContext(ctx context.Context, collection *ListEventsResult, pageSize int) (out *ListEventsResult, err error)

+ func (c *Client) GetNextInsurancePage(collection *ListInsurancesResult) (out *ListInsurancesResult, err error)

+ func (c *Client) GetNextInsurancePageWithContext(ctx context.Context, collection *ListInsurancesResult) (out *ListInsurancesResult, err error)

+ func (c *Client) GetNextInsurancePageWithPageSize(collection *ListInsurancesResult, pageSize int) (out *ListInsurancesResult, err error)

+ func (c *Client) GetNextInsurancePageWithPageSizeWithContext(ctx context.Context, collection *ListInsurancesResult, pageSize int) (out *ListInsurancesResult, err error)

+ func (c *Client) GetNextPickupPage(collection *ListPickupResult) (out *ListPickupResult, err error)

+ func (c *Client) GetNextPickupPageWithContext(ctx context.Context, collection *ListPickupResult) (out *ListPickupResult, err error)

+ func (c *Client) GetNextPickupPageWithPageSize(collection *ListPickupResult, pageSize int) (out *ListPickupResult, err error)

+ func (c *Client) GetNextPickupPageWithPageSizeWithContext(ctx context.Context, collection *ListPickupResult, pageSize int) (out *ListPickupResult, err error)

+ func (c *Client) GetNextReferralCustomerPage(collection *ListReferralCustomersResult) (out *ListReferralCustomersResult, err error)

+ func (c *Client) GetNextReferralCustomerPageWithContext(ctx context.Context, collection *ListReferralCustomersResult) (out *ListReferralCustomersResult, err error)

+ func (c *Client) GetNextReferralCustomerPageWithPageSize(collection *ListReferralCustomersResult, pageSize int) (out *ListReferralCustomersResult, err error)

+ func (c *Client) GetNextReferralCustomerPageWithPageSizeWithContext(ctx context.Context, collection *ListReferralCustomersResult, pageSize int) (out *ListReferralCustomersResult, err error)

+ func (c *Client) GetNextRefundPage(collection *ListRefundResult) (out *ListRefundResult, err error)

+ func (c *Client) GetNextRefundPageWithContext(ctx context.Context, collection *ListRefundResult) (out *ListRefundResult, err error)

+ func (c *Client) GetNextRefundPageWithPageSize(collection *ListRefundResult, pageSize int) (out *ListRefundResult, err error)

+ func (c *Client) GetNextRefundPageWithPageSizeWithContext(ctx context.Context, collection *ListRefundResult, pageSize int) (out *ListRefundResult, err error)

+ func (c *Client) GetNextReportPage(collection *ListReportsResult) (out *ListReportsResult, err error)

+ func (c *Client) GetNextReportPageWithContext(ctx context.Context, collection *ListReportsResult) (out *ListReportsResult, err error)

+ func (c *Client) GetNextReportPageWithPageSize(collection *ListReportsResult, pageSize int) (out *ListReportsResult, err error)

+ func (c *Client) GetNextReportPageWithPageSizeWithContext(ctx context.Context, collection *ListReportsResult, pageSize int) (out *ListReportsResult, err error)

+ func (c *Client) GetNextScanFormPage(collection *ListScanFormsResult) (out *ListScanFormsResult, err error)

+ func (c *Client) GetNextScanFormPageWithContext(ctx context.Context, collection *ListScanFormsResult) (out *ListScanFormsResult, err error)

+ func (c *Client) GetNextScanFormPageWithPageSize(collection *ListScanFormsResult, pageSize int) (out *ListScanFormsResult, err error)

+ func (c *Client) GetNextScanFormPageWithPageSizeWithContext(ctx context.Context, collection *ListScanFormsResult, pageSize int) (out *ListScanFormsResult, err error)

+ func (c *Client) GetNextShipmentPage(collection *ListShipmentsResult) (out *ListShipmentsResult, err error)

+ func (c *Client) GetNextShipmentPageWithContext(ctx context.Context, collection *ListShipmentsResult) (out *ListShipmentsResult, err error)

+ func (c *Client) GetNextShipmentPageWithPageSize(collection *ListShipmentsResult, pageSize int) (out *ListShipmentsResult, err error)

+ func (c *Client) GetNextShipmentPageWithPageSizeWithContext(ctx context.Context, collection *ListShipmentsResult, pageSize int) (out *ListShipmentsResult, err error)

+ func (c *Client) GetNextTrackerPage(collection *ListTrackersResult) (out *ListTrackersResult, err error)

+ func (c *Client) GetNextTrackerPageWithContext(ctx context.Context, collection *ListTrackersResult) (out *ListTrackersResult, err error)

+ func (c *Client) GetNextTrackerPageWithPageSize(collection *ListTrackersResult, pageSize int) (out *ListTrackersResult, err error)

+ func (c *Client) GetNextTrackerPageWithPageSizeWithContext(ctx context.Context, collection *ListTrackersResult, pageSize int) (out *ListTrackersResult, err error)

type ListReportsResult

+ Type string

type ListShipmentsResult

+ IncludeChildren *bool

+ Purchased *bool

type ListTrackersResult

+ Carrier string

+ TrackingCodes []string

+ type PaginatedCollection struct

+ HasMore bool

v2.13.1

Mar 22, 2023

Changes in this version

type Tracker

+ StatusDetail string

type TrackingDetail

+ StatusDetail string

v2.13.0

Feb 21, 2023

Changes in this version

type Client

+ func (c *Client) BetaGetStatelessRates(in *Shipment) (out []*StatelessRate, err error)

+ func (c *Client) BetaGetStatelessRatesWithContext(ctx context.Context, in *Shipment) (out []*StatelessRate, err error)

+ func (c *Client) LowestStatelessRate(rates []*StatelessRate) (out StatelessRate, err error)

+ func (c *Client) LowestStatelessRateWithCarrier(rates []*StatelessRate, carriers []string) (out StatelessRate, err error)

+ func (c *Client) LowestStatelessRateWithCarrierAndService(rates []*StatelessRate, carriers []string, services []string) (out StatelessRate, err error)

+ type StatelessRate struct

+ BillingType string

+ Carrier string

+ CarrierAccountID string

+ Currency string

+ DeliveryDate *time.Time

+ DeliveryDateGuaranteed bool

+ DeliveryDays int

+ EstDeliveryDays int

+ ListCurrency string

+ ListRate string

+ Mode string

+ Object string

+ Rate string

+ RetailCurrency string

+ RetailRate string

+ Service string

+ ShipmentID string

v2.12.0

Jan 18, 2023

Changes in this version

type Client

+ func (c *Client) GetEventPayload(eventID, payloadID string) (out *EventPayload, err error)

+ func (c *Client) GetEventPayloadWithContext(ctx context.Context, eventID, payloadID string) (out *EventPayload, err error)

+ func (c *Client) ListPickups(opts *ListOptions) (out *ListPickupResult, err error)

+ func (c *Client) ListPickupsWithContext(ctx context.Context, opts *ListOptions) (out *ListPickupResult, err error)

+ type ListPickupResult struct

+ HasMore bool

+ Pickups []*Pickup

v2.11.1

Jan 11, 2023

v2.11.0

Jan 11, 2023

Changes in this version

+ type BetaPaymentRefund struct

+ Errors []APIError

+ PaymentLogId string

+ RefundedAmount int

+ RefundedPaymentLogs []string

type Client

+ func (c *Client) BetaAddPaymentMethod(stripeCustomerId string, paymentMethodReference string) (out *PaymentMethodObject, err error)

+ func (c *Client) BetaAddPaymentMethodWithContext(ctx context.Context, stripeCustomerId string, paymentMethodReference string) (out *PaymentMethodObject, err error)

+ func (c *Client) BetaAddPaymentMethodWithPrimaryOrSecondary(stripeCustomerId string, paymentMethodReference string, ...) (out *PaymentMethodObject, err error)

+ func (c *Client) BetaAddPaymentMethodWithPrimaryOrSecondaryAndContext(ctx context.Context, stripeCustomerId string, paymentMethodReference string, ...) (out *PaymentMethodObject, err error)

+ func (c *Client) BetaRefundByAmount(refundAmount int) (out *BetaPaymentRefund, err error)

+ func (c *Client) BetaRefundByAmountWithContext(ctx context.Context, refundAmount int) (out *BetaPaymentRefund, err error)

+ func (c *Client) BetaRefundByPaymentLog(paymentLogId string) (out *BetaPaymentRefund, err error)

+ func (c *Client) BetaRefundByPaymentLogWithContext(ctx context.Context, paymentLogId string) (out *BetaPaymentRefund, err error)

+ func (c *Client) GetPaymentEndpointByPrimaryOrSecondary(primaryOrSecondary PaymentMethodPriority) (out string)

type ShipmentOptions

+ DeliveryMaxDatetime *time.Time

+ PickupMinDatetime *time.Time

v2.10.0

Dec 7, 2022

Changes in this version

type CarrierAccount

+ RegistrationData map[string]interface{}

type Client

+ MockRequests []MockRequest

+ type MockRequest struct

+ MatchRule MockRequestMatchRule

+ ResponseInfo MockRequestResponseInfo

+ type MockRequestMatchRule struct

+ Method string

+ UrlRegexPattern string

+ type MockRequestResponseInfo struct

+ Body string

+ StatusCode int

+ func (r *MockRequestResponseInfo) AsResponse() *http.Response

+ func (r *MockRequestResponseInfo) MockBody() io.ReadCloser

v2.9.0

Nov 15, 2022

Changes in this version

type ShipmentOptions

+ LabelSize string

v2.8.0

Sep 21, 2022

Changes in this version

type Client

+ func (c *Client) AddReferralCustomerCreditCard(referralCustomerApiKey string, creditCardOptions *CreditCardOptions, ...) (out *PaymentMethodObject, err error)

+ func (c *Client) AddReferralCustomerCreditCardWithContext(ctx context.Context, referralCustomerApiKey string, ...) (out *PaymentMethodObject, err error)

+ func (c *Client) BuyShipmentWithCarbonOffsetAndEndShipper(shipmentID string, rate *Rate, insurance string, endShipperID string) (out *Shipment, err error)

+ func (c *Client) BuyShipmentWithCarbonOffsetAndEndShipperWithContext(ctx context.Context, shipmentID string, rate *Rate, insurance string, ...) (out *Shipment, err error)

+ func (c *Client) BuyShipmentWithEndShipper(shipmentID string, rate *Rate, insurance string, endShipperID string) (out *Shipment, err error)

+ func (c *Client) BuyShipmentWithEndShipperWithContext(ctx context.Context, shipmentID string, rate *Rate, insurance string, ...) (out *Shipment, err error)

+ func (c *Client) CreateReferralCustomer(in *UserOptions) (out *ReferralCustomer, err error)

+ func (c *Client) CreateReferralCustomerWithContext(ctx context.Context, in *UserOptions) (out *ReferralCustomer, err error)

+ func (c *Client) ListReferralCustomers(opts *ListOptions) (out *ListReferralCustomersResult, err error)

+ func (c *Client) ListReferralCustomersWithContext(ctx context.Context, opts *ListOptions) (out *ListReferralCustomersResult, err error)

+ func (c *Client) UpdateReferralCustomerEmail(userId string, email string) (out *ReferralCustomer, err error)

+ func (c *Client) UpdateReferralCustomerEmailWithContext(ctx context.Context, userId string, email string) (out *ReferralCustomer, err error)

+ type CreditCardOptions struct

+ Cvc string

+ ExpMonth string

+ ExpYear string

+ Number string

+ type ListReferralCustomersResult struct

+ HasMore bool

+ ReferralCustomers []*ReferralCustomer

+ type ReferralCustomer struct

type ShipmentOptions

+ EndShipperID string

type UserOptions

+ Phone *string

v2.7.0

Aug 25, 2022

Changes in this version

type Client

+ func (c *Client) CreateEndShipper(in *Address) (out *Address, err error)

+ func (c *Client) CreateEndShipperWithContext(ctx context.Context, in *Address) (out *Address, err error)

+ func (c *Client) GetEndShipper(endshipperID string) (out *Address, err error)

+ func (c *Client) GetEndShipperWithContext(ctx context.Context, endshipperID string) (out *Address, err error)

+ func (c *Client) ListEndShippers(opts *ListOptions) (out *ListEndShipperResult, err error)

+ func (c *Client) ListEndShippersWithContext(ctx context.Context, opts *ListOptions) (out *ListEndShipperResult, err error)

+ func (c *Client) UpdateEndShippers(in *Address) (out *Address, err error)

+ func (c *Client) UpdateEndShippersWithContext(ctx context.Context, in *Address) (out *Address, err error)

+ type ListEndShipperResult struct

+ EndShippers []*Address

+ HasMore bool

type ShipmentOptions

+ DutyPayment *Payment

+ DutyPaymentAccount string

v2.6.0

Aug 2, 2022

Changes in this version

+ type CarbonOffset struct

+ Currency string

+ Grams int64

+ Object string

+ Price string

type Client

+ func (c *Client) BuyShipmentWithCarbonOffset(shipmentID string, rate *Rate, insurance string) (out *Shipment, err error)

+ func (c *Client) BuyShipmentWithCarbonOffsetWithContext(ctx context.Context, shipmentID string, rate *Rate, insurance string) (out *Shipment, err error)

+ func (c *Client) CreateShipmentWithCarbonOffset(in *Shipment) (out *Shipment, err error)

+ func (c *Client) CreateShipmentWithCarbonOffsetWithContext(ctx context.Context, in *Shipment) (out *Shipment, err error)

+ func (c *Client) RerateShipmentWithCarbonOffset(shipmentID string) (out []*Rate, err error)

+ func (c *Client) RerateShipmentWithCarbonOffsetWithContext(ctx context.Context, shipmentID string) (out []*Rate, err error)

+ func (c *Client) ValidateWebhook(eventBody []byte, headers map[string]interface{}, webhookSecret string) (out *Event, err error)

+ func (c *Client) ValidateWebhookWithContext(ctx context.Context, eventBody []byte, headers map[string]interface{}, ...) (out *Event, err error)

type Rate

+ CarbonOffset *CarbonOffset

v2.5.0

Jul 18, 2022

Changes in this version

type Client

+ func (c *Client) GenerateShipmentForm(shipmentID string, formType string) (out *Shipment, err error)

+ func (c *Client) GenerateShipmentFormWithContext(ctx context.Context, shipmentID string, formType string) (out *Shipment, err error)

+ func (c *Client) GenerateShipmentFormWithOptions(shipmentID string, formType string, formOptions map[string]interface{}) (out *Shipment, err error)

+ func (c *Client) GenerateShipmentFormWithOptionsWithContext(ctx context.Context, shipmentID string, formType string, ...) (out *Shipment, err error)

v2.4.0

Jul 11, 2022

Changes in this version

type CarrierAccount

+ BillingType string

type Client

+ func (c *Client) CreateWebhookWithDetails(data *CreateUpdateWebhookOptions) (out *Webhook, err error)

+ func (c *Client) CreateWebhookWithDetailsWithContext(ctx context.Context, data *CreateUpdateWebhookOptions) (out *Webhook, err error)

+ func (c *Client) DeletePaymentMethod(priority PaymentMethodPriority) (err error)

+ func (c *Client) DeletePaymentMethodWithContext(ctx context.Context, priority PaymentMethodPriority) (err error)

+ func (c *Client) FundWallet(amount string, priority PaymentMethodPriority) (err error)

+ func (c *Client) FundWalletWithContext(ctx context.Context, amount string, priority PaymentMethodPriority) (err error)

+ func (c *Client) LowestOrderRate(order *Order) (out Rate, err error)

+ func (c *Client) LowestOrderRateWithCarrier(order *Order, carriers []string) (out Rate, err error)

+ func (c *Client) LowestOrderRateWithCarrierAndService(order *Order, carriers []string, services []string) (out Rate, err error)

+ func (c *Client) LowestPickupRate(pickup *Pickup) (out PickupRate, err error)

+ func (c *Client) LowestPickupRateWithCarrier(pickup *Pickup, carriers []string) (out PickupRate, err error)

+ func (c *Client) LowestPickupRateWithCarrierAndService(pickup *Pickup, carriers []string, services []string) (out PickupRate, err error)

+ func (c *Client) LowestShipmentRate(shipment *Shipment) (out Rate, err error)

+ func (c *Client) LowestShipmentRateWithCarrier(shipment *Shipment, carriers []string) (out Rate, err error)

+ func (c *Client) LowestShipmentRateWithCarrierAndService(shipment *Shipment, carriers []string, services []string) (out Rate, err error)

+ func (c *Client) LowestSmartrate(shipment *Shipment, deliveryDays int, deliveryAccuracy string) (out SmartRate, err error)

+ func (c *Client) RetrievePaymentMethods() (out *PaymentMethod, err error)

+ func (c *Client) RetrievePaymentMethodsWithContext(ctx context.Context) (out *PaymentMethod, err error)

+ func (c *Client) UpdateWebhook(webhookID string, data *CreateUpdateWebhookOptions) (out *Webhook, err error)

+ func (c *Client) UpdateWebhookWithContext(ctx context.Context, webhookID string, data *CreateUpdateWebhookOptions) (out *Webhook, err error)

+ type CreateUpdateWebhookOptions struct

+ URL string

+ WebhookSecret string

+ type MinifiedRate struct

+ Carrier string

+ ID string

+ Rate string

+ Service string

+ type PaymentMethod struct

+ ID string

+ Object string

+ PrimaryPaymentMethod *PaymentMethodObject

+ SecondaryPaymentMethod *PaymentMethodObject

+ type PaymentMethodObject struct

+ BankName string

+ Brand string

+ Country string

+ DisabledAt string

+ ExpirationMonth int

+ ExpirationYear int

+ ID string

+ Last4 string

+ Name string

+ Object string

+ Verified bool

+ type PaymentMethodPriority int64

+ const PrimaryPaymentMethodPriority

+ const SecondaryPaymentMethodPriority

+ type PaymentMethodType int64

+ const BankAccountPaymentType

+ const CreditCardPaymentType

type Rate

+ BillingType string

type SmartRate

+ BillingType string

type Webhook

+ WebhookSecret string

v2.3.0

Apr 13, 2022

Changes in this version

type CustomsInfo

+ Declaration string

type Report

+ AdditionalColumns []string

+ Columns []string

v2.2.0

Mar 8, 2022

Changes in this version

+ type AddressVerifyResponse struct

+ Address *Address

type Client

+ func (c *Client) CreateAndVerifyAddress(in *Address, opts *CreateAddressOptions) (out *Address, err error)

+ func (c *Client) CreateAndVerifyAddressWithContext(ctx context.Context, in *Address, opts *CreateAddressOptions) (out *Address, err error)

v2.1.0

Mar 7, 2022

Changes in this version

type Brand

+ ID string

type Client

+ func (c *Client) CreateRefund(in map[string]interface{}) (out []*Refund, err error)

+ func (c *Client) CreateRefundWithContext(ctx context.Context, in map[string]interface{}) (out []*Refund, err error)

+ func (c *Client) GetRefund(refundID string) (out *Refund, err error)

+ func (c *Client) GetRefundWithContext(ctx context.Context, refundID string) (out *Refund, err error)

+ func (c *Client) ListRefunds(opts *ListOptions) (out *ListRefundResult, err error)

+ func (c *Client) ListRefundsWithContext(ctx context.Context, opts *ListOptions) (out *ListRefundResult, err error)

type ListBatchesResult

+ Batch []*Batch

+ type ListRefundResult struct

+ HasMore bool

+ Refunds []*Refund

v2.0.1

Feb 10, 2022

Changes in this version

+ const Version

+ func BoolPtr(b bool) *bool

+ func StringPtr(s string) *string

+ func UnmarshalJSONObject(data []byte) (interface{}, error)

+ type APIError struct

+ Code string

+ Errors []*APIError

+ Field string

+ Message string

+ Status string

+ StatusCode int

+ Suggestion string

+ func (e *APIError) Error() string

+ type APIKey struct

+ CreatedAt *time.Time

+ Key string

+ Mode string

+ Object string

+ type APIKeys struct

+ Children []*APIKeys

+ ID string

+ Keys []*APIKey

+ type Address struct

+ CarrierFacility string

+ City string

+ Company string

+ Country string

+ CreatedAt *time.Time

+ Email string

+ FederalTaxID string

+ ID string

+ Mode string

+ Name string

+ Object string

+ Phone string

+ Reference string

+ Residential bool

+ State string

+ StateTaxID string

+ Street1 string

+ Street2 string

+ UpdatedAt *time.Time

+ Verifications *AddressVerifications

+ Zip string

+ type AddressVerification struct

+ Details *AddressVerificationDetails

+ Errors []*AddressVerificationFieldError

+ Success bool

+ type AddressVerificationDetails struct

+ Latitude float64

+ Longitude float64

+ TimeZone string

+ type AddressVerificationFieldError struct

+ Code string

+ Field string

+ Message string

+ Suggestion string

+ type AddressVerifications struct

+ Delivery *AddressVerification

+ ZIP4 *AddressVerification

+ type Batch struct

+ CreatedAt *time.Time

+ ID string

+ LabelURL string

+ Mode string

+ NumShipments int

+ Object string

+ Pickup *Pickup

+ Reference string

+ ScanForm *ScanForm

+ Shipments []*Shipment

+ State string

+ Status *BatchStatus

+ UpdatedAt *time.Time

+ type BatchStatus struct

+ CreationFailed int

+ PostagePurchaseFailed int

+ PostagePurchased int

+ QueuedForPurchase int

+ type Brand struct

+ Ad string

+ AdHref string

+ BackgroundColor string

+ Color string

+ Logo string

+ LogoHref string

+ Name string

+ Theme string

+ UserID string

+ type CarrierAccount struct

+ Clone bool

+ CreatedAt *time.Time

+ Credentials map[string]string

+ Description string

+ Fields *CarrierFields

+ ID string

+ Object string

+ Readable string

+ Reference string

+ TestCredentials map[string]string

+ Type string

+ UpdatedAt *time.Time

+ type CarrierField struct

+ Label string

+ Value string

+ Visibility string

+ type CarrierFields struct

+ AutoLink bool

+ Credentials map[string]*CarrierField

+ CustomWorkflow bool

+ TestCredentials map[string]*CarrierField

+ type CarrierMessage struct

+ Carrier string

+ CarrierAccountID string

+ Message string

+ Type string

+ type CarrierType struct

+ Fields *CarrierFields

+ Object string

+ Type string

+ type Client struct

+ APIKey string

+ BaseURL *url.URL

+ Client *http.Client

+ Timeout int

+ UserAgent string

+ func New(apiKey string) *Client

+ func (c *Client) AddShipmentsToBatch(batchID string, in ...*Shipment) (out *Batch, err error)

+ func (c *Client) AddShipmentsToBatchWithContext(ctx context.Context, batchID string, in ...*Shipment) (out *Batch, err error)

+ func (c *Client) BuyBatch(batchID string) (out *Batch, err error)

+ func (c *Client) BuyBatchWithContext(ctx context.Context, batchID string) (out *Batch, err error)

+ func (c *Client) BuyOrder(orderID, carrier, service string) (out *Order, err error)

+ func (c *Client) BuyOrderWithContext(ctx context.Context, orderID, carrier, service string) (out *Order, err error)

+ func (c *Client) BuyPickup(pickupID string, rate *PickupRate) (out *Pickup, err error)

+ func (c *Client) BuyPickupWithContext(ctx context.Context, pickupID string, rate *PickupRate) (out *Pickup, err error)

+ func (c *Client) BuyShipment(shipmentID string, rate *Rate, insurance string) (out *Shipment, err error)

+ func (c *Client) BuyShipmentWithContext(ctx context.Context, shipmentID string, rate *Rate, insurance string) (out *Shipment, err error)

+ func (c *Client) CancelPickup(pickupID string) (out *Pickup, err error)

+ func (c *Client) CancelPickupWithContext(ctx context.Context, pickupID string) (out *Pickup, err error)

+ func (c *Client) CreateAddress(in *Address, opts *CreateAddressOptions) (out *Address, err error)

+ func (c *Client) CreateAddressWithContext(ctx context.Context, in *Address, opts *CreateAddressOptions) (out *Address, err error)

+ func (c *Client) CreateAndBuyBatch(in ...*Shipment) (out *Batch, err error)

+ func (c *Client) CreateAndBuyBatchWithContext(ctx context.Context, in ...*Shipment) (out *Batch, err error)

+ func (c *Client) CreateBatch(in ...*Shipment) (out *Batch, err error)

+ func (c *Client) CreateBatchScanForms(batchID, format string) (out *Batch, err error)

+ func (c *Client) CreateBatchScanFormsWithContext(ctx context.Context, batchID, format string) (out *Batch, err error)

+ func (c *Client) CreateBatchWithContext(ctx context.Context, in ...*Shipment) (out *Batch, err error)

+ func (c *Client) CreateCarrierAccount(in *CarrierAccount) (out *CarrierAccount, err error)

+ func (c *Client) CreateCarrierAccountWithContext(ctx context.Context, in *CarrierAccount) (out *CarrierAccount, err error)

+ func (c *Client) CreateCustomsInfo(in *CustomsInfo) (out *CustomsInfo, err error)

+ func (c *Client) CreateCustomsInfoWithContext(ctx context.Context, in *CustomsInfo) (out *CustomsInfo, err error)

+ func (c *Client) CreateCustomsItem(in *CustomsItem) (out *CustomsItem, err error)

+ func (c *Client) CreateCustomsItemWithContext(ctx context.Context, in *CustomsItem) (out *CustomsItem, err error)

+ func (c *Client) CreateInsurance(in *Insurance) (out *Insurance, err error)

+ func (c *Client) CreateInsuranceWithContext(ctx context.Context, in *Insurance) (out *Insurance, err error)

+ func (c *Client) CreateOrder(in *Order, accounts ...*CarrierAccount) (out *Order, err error)

+ func (c *Client) CreateOrderWithContext(ctx context.Context, in *Order, accounts ...*CarrierAccount) (out *Order, err error)

+ func (c *Client) CreateParcel(in *Parcel) (out *Parcel, err error)

+ func (c *Client) CreateParcelWithContext(ctx context.Context, in *Parcel) (out *Parcel, err error)

+ func (c *Client) CreatePickup(in *Pickup) (out *Pickup, err error)

+ func (c *Client) CreatePickupWithContext(ctx context.Context, in *Pickup) (out *Pickup, err error)

+ func (c *Client) CreateReport(typ string, in *Report) (out *Report, err error)

+ func (c *Client) CreateReportWithContext(ctx context.Context, typ string, in *Report) (out *Report, err error)

+ func (c *Client) CreateScanForm(shipmentIDs ...string) (out *ScanForm, err error)

+ func (c *Client) CreateScanFormWithContext(ctx context.Context, shipmentIDs ...string) (out *ScanForm, err error)

+ func (c *Client) CreateShipment(in *Shipment) (out *Shipment, err error)

+ func (c *Client) CreateShipmentWithContext(ctx context.Context, in *Shipment) (out *Shipment, err error)

+ func (c *Client) CreateTracker(opts *CreateTrackerOptions) (out *Tracker, err error)

+ func (c *Client) CreateTrackerList(param map[string]interface{}) (bool, error)

+ func (c *Client) CreateTrackerListWithContext(ctx context.Context, param map[string]interface{}) (bool, error)

+ func (c *Client) CreateTrackerWithContext(ctx context.Context, opts *CreateTrackerOptions) (out *Tracker, err error)

+ func (c *Client) CreateUser(in *UserOptions) (out *User, err error)

+ func (c *Client) CreateUserWithContext(ctx context.Context, in *UserOptions) (out *User, err error)

+ func (c *Client) CreateWebhook(u string) (out *Webhook, err error)

+ func (c *Client) CreateWebhookWithContext(ctx context.Context, u string) (out *Webhook, err error)

+ func (c *Client) DeleteCarrierAccount(carrierAccountID string) error

+ func (c *Client) DeleteCarrierAccountWithContext(ctx context.Context, carrierAccountID string) error

+ func (c *Client) DeleteUser(userID string) error

+ func (c *Client) DeleteUserWithContext(ctx context.Context, userID string) error

+ func (c *Client) DeleteWebhook(webhookID string) error

+ func (c *Client) DeleteWebhookWithContext(ctx context.Context, webhookID string) error

+ func (c *Client) EnableWebhook(webhookID string) (out *Webhook, err error)

+ func (c *Client) EnableWebhookWithContext(ctx context.Context, webhookID string) (out *Webhook, err error)

+ func (c *Client) GetAPIKeys() (out *APIKeys, err error)

+ func (c *Client) GetAPIKeysWithContext(ctx context.Context) (out *APIKeys, err error)

+ func (c *Client) GetAddress(addressID string) (out *Address, err error)

+ func (c *Client) GetAddressWithContext(ctx context.Context, addressID string) (out *Address, err error)

+ func (c *Client) GetBatch(batchID string) (out *Batch, err error)

+ func (c *Client) GetBatchLabels(batchID, format string) (out *Batch, err error)

+ func (c *Client) GetBatchLabelsWithContext(ctx context.Context, batchID, format string) (out *Batch, err error)

+ func (c *Client) GetBatchWithContext(ctx context.Context, batchID string) (out *Batch, err error)

+ func (c *Client) GetCarrierAccount(carrierAccountID string) (out *CarrierAccount, err error)

+ func (c *Client) GetCarrierAccountWithContext(ctx context.Context, carrierAccountID string) (out *CarrierAccount, err error)

+ func (c *Client) GetCarrierTypes() (out []*CarrierType, err error)

+ func (c *Client) GetCarrierTypesWithContext(ctx context.Context) (out []*CarrierType, err error)

+ func (c *Client) GetCustomsInfo(customsInfoID string) (out *CustomsInfo, err error)

+ func (c *Client) GetCustomsInfoWithContext(ctx context.Context, customsInfoID string) (out *CustomsInfo, err error)

+ func (c *Client) GetCustomsItem(customsItemID string) (out *CustomsItem, err error)

+ func (c *Client) GetCustomsItemWithContext(ctx context.Context, customsItemID string) (out *CustomsItem, err error)

+ func (c *Client) GetEvent(eventID string) (out *Event, err error)

+ func (c *Client) GetEventWithContext(ctx context.Context, eventID string) (out *Event, err error)

+ func (c *Client) GetInsurance(insuranceID string) (out *Insurance, err error)

+ func (c *Client) GetInsuranceWithContext(ctx context.Context, insuranceID string) (out *Insurance, err error)

+ func (c *Client) GetOrder(orderID string) (out *Order, err error)

+ func (c *Client) GetOrderRates(orderID string) (out *Order, err error)

+ func (c *Client) GetOrderRatesWithContext(ctx context.Context, orderID string) (out *Order, err error)

+ func (c *Client) GetOrderWithContext(ctx context.Context, orderID string) (out *Order, err error)

+ func (c *Client) GetParcel(parcelID string) (out *Parcel, err error)

+ func (c *Client) GetParcelWithContext(ctx context.Context, parcelID string) (out *Parcel, err error)

+ func (c *Client) GetPickup(pickupID string) (out *Pickup, err error)

+ func (c *Client) GetPickupWithContext(ctx context.Context, pickupID string) (out *Pickup, err error)

+ func (c *Client) GetRate(rateID string) (out *Rate, err error)

+ func (c *Client) GetRateWithContext(ctx context.Context, rateID string) (out *Rate, err error)

+ func (c *Client) GetReport(typ, reportID string) (out *Report, err error)

+ func (c *Client) GetReportWithContext(ctx context.Context, typ, reportID string) (out *Report, err error)

+ func (c *Client) GetScanForm(scanFormID string) (out *ScanForm, err error)

+ func (c *Client) GetScanFormWithContext(ctx context.Context, scanFormID string) (out *ScanForm, err error)

+ func (c *Client) GetShipment(shipmentID string) (out *Shipment, err error)

+ func (c *Client) GetShipmentLabel(shipmentID, format string) (out *Shipment, err error)

+ func (c *Client) GetShipmentLabelWithContext(ctx context.Context, shipmentID, format string) (out *Shipment, err error)

+ func (c *Client) GetShipmentSmartrates(shipmentID string) (out []*SmartRate, err error)

+ func (c *Client) GetShipmentSmartratesWithContext(ctx context.Context, shipmentID string) (out []*SmartRate, err error)

+ func (c *Client) GetShipmentWithContext(ctx context.Context, shipmentID string) (out *Shipment, err error)

+ func (c *Client) GetTracker(trackerID string) (out *Tracker, err error)

+ func (c *Client) GetTrackerWithContext(ctx context.Context, trackerID string) (out *Tracker, err error)

+ func (c *Client) GetUser(userID string) (out *User, err error)

+ func (c *Client) GetUserWithContext(ctx context.Context, userID string) (out *User, err error)

+ func (c *Client) GetWebhook(webhookID string) (out *Webhook, err error)

+ func (c *Client) GetWebhookWithContext(ctx context.Context, webhookID string) (out *Webhook, err error)

+ func (c *Client) InsureShipment(shipmentID, amount string) (out *Shipment, err error)

+ func (c *Client) InsureShipmentWithContext(ctx context.Context, shipmentID, amount string) (out *Shipment, err error)

+ func (c *Client) ListAddresses(opts *ListOptions) (out *ListAddressResult, err error)

+ func (c *Client) ListAddressesWithContext(ctx context.Context, opts *ListOptions) (out *ListAddressResult, err error)

+ func (c *Client) ListBatches(opts *ListOptions) (out *ListBatchesResult, err error)

+ func (c *Client) ListBatchesWithContext(ctx context.Context, opts *ListOptions) (out *ListBatchesResult, err error)

+ func (c *Client) ListCarrierAccounts() (out []*CarrierAccount, err error)

+ func (c *Client) ListCarrierAccountsWithContext(ctx context.Context) (out []*CarrierAccount, err error)

+ func (c *Client) ListEventPayloads(eventID string) (out []*EventPayload, err error)

+ func (c *Client) ListEventPayloadsWithContext(ctx context.Context, eventID string) (out []*EventPayload, err error)

+ func (c *Client) ListEvents(opts *ListOptions) (out *ListEventsResult, err error)

+ func (c *Client) ListEventsWithContext(ctx context.Context, opts *ListOptions) (out *ListEventsResult, err error)

+ func (c *Client) ListInsurances(opts *ListOptions) (out *ListInsurancesResult, err error)

+ func (c *Client) ListInsurancesWithContext(ctx context.Context, opts *ListOptions) (out *ListInsurancesResult, err error)

+ func (c *Client) ListReports(typ string, opts *ListReportsOptions) (out *ListReportsResult, err error)

+ func (c *Client) ListReportsWithContext(ctx context.Context, typ string, opts *ListReportsOptions) (out *ListReportsResult, err error)

+ func (c *Client) ListScanForms(opts *ListOptions) (out *ListScanFormsResult, err error)

+ func (c *Client) ListScanFormsWithContext(ctx context.Context, opts *ListOptions) (out *ListScanFormsResult, err error)

+ func (c *Client) ListShipments(opts *ListShipmentsOptions) (out *ListShipmentsResult, err error)

+ func (c *Client) ListShipmentsWithContext(ctx context.Context, opts *ListShipmentsOptions) (out *ListShipmentsResult, err error)

+ func (c *Client) ListTrackers(opts *ListTrackersOptions) (out *ListTrackersResult, err error)

+ func (c *Client) ListTrackersWithContext(ctx context.Context, opts *ListTrackersOptions) (out *ListTrackersResult, err error)

+ func (c *Client) ListWebhooks() (out []*Webhook, err error)

+ func (c *Client) ListWebhooksWithContext(ctx context.Context) (out []*Webhook, err error)

+ func (c *Client) LowestRate(shipment *Shipment) (out Rate, err error)

+ func (c *Client) LowestRateWithCarrier(shipment *Shipment, carriers []string) (out Rate, err error)

+ func (c *Client) LowestRateWithCarrierAndService(shipment *Shipment, carriers []string, services []string) (out Rate, err error)

+ func (c *Client) RefundShipment(shipmentID string) (out *Shipment, err error)

+ func (c *Client) RefundShipmentWithContext(ctx context.Context, shipmentID string) (out *Shipment, err error)

+ func (c *Client) RemoveShipmentsFromBatch(batchID string, shipmentIDs ...string) (out *Batch, err error)

+ func (c *Client) RemoveShipmentsFromBatchWithContext(ctx context.Context, batchID string, shipmentIDs ...string) (out *Batch, err error)

+ func (c *Client) RerateShipment(shipmentID string) (out []*Rate, err error)

+ func (c *Client) RerateShipmentWithContext(ctx context.Context, shipmentID string) (out []*Rate, err error)

+ func (c *Client) RetrieveMe() (out *User, err error)

+ func (c *Client) RetrieveMeWithContext(ctx context.Context) (out *User, err error)

+ func (c *Client) UpdateBrand(params map[string]interface{}, userID string) (out *Brand, err error)

+ func (c *Client) UpdateBrandWithContext(ctx context.Context, params map[string]interface{}, userID string) (out *Brand, err error)

+ func (c *Client) UpdateCarrierAccount(in *CarrierAccount) (out *CarrierAccount, err error)

+ func (c *Client) UpdateCarrierAccountWithContext(ctx context.Context, in *CarrierAccount) (out *CarrierAccount, err error)

+ func (c *Client) UpdateUser(in *UserOptions) (out *User, err error)

+ func (c *Client) UpdateUserWithContext(ctx context.Context, in *UserOptions) (out *User, err error)

+ func (c *Client) VerifyAddress(addressID string) (out *Address, err error)

+ func (c *Client) VerifyAddressWithContext(ctx context.Context, addressID string) (out *Address, err error)

+ type CreateAddressOptions struct

+ Verify []string

+ VerifyStrict []string

+ type CreateTrackerOptions struct

+ Amount string

+ Carrier string

+ CarrierAccount string

+ FullTestTracker bool

+ IsReturn bool

+ TrackingCode string

+ type CustomsInfo struct

+ ContentsExplanation string

+ ContentsType string

+ CreatedAt *time.Time

+ CustomsCertify bool

+ CustomsItems []*CustomsItem

+ CustomsSigner string

+ EELPFC string

+ ID string

+ NonDeliveryOption string

+ Object string

+ RestrictionType string

+ UpdatedAt *time.Time

+ type CustomsItem struct

+ Code string

+ CreatedAt *time.Time

+ Currency string

+ Description string

+ HSTariffNumber string

+ ID string

+ Object string

+ OriginCountry string

+ Quantity float64

+ UpdatedAt *time.Time

+ Value float64

+ Weight float64

+ type Event struct

+ CompletedURLs []string

+ CreatedAt *time.Time

+ Description string

+ ID string

+ Mode string

+ Object string

+ PendingURLs []string

+ PreviousAttributes map[string]interface{}

+ Result interface{}

+ Status string

+ UpdatedAt *time.Time

+ UserID string

+ func (e *Event) UnmarshalJSON(data []byte) (err error)

+ type EventPayload struct

+ CreatedAt *time.Time

+ ID string

+ Object string

+ RequestBody interface{}

+ RequestHeaders map[string]string

+ RequestURL string

+ ResponseBody string

+ ResponseCode int

+ ResponseHeaders map[string]string

+ TotalTime int

+ UpdatedAt *time.Time

+ func (e *EventPayload) UnmarshalJSON(data []byte) (err error)

+ type Fee struct

+ Amount string

+ Charged bool

+ Object string

+ Refunded bool

+ Type string

+ type Form struct

+ CreatedAt *time.Time

+ FormType string

+ FormURL string

+ ID string

+ Mode string

+ Object string

+ SubmittedElectronically bool

+ UpdatedAt *time.Time

+ type Insurance struct

+ Amount string

+ Carrier string

+ CreatedAt *time.Time

+ Fee *Fee

+ FromAddress *Address

+ ID string

+ Messages []string

+ Mode string

+ Object string

+ Provider string

+ ProviderID string

+ Reference string

+ ShipmentID string

+ Status string

+ ToAddress *Address

+ Tracker *Tracker

+ TrackingCode string

+ UpdatedAt *time.Time

+ type ListAddressResult struct

+ Addresses []*Address

+ HasMore bool

+ type ListBatchesResult struct

+ HasMore bool

+ Insurances []*Insurance

+ type ListEventsResult struct

+ Events []*Event

+ HasMore bool

+ type ListInsurancesResult struct

+ HasMore bool

+ Insurances []*Insurance

+ type ListOptions struct

+ AfterID string

+ BeforeID string

+ EndDateTime *time.Time

+ PageSize int

+ StartDateTime *time.Time

+ type ListReportsOptions struct

+ AfterID string

+ BeforeID string

+ EndDate string

+ PageSize int

+ StartDate string

+ type ListReportsResult struct

+ HasMore bool

+ Reports []*Report

+ type ListScanFormsResult struct

+ HasMore bool

+ ScanForms []*ScanForm

+ type ListShipmentsOptions struct

+ AfterID string

+ BeforeID string

+ EndDateTime *time.Time

+ IncludeChildren *bool

+ PageSize int

+ Purchased *bool

+ StartDateTime *time.Time

+ type ListShipmentsResult struct

+ HasMore bool

+ Shipments []*Shipment

+ type ListTrackersOptions struct

+ AfterID string

+ BeforeID string

+ Carrier string

+ EndDateTime *time.Time

+ PageSize int

+ StartDateTime *time.Time

+ TrackingCodes []string

+ type ListTrackersResult struct

+ HasMore bool

+ Trackers []*Tracker

+ type ListTrackersUpdatedOptions struct

+ Page int

+ PageSize int

+ StatusEnd *time.Time

+ StatusStart *time.Time

+ TrackingDetailsEnd *time.Time

+ TrackingDetailsStart *time.Time

+ type Order struct

+ BuyerAddress *Address

+ CreatedAt *time.Time

+ FromAddress *Address

+ ID string

+ IsReturn bool

+ Messages []*CarrierMessage

+ Mode string

+ Object string

+ Rates []*Rate

+ Reference string

+ ReturnAddress *Address

+ Service string

+ Shipments []*Shipment

+ ToAddress *Address

+ UpdatedAt *time.Time

+ type Parcel struct

+ CreatedAt *time.Time

+ Height float64

+ ID string

+ Length float64

+ Mode string

+ Object string

+ PredefinedPackage string

+ UpdatedAt *time.Time

+ Weight float64

+ Width float64

+ type Payment struct

+ Account string

+ Country string

+ PostalCode string

+ Type string

+ type PaymentLog struct

+ Amount string

+ ChargeType string

+ CreatedAt *time.Time

+ Date string

+ ID string

+ Last4 string

+ Object string

+ SourceType string

+ Status string

+ TargetType string

+ UpdatedAt *time.Time

+ type Pickup struct

+ Address *Address

+ Batch *Batch

+ CarrierAccounts []*CarrierAccount

+ Confirmation string

+ CreatedAt *time.Time

+ ID string

+ Instructions string

+ IsAccountAddress bool

+ MaxDatetime *time.Time

+ Messages []*CarrierMessage

+ MinDatetime *time.Time

+ Mode string

+ Object string

+ PickupRates []*PickupRate

+ Reference string

+ Shipment *Shipment

+ Status string

+ UpdatedAt *time.Time

+ type PickupRate struct

+ Carrier string

+ CreatedAt *time.Time

+ Currency string

+ ID string

+ Mode string

+ Object string

+ PickupID string

+ Rate string

+ Service string

+ UpdatedAt *time.Time

+ type PostageLabel struct

+ CreatedAt *time.Time

+ ID string

+ IntegratedForm string

+ LabelDate *time.Time

+ LabelEPL2URL string

+ LabelFileType string

+ LabelPDFURL string

+ LabelResolution float64

+ LabelSize string

+ LabelType string

+ LabelURL string

+ LabelZPLURL string

+ Object string

+ UpdatedAt *time.Time

+ type Rate struct

+ Carrier string

+ CarrierAccountID string

+ CreatedAt *time.Time

+ Currency string

+ DeliveryDate *time.Time

+ DeliveryDateGuaranteed bool

+ DeliveryDays int

+ EstDeliveryDays int

+ ID string

+ ListCurrency string

+ ListRate string

+ Mode string

+ Object string

+ Rate string

+ RetailCurrency string

+ RetailRate string

+ Service string

+ ShipmentID string

+ UpdatedAt *time.Time

+ type Refund struct

+ Carrier string

+ ConfirmationNumber string

+ CreatedAt *time.Time

+ ID string

+ Object string

+ ShipmentID string

+ Status string

+ TrackingCode string

+ UpdatedAt *time.Time

+ type Report struct

+ CreatedAt *time.Time

+ EndDate string

+ ID string

+ IncludeChildren bool

+ Mode string

+ Object string

+ SendEmail bool

+ StartDate string

+ Status string

+ URL string

+ URLExpiresAt *time.Time

+ UpdatedAt *time.Time

+ type ScanForm struct

+ Address *Address

+ BatchID string

+ CreatedAt *time.Time

+ FormFileType string

+ FormURL string

+ ID string

+ Message string

+ Object string

+ Status string

+ TrackingCodes []string

+ UpdatedAt *time.Time

+ type Shipment struct

+ BatchID string

+ BatchMessage string

+ BatchStatus string

+ BuyerAddress *Address

+ Carrier string

+ CarrierAccountIDs []string

+ CreatedAt *time.Time

+ CustomsInfo *CustomsInfo

+ Fees []*Fee

+ Forms []*Form

+ FromAddress *Address

+ ID string

+ Insurance string

+ IsReturn bool

+ Messages []*CarrierMessage

+ Mode string

+ Object string

+ Options *ShipmentOptions

+ Parcel *Parcel

+ PostageLabel *PostageLabel

+ Rates []*Rate

+ Reference string

+ RefundStatus string

+ ReturnAddress *Address

+ ScanForm *ScanForm

+ SelectedRate *Rate

+ Service string

+ Status string

+ TaxIdentifiers []*TaxIdentifier

+ ToAddress *Address

+ Tracker *Tracker

+ TrackingCode string

+ USPSZone int

+ UpdatedAt *time.Time

+ type ShipmentOptions struct

+ AdditionalHandling bool

+ AddressValidationLevel string

+ Alcohol bool

+ BillReceiverAccount string

+ BillReceiverPostalCode string

+ BillThirdPartyAccount string

+ BillThirdPartyCountry string

+ BillThirdPartyPostalCode string

+ BillingRef string

+ ByDrone bool

+ CODAddressID string

+ CODAmount string

+ CODMethod string

+ CarbonNeutral bool

+ CertifiedMail bool

+ Currency string

+ DeliveryConfirmation string

+ DropoffType string

+ DryIce bool

+ DryIceMedical bool

+ DryIceWeight float64

+ Endorsement string

+ FreightCharge float64

+ HandlingInstructions string

+ Hazmat string

+ HoldForPickup bool

+ Incoterm string

+ InvoiceNumber string

+ LabelDate *time.Time

+ LabelFormat string

+ Machinable bool

+ Payment *Payment

+ PrintCustom1 string

+ PrintCustom1BarCode bool

+ PrintCustom1Code string

+ PrintCustom2 string

+ PrintCustom2BarCode bool

+ PrintCustom2Code string

+ PrintCustom3 string

+ PrintCustom3BarCode bool

+ PrintCustom3Code string

+ RegisteredMail bool

+ RegisteredMailAmount float64

+ ReturnReceipt bool

+ SaturdayDelivery bool

+ SmartpostHub string

+ SmartpostManifest string

+ SpecialRatesEligibility string

+ type SmartRate struct

+ Carrier string

+ CarrierAccountID string

+ CreatedAt *time.Time

+ Currency string

+ DeliveryDate *time.Time

+ DeliveryDateGuaranteed bool

+ DeliveryDays int

+ EstDeliveryDays int

+ ID string

+ ListCurrency string

+ ListRate float64

+ Mode string

+ Object string

+ Rate float64

+ RetailCurrency string

+ RetailRate float64

+ Service string

+ ShipmentID string

+ TimeInTransit *TimeInTransit

+ UpdatedAt *time.Time

+ type TaxIdentifier struct

+ Entity string

+ IssuingCountry string

+ TaxId string

+ TaxIdType string

+ type TimeInTransit struct

+ Percentile50 int

+ Percentile75 int

+ Percentile85 int

+ Percentile90 int

+ Percentile95 int

+ Percentile97 int

+ Percentile99 int

+ type Tracker struct

+ Carrier string

+ CarrierDetail *TrackingCarrierDetail

+ CreatedAt *time.Time

+ EstDeliveryDate *time.Time

+ Fees []*Fee

+ Finalized bool

+ ID string

+ IsReturn bool

+ Mode string

+ Object string

+ PublicURL string

+ ShipmentID string

+ SignedBy string

+ Status string

+ TrackingCode string

+ TrackingDetails []*TrackingDetail

+ UpdatedAt *time.Time

+ Weight float64

+ type TrackingCarrierDetail struct

+ AlternateIdentifier string

+ ContainerType string

+ DestinationLocation string

+ DestinationTrackingLocation *TrackingLocation

+ EstDeliveryDateLocal string

+ EstDeliveryTimeLocal string

+ GuaranteedDeliveryDate *time.Time

+ InitialDeliveryAttempt *time.Time

+ Object string

+ OriginLocation string

+ OriginTrackingLocation *TrackingLocation

+ Service string

+ type TrackingDetail struct

+ CarrierCode string

+ DateTime string

+ Description string

+ Message string

+ Object string

+ Source string

+ Status string

+ TrackingLocation *TrackingLocation

+ type TrackingLocation struct

+ City string

+ Country string

+ Object string

+ State string

+ Zip string

+ type User struct

+ APIKeys []*APIKey

+ Balance string

+ Children []*User

+ Email string

+ ID string

+ Name string

+ Object string

+ ParentID string

+ PhoneNumber string

+ RechargeAmount string

+ RechargeThreshold string

+ SecondaryRechargeAmount string

+ type UserOptions struct

+ CurrentPassword *string

+ Email *string

+ ID string

+ Name *string

+ Password *string

+ PasswordConfirmation *string

+ PhoneNumber *string

+ RechargeAmount *string

+ RechargeThreshold *string

+ SecondaryRechargeAmount *string

+ type Webhook struct

+ DisabledAt *time.Time

+ ID string

+ Mode string

+ Object string

+ URL string

Other modules containing this package

github.com/EasyPost/easypost-go

github.com/EasyPost/easypost-go/v3

github.com/EasyPost/easypost-go/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL