omnibus/sf-express Référence de l’API

Omnibus\SfExpress

Api class

final class Api Api.php:15

SF Express's open platform (sfapi.sf-express.com): one endpoint, the service name and a JSON payload posted as form fields, signed with msgDigest = base64(md5(urlencode(msgData + timestamp + checkword))).

const LIVE = 'https://bspgw.sf-express.com/std/service'

const TEST = 'https://sfapi-sbox.sf-express.com/std/service'

public readonly string $partnerId

public readonly ?string $monthlyCard

public readonly bool $sandbox

Api::__construct()

public function __construct(readonly HttpClientInterface $http, public readonly string $partnerId, readonly string $checkword, public readonly ?string $monthlyCard = null, public readonly bool $sandbox = false, readonly int $timeout = 20)

Api::call()

public function call(string $service, array $data): array

Returns

the apiResultData, decoded

Api::digest()

public static function digest(string $msgData, string $timestamp, string $checkword): string

SfExpressGatewayFactory class

final class SfExpressGatewayFactory extends GatewayFactory SfExpressGatewayFactory.php:22

options: partner_id: '%env(SF_PARTNER_ID)%' # the open platform's customer code (顾客编码) checkword: '%env(SF_CHECKWORD)%' # its checkword (校验码) monthly_card: '%env(SF_MONTHLY_CARD)%' # the monthly account (月结卡号) that pays sandbox: true rates: [...] # prices from configuration: SF quotes by contract

No pickup points. Unverified until an account's keys are at hand.

Options

Omnibus\SfExpress\Action

CancelAction class

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

EXP_RECE_UPDATE_ORDER with dealType 2: the order cancelled by its orderId, the customer order number it was created under (the shipment's reference, or the id ship() drew), which the label keeps as its carrierReference. Not the waybill number: SF does not find an order by it.

CancelAction::__construct()

public function __construct()

CancelAction::supports()

public function supports(Request $request): bool

CancelAction::execute()

public function execute(Request $request): void

ShippingAction class

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

EXP_RECE_CREATE_ORDER: the waybill (service: the express type id, 1 标快 by default, 2 特快, 5 顺丰次晨...), then its label from COM_RECE_CLOUD_PRINT_WAYBILLS.

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:16

EXP_RECE_SEARCH_ROUTES: the waybill's routes, oldest first.

TrackingAction::__construct()

public function __construct()

TrackingAction::supports()

public function supports(Request $request): bool

TrackingAction::execute()

public function execute(Request $request): void