Download the PHP package rusdyahmad/php-easyparcel without Composer

PHP EasyParcel

A PHP wrapper for the EasyParcel API.

Installation

Requirements

• PHP 7.2 or higher
• Guzzle HTTP Client
• JSON extension

Usage

Initialization

There are multiple ways to initialize the EasyParcel client:

Method 1: Direct API Key

Method 2: Using Environment Variables (.env)

Create a .env file in your project root (copy from .env.example):

Then initialize without parameters:

Note: EasyParcel uses the same API key for both production and sandbox environments. The environment is determined by the base URL, not the API key.

Check Credit Balance

Get Shipping Rates

Using the direct method:

Using the ShipmentBuilder:

Submit Order

Pay for Order

Using the Response Class

Available Methods

EasyParcel Class

• checkBalance(): Check credit balance
• getRates(array $shipment): Get shipping rates for a single shipment
• getBulkRates(array $shipments): Get shipping rates for multiple shipments
• submitOrder(array $order): Submit a single order
• submitBulkOrders(array $orders): Submit multiple orders
• payOrder(string $orderNo): Pay for a single order
• payBulkOrders(array $orderNos): Pay for multiple orders
• getParcelCategoryList(): Get parcel category list
• getCourierList(): Get courier list
• getCourierDropoff(string $courierCode, string $postcode): Get courier dropoff points
• useSandbox(): Switch to sandbox environment
• useProduction(): Switch to production environment
• getBaseUrl(): Get the current base URL

ShipmentBuilder Class

• from(string $name, string $contact, string $address1, string $city, string $postcode, string $state, string $country): Set pickup details
• fromCompany(string $company): Set sender company name
• fromAddress2(string $address2): Set sender address line 2
• fromMobile(string $mobile): Set sender mobile number
• to(string $name, string $contact, string $address1, string $city, string $postcode, string $state, string $country): Set receiver details
• toCompany(string $company): Set receiver company name
• toAddress2(string $address2): Set receiver address line 2
• toMobile(string $mobile): Set receiver mobile number
• toEmail(string $email): Set receiver email
• withDimensions(float $weight, float $width, float $length, float $height): Set parcel dimensions
• withContent(string $content, float $value): Set parcel content
• withServiceId(string $serviceId): Set service ID
• withCollectionDate(string $date): Set collection date
• withInsurance(bool $enabled): Enable insurance addon
• withSmsNotification(bool $enabled): Enable SMS notification
• withWhatsAppTracking(bool $enabled): Enable WhatsApp tracking
• withParcelCategory(string $categoryId): Set parcel category ID
• withPickupPoint(string $point): Set pickup point
• withDropoffPoint(string $point): Set dropoff point
• build(): Get the shipment data

Response Class

• isSuccessful(): Check if the response is successful
• getErrorCode(): Get error code
• getErrorMessage(): Get error message
• getResult(): Get result data
• getRates(): Get rates from result
• getOrderDetails(): Get order details from result
• getOrderNumber(): Get order number from result
• getParcelStatus(): Get parcel status from result
• getShipmentCost(): Get shipment cost from result
• getTrackingNumber(): Get tracking number from result
• getRawData(): Get raw response data

Switching Between Production and Sandbox Environments

EasyParcel provides both production and sandbox environments for testing. There are two ways to switch between these environments:

Method 1: Using Constructor Options

Method 2: Using Environment Setter Methods

Remember to use the same API key for both environments.

License

MIT