omnibus/ups API reference

Omnibus\Ups

Api class

final class Api Api.php:11

UPS's REST APIs on an OAuth2 client-credentials token, kept until it expires.

const LIVE = 'https://onlinetools.ups.com'

const TEST = 'https://wwwcie.ups.com'

const VERSION = 'v2409'

public readonly string $accountNumber

public readonly bool $sandbox

Api::__construct()

public function __construct(readonly HttpClientInterface $http, readonly string $clientId, readonly string $clientSecret, public readonly string $accountNumber, public readonly bool $sandbox = false, readonly int $timeout = 20)

Api::base()

public function base(): string

Api::call()

public function call(string $method, string $path, ?array $body = null, array $query = []): array

Mapping class

final class Mapping Mapping.php:10

UPS's shapes for ours.

const SERVICES = ['01' => 'Next Day Air', '02' => '2nd Day Air', '03' => 'Ground', '07' => 'Worldwide Express', '08' => 'Worldwide Expedited', '11' => 'Standard', '12' => '3 …

Mapping::address()

public static function address(Address $a, bool $withAttention = true): array

Mapping::package()

public static function package(Parcel $p): array

Mapping::status()

public static function status(?string $type): TrackingStatus

UpsGatewayFactory class

final class UpsGatewayFactory extends GatewayFactory UpsGatewayFactory.php:21

options: client_id: '%env(UPS_CLIENT_ID)%' # an app in the UPS Developer Portal client_secret: '%env(UPS_CLIENT_SECRET)%' account_number: '%env(UPS_ACCOUNT)%' # the shipper account (6 characters) sandbox: true # the Customer Integration Environment rates: [...] # optional: prices from configuration instead of the Rating API

Options

Omnibus\Ups\Action

PickupAction class

final class PickupAction implements ActionInterface, ApiAwareInterface PickupAction.php:15

The Locator API: UPS Access Points near an address, nearest first.

PickupAction::__construct()

public function __construct()

PickupAction::supports()

public function supports(Request $request): bool

PickupAction::execute()

public function execute(Request $request): void

RatingAction class

final class RatingAction implements ActionInterface, ApiAwareInterface RatingAction.php:15

The Rating API's Shop: every service UPS can carry the shipment with, priced.

RatingAction::__construct()

public function __construct()

RatingAction::supports()

public function supports(Request $request): bool

RatingAction::execute()

public function execute(Request $request): void

ShippingAction class

final class ShippingAction implements ActionInterface, ApiAwareInterface ShippingAction.php:16

The Shipping API: the shipment booked, its label (PDF by default, "GIF"/"ZPL" through the option label_format).

ShippingAction::__construct()

public function __construct()

ShippingAction::supports()

public function supports(Request $request): bool

ShippingAction::execute()

public function execute(Request $request): void

TrackingAction class

final class TrackingAction implements ActionInterface, ApiAwareInterface TrackingAction.php:17

The Tracking API: the parcel's activities, oldest first.

TrackingAction::__construct()

public function __construct()

TrackingAction::supports()

public function supports(Request $request): bool

TrackingAction::execute()

public function execute(Request $request): void