Readme
This commit is contained in:
parent
3124d27364
commit
c1bc760601
12
README.md
12
README.md
@ -4,10 +4,10 @@ Included price charts valid as of July 9, 2023.
|
||||
|
||||
## Example Use
|
||||
|
||||
This example assumes an EasyPost `Shipment` object named `$shipment` and a Rate object named `$rate`.
|
||||
This example assumes an EasyPost Shipment object named `$shipment` and a Rate object named `$rate`.
|
||||
|
||||
```php
|
||||
require_once __DIR__ . "/RetailPriceChart.lib.php";
|
||||
require_once "RetailPriceChart.lib.php";
|
||||
$retail_rate = RetailPriceChart::getPrice(
|
||||
$shipment->parcel->weight,
|
||||
$shipment->usps_zone,
|
||||
@ -22,10 +22,10 @@ $retail_rate = RetailPriceChart::getPrice(
|
||||
function getPrice($weight, $zone, $service = "GroundAdvantage", $dimensions = [4, 6, 1], $rectangular = true)
|
||||
```
|
||||
|
||||
Weight is in ounces.
|
||||
Zone is a USPS zone number (regex: `[1-9]`).
|
||||
Service is `Priority` or `GroundAdvantage`.
|
||||
Dimensions are in inches.
|
||||
Weight is in ounces.
|
||||
Zone is a USPS zone number (regex: `[1-9]`).
|
||||
Service is `Priority` or `GroundAdvantage`.
|
||||
Dimensions are in inches.
|
||||
Rectangular affects the dimensional weight calculation. Some rates will be lower for non-rectangular packages.
|
||||
|
||||
## License
|
||||
|
Loading…
x
Reference in New Issue
Block a user