Documentation

Application

Interfaces, Classes, Traits and Enums

Constants
EasyPostObject
BadRequestException
EncodingException
ExternalApiException
ForbiddenException
GatewayTimeoutException
HttpException
InternalServerException
InvalidRequestException
JsonException
MethodNotAllowedException
NotFoundException
PaymentException
RateLimitException
RedirectException
ServiceUnavailableException
TimeoutException
UnauthorizedException
UnknownApiException
EndOfPaginationException
FilteringException
InvalidObjectException
InvalidParameterException
MissingParameterException
SignatureVerificationException
EventHook
The parent event that occurs when a hook is triggered.
RequestHook
An event that gets triggered when an HTTP request begins.
ResponseHook
An event that gets triggered when an HTTP response is returned.
Requestor
AddressService
Address service containing all the logic to make API calls.
ApiKeyService
API key service containing all the logic to make API calls.
BaseService
BatchService
Batch service containing all the logic to make API calls.
BetaRateService
Rate service containing all the logic to make API calls.
BetaReferralCustomerService
ReferralCustomer service containing all the logic to make API calls.
BillingService
Billing service containing all the logic to make API calls.
CarrierAccountService
CarrierAccount service containing all the logic to make API calls.
CarrierMetadataService
CarrierMetadata service containing all the logic to make API calls.
ClaimService
Claim service containing all the logic to make API calls.
CustomsInfoService
CustomsInfo service containing all the logic to make API calls.
CustomsItemService
CustomsItem service containing all the logic to make API calls.
EndShipperService
EndShipper service containing all the logic to make API calls.
EventService
Event service containing all the logic to make API calls.
InsuranceService
Insurance service containing all the logic to make API calls.
OrderService
Order service containing all the logic to make API calls.
ParcelService
Parcel service containing all the logic to make API calls.
PickupService
Pickup service containing all the logic to make API calls.
RateService
Rate service containing all the logic to make API calls.
ReferralCustomerService
ReferralCustomer service containing all the logic to make API calls.
RefundService
Refund service containing all the logic to make API calls.
ReportService
Report service containing all the logic to make API calls.
ScanFormService
Report service containing all the logic to make API calls.
ShipmentService
Shipment service containing all the logic to make API calls.
SmartRateService
SmartRate service containing all the details of SmartRate requests.
TrackerService
Tracker service containing all the logic to make API calls.
UserService
User service containing all the logic to make API calls.
WebhookService
Webhook service containing all the logic to make API calls.
InternalUtil
Util

Table of Contents

OBJECT_ID_PREFIXES  = ['adr' => \EasyPost\Address::class, 'ak' => \EasyPost\ApiKey::class, 'batch' => \EasyPost\Batch::class, 'brd' => \EasyPost\Brand::class, 'ca' => \EasyPost\CarrierAccount::class, 'cstinfo' => \EasyPost\CustomsInfo::class, 'cstitem' => \EasyPost\CustomsItem::class, 'es' => \EasyPost\EndShipper::class, 'evt' => \EasyPost\Event::class, 'fee' => \EasyPost\Fee::class, 'hook' => \EasyPost\Webhook::class, 'ins' => \EasyPost\Insurance::class, 'order' => \EasyPost\Order::class, 'pickup' => \EasyPost\Pickup::class, 'pl' => \EasyPost\PostageLabel::class, 'plrep' => \EasyPost\Report::class, 'prcl' => \EasyPost\Parcel::class, 'rate' => \EasyPost\Rate::class, 'refrep' => \EasyPost\Report::class, 'rfnd' => \EasyPost\Refund::class, 'sf' => \EasyPost\ScanForm::class, 'shp' => \EasyPost\Shipment::class, 'shpinvrep' => \EasyPost\Report::class, 'shprep' => \EasyPost\Report::class, 'trk' => \EasyPost\Tracker::class, 'trkrep' => \EasyPost\Report::class, 'user' => \EasyPost\User::class]
OBJECT_MAPPING  = ['Address' => \EasyPost\Address::class, 'ApiKey' => \EasyPost\ApiKey::class, 'Batch' => \EasyPost\Batch::class, 'Brand' => \EasyPost\Brand::class, 'CarrierAccount' => \EasyPost\CarrierAccount::class, 'CarrierDetail' => \EasyPost\CarrierDetail::class, 'Claim' => \EasyPost\Claim::class, 'CustomsInfo' => \EasyPost\CustomsInfo::class, 'CustomsItem' => \EasyPost\CustomsItem::class, 'EndShipper' => \EasyPost\EndShipper::class, 'Event' => \EasyPost\Event::class, 'Fee' => \EasyPost\Fee::class, 'Insurance' => \EasyPost\Insurance::class, 'Order' => \EasyPost\Order::class, 'Parcel' => \EasyPost\Parcel::class, 'PaymentLogReport' => \EasyPost\Report::class, 'Pickup' => \EasyPost\Pickup::class, 'PickupRate' => \EasyPost\PickupRate::class, 'PostageLabel' => \EasyPost\PostageLabel::class, 'Rate' => \EasyPost\Rate::class, 'Refund' => \EasyPost\Refund::class, 'RefundReport' => \EasyPost\Report::class, 'Report' => \EasyPost\Report::class, 'ScanForm' => \EasyPost\ScanForm::class, 'Shipment' => \EasyPost\Shipment::class, 'ShipmentInvoiceReport' => \EasyPost\Report::class, 'ShipmentReport' => \EasyPost\Report::class, 'TaxIdentifier' => \EasyPost\TaxIdentifier::class, 'Tracker' => \EasyPost\Tracker::class, 'TrackerReport' => \EasyPost\Report::class, 'TrackingDetail' => \EasyPost\TrackingDetail::class, 'TrackingLocation' => \EasyPost\TrackingLocation::class, 'User' => \EasyPost\User::class, 'Webhook' => \EasyPost\Webhook::class]

Constants

OBJECT_ID_PREFIXES

public mixed OBJECT_ID_PREFIXES = ['adr' => \EasyPost\Address::class, 'ak' => \EasyPost\ApiKey::class, 'batch' => \EasyPost\Batch::class, 'brd' => \EasyPost\Brand::class, 'ca' => \EasyPost\CarrierAccount::class, 'cstinfo' => \EasyPost\CustomsInfo::class, 'cstitem' => \EasyPost\CustomsItem::class, 'es' => \EasyPost\EndShipper::class, 'evt' => \EasyPost\Event::class, 'fee' => \EasyPost\Fee::class, 'hook' => \EasyPost\Webhook::class, 'ins' => \EasyPost\Insurance::class, 'order' => \EasyPost\Order::class, 'pickup' => \EasyPost\Pickup::class, 'pl' => \EasyPost\PostageLabel::class, 'plrep' => \EasyPost\Report::class, 'prcl' => \EasyPost\Parcel::class, 'rate' => \EasyPost\Rate::class, 'refrep' => \EasyPost\Report::class, 'rfnd' => \EasyPost\Refund::class, 'sf' => \EasyPost\ScanForm::class, 'shp' => \EasyPost\Shipment::class, 'shpinvrep' => \EasyPost\Report::class, 'shprep' => \EasyPost\Report::class, 'trk' => \EasyPost\Tracker::class, 'trkrep' => \EasyPost\Report::class, 'user' => \EasyPost\User::class]

OBJECT_MAPPING

public mixed OBJECT_MAPPING = ['Address' => \EasyPost\Address::class, 'ApiKey' => \EasyPost\ApiKey::class, 'Batch' => \EasyPost\Batch::class, 'Brand' => \EasyPost\Brand::class, 'CarrierAccount' => \EasyPost\CarrierAccount::class, 'CarrierDetail' => \EasyPost\CarrierDetail::class, 'Claim' => \EasyPost\Claim::class, 'CustomsInfo' => \EasyPost\CustomsInfo::class, 'CustomsItem' => \EasyPost\CustomsItem::class, 'EndShipper' => \EasyPost\EndShipper::class, 'Event' => \EasyPost\Event::class, 'Fee' => \EasyPost\Fee::class, 'Insurance' => \EasyPost\Insurance::class, 'Order' => \EasyPost\Order::class, 'Parcel' => \EasyPost\Parcel::class, 'PaymentLogReport' => \EasyPost\Report::class, 'Pickup' => \EasyPost\Pickup::class, 'PickupRate' => \EasyPost\PickupRate::class, 'PostageLabel' => \EasyPost\PostageLabel::class, 'Rate' => \EasyPost\Rate::class, 'Refund' => \EasyPost\Refund::class, 'RefundReport' => \EasyPost\Report::class, 'Report' => \EasyPost\Report::class, 'ScanForm' => \EasyPost\ScanForm::class, 'Shipment' => \EasyPost\Shipment::class, 'ShipmentInvoiceReport' => \EasyPost\Report::class, 'ShipmentReport' => \EasyPost\Report::class, 'TaxIdentifier' => \EasyPost\TaxIdentifier::class, 'Tracker' => \EasyPost\Tracker::class, 'TrackerReport' => \EasyPost\Report::class, 'TrackingDetail' => \EasyPost\TrackingDetail::class, 'TrackingLocation' => \EasyPost\TrackingLocation::class, 'User' => \EasyPost\User::class, 'Webhook' => \EasyPost\Webhook::class]

Search results