PHPackages                             ycstar/sfopenic - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. ycstar/sfopenic

ActiveLibrary

ycstar/sfopenic
===============

顺丰同城开放平台SDK

3.0(1y ago)994↓100%1MITPHP

Since Jun 28Pushed 11mo ago1 watchersCompare

[ Source](https://github.com/yangchen5710/sfopenic)[ Packagist](https://packagist.org/packages/ycstar/sfopenic)[ RSS](/packages/ycstar-sfopenic/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (13)Used By (0)

 sfopenic
==========

[](#-sfopenic-)

 顺丰同城开放平台SDK

安装
--

[](#安装)

```
$ composer require ycstar/sfopenic -vvv
```

配置
--

[](#配置)

⚠️ 注意：本项目的开放平台地址已于 2025 年 6 月更新为：

旧版本中的地址（如 ) 已失效，请勿使用。

在使用本扩展之前,你需要去[顺丰同城开放平台](https://openic.sf-express.com/#/homepage)注册账号,然后申请开发者ID,获取相应的配置

使用
--

[](#使用)

```
    use Ycstar\Sfopenic\Sfopenic;

    $config = [
        'host'    => 'xxxxxxxxxxxx',
        'dev_id'  => 'xxxxxxxxxxxx',
        'dev_key' => 'xxxxxxxxxxxx'
    ];

    $sfopenic = new Sfopenic($config);
```

订单管理
====

[](#订单管理)

预创建订单（店铺）
---------

[](#预创建订单店铺)

```
    $data = [
        'shop_id' => 'xxxxxxxxxxxx',
        'user_address' => "北京市海淀区学清嘉创大厦A座15层",
        'user_lng' => '116.352569',
        'user_lat' => '40.014838',
        'weight' => 100,
        'product_type' => 1,
        'pay_type' => 1,
        'is_appoint' => 0,
        'is_insured' => 0,
        'is_person_direct' => 0
    ];

    $res = $sfopenic->preCreateOrder($data);
```

预创建订单（企业）
---------

[](#预创建订单企业)

```
    $data = [
        'company_id' => 'xxxxxxxxxxxx',
        'settlement_type' => 0,
        'city_name' => "北京",
        'account_phone' => 'xxxxxxxxxxxx',
        'is_insured' => 0,
        'is_appoint' => 0,
    ];

    $sender =[
        'sender_name' => "xx",
        'sender_phone' => "xxxxxxxxxx",
        'sender_address' => "北京市海淀区学清嘉创大厦A座15层",
        'sender_lng' => '116.352569',
        'sender_lat' => '40.014838',
    ];

    $receiver =[
        'receiver_name' => "xx",
        'receiver_phone' => "xxxxxxxxxx",
        'receiver_address' => "北京市海淀区学清嘉创大厦A座15层",
        'receiver_lng' => '116.352569',
        'receiver_lat' => '40.014838',
    ];

    $orderDetail = [
        'total_price' => 1,//总金额
        'product_type' => 1, //物品类型 1:送餐 8:饮品
        'weight_gram' => 100,//物品重量
    ];

    $data['sender'] = $sender;
    $data['receiver'] = $receiver;
    $data['order_detail'] = $orderDetail;

    $res = $sfopenic->preCreateOrder4C($data);
```

创建订单（店铺）
--------

[](#创建订单店铺)

```
    $data = [
        'shop_id' => 'xxxxxxxxxxxx',
        'shop_order_id' => 'xxxxxxxxxxxx',
        'order_source' => 'xx',
        'pay_type' => 1,
        'order_time' => time(),
        'is_appoint' => 0,
        'is_insured' => 0,
        'is_person_direct' => 0,
        'version' => 17,
        'order_sequence' => 'xx',
        'remark' => 'xx'
    ];

    $receive =[
        'user_name' => "xx",
        'user_phone' => "xxxxxxxxxx",
        'user_address' => "北京市海淀区学清嘉创大厦A座15层",
        'user_lng' => '116.352569',
        'user_lat' => '40.014838',
    ];

    $orderDetail = [
        'total_price' => 1,//总金额
        'product_type' => 1, //物品类型 1:送餐 8:饮品
        'weight_gram' => 100,//物品重量
        'product_num' => 3,//物品个数
        'product_type_num' => 1,//物品种类个数
    ];

    $productDetail = [
        [
            'product_name' => 'xxx', //物品名称
            'product_num' => 1, //物品数量
        ]
    ];

    $orderDetail['product_detail'] = $productDetail;
    $data['order_detail'] = $orderDetail;
    $data['receive'] = $receive;

    $res = $sfopenic->createOrder($data);
```

创建订单（企业）
--------

[](#创建订单企业)

```
    $data = [
        'user_order_id' => 'xxxxxxxxxxxx',
        'company_id' => 'xxxxxxxxxxxx',
        'settlement_type' => 0,
        'city_name' => "北京",
        'account_phone' => 'xxxxxxxxxxxx',
        'is_insured' => 0,
        'is_appoint' => 0,
    ];

    $sender =[
        'sender_name' => "xx",
        'sender_phone' => "xxxxxxxxxx",
        'sender_address' => "北京市海淀区学清嘉创大厦A座15层",
        'sender_lng' => '116.352569',
        'sender_lat' => '40.014838',
    ];

    $receiver =[
        'receiver_name' => "xx",
        'receiver_phone' => "xxxxxxxxxx",
        'receiver_address' => "北京市海淀区学清嘉创大厦A座15层",
        'receiver_lng' => '116.352569',
        'receiver_lat' => '40.014838',
    ];

    $orderDetail = [
        'total_price' => 1,//总金额
        'product_type' => 1, //物品类型 1:送餐 8:饮品
        'weight_gram' => 100,//物品重量
    ];

    $data['sender'] = $sender;
    $data['receiver'] = $receiver;
    $data['order_detail'] = $orderDetail;

    $res = $sfopenic->createOrder4C($data);
```

取消订单
----

[](#取消订单)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
        'cancel_code' => 313, //不填时默认cancel_code=313,cancel_reason=商家发起取消
        'cancel_reason' => ''
    ];

    $res = $sfopenic->cancelOrder($data);
```

预取消订单
-----

[](#预取消订单)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
        'cancel_reason' => ''
    ];

    $res = $sfopenic->preCancelOrder($data);
```

订单加小费
-----

[](#订单加小费)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
        'gratuity_fee' => 0
    ];

    $res = $sfopenic->addOrderGratuityFee($data);
```

获取订单加小费信息
---------

[](#获取订单加小费信息)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->getOrderGratuityFee($data);
```

订单状态流查询
-------

[](#订单状态流查询)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->listOrderFeed($data);
```

订单实时信息查询
--------

[](#订单实时信息查询)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->getOrderStatus($data);
```

催单
--

[](#催单)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->reminderOrder($data);
```

改单
--

[](#改单)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
        'user_name'=> '',
        'user_phone'=> '',
        'user_address'=> '',
        'lbs_type'=> 2, //1：百度坐标，2：高德坐标（默认值为2，下面的经纬度依赖这个坐标系，不传默认高德）
        'user_lng'=> '', //传入用户地址经纬度顺丰侧则不根据用户地址解析
        'user_lat'=> '',
    ];

    $res = $sfopenic->changeOrder($data);
```

获取配送员实时坐标接口
-----------

[](#获取配送员实时坐标接口)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->riderLatestPosition($data);
```

获取配送员轨迹H5
---------

[](#获取配送员轨迹h5)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->riderViewV2($data);
```

商家告知餐品制作完成接口
------------

[](#商家告知餐品制作完成接口)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,   //order_type=2时必传shop_id与shop_type
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
        'notice_ready_time' => 'xxxxxxxxxxxx' //货物准备好时间，秒级时间戳
    ];

    $res = $sfopenic->notifyProductReady($data);
```

店铺管理
====

[](#店铺管理)

获取店铺账户余额
--------

[](#获取店铺账户余额)

```
    $data = [
        'shop_id' => 0,   //店铺ID
        'shop_type' => 1, //1表示顺丰店铺，2表示第三方店铺 默认1 非必填
    ];

    $res = $sfopenic->getShopAccountBalance($data);
```

获取企业信息
------

[](#获取企业信息)

```
    $data = [
        'company_id' => 0,   //企业ID
    ];

    $res = $sfopenic->getCompanyInfo($data);
```

获取店铺信息
------

[](#获取店铺信息)

```
    $data = [
        'shop_id' => 0,   //店铺ID
        'shop_type' => 1, //1表示顺丰店铺，2表示第三方店铺 默认1 非必填
    ];

    $res = $sfopenic->getShopInfo($data);
```

回调相关
====

[](#回调相关)

```
    $data = [
        'order_id' => 'xxxxxxxxxxxx',
        'order_type' => 1 //1、顺丰订单号 2、商家订单号
        'shop_id' => 0,
        'shop_type' => 1, //1、顺丰店铺ID 2、接入方店铺ID
    ];

    $res = $sfopenic->getCallbackInfo($data);
```

获取回调数据及回复内容
-----------

[](#获取回调数据及回复内容)

```
    $data = $sfopenic->getNotify();
    .
    .
    .
    return $sfopenic->getNotifySuccessReply();
```

在laravel中使用
-----------

[](#在laravel中使用)

在 Laravel 中使用也是同样的安装方式，

使用下面的命令来导出配置文件

```
php artisan vendor:publish --tag="ycstar-sfopenic"
```

配置写在 config/sfopenic.php 中:

```
    return [

        'host' => env('SF_OPENIC_HOST'),

        'dev_id' => env('SF_OPENIC_DEV_ID'),

        'dev_key' => env('SF_OPENIC_DEV_KEY')

      ];
```

然后在 .env 中配置 SF\_OPENIC\_HOST, SF\_OPENIC\_DEV\_ID, SF\_OPENIC\_DEV\_KEY:

```
    SF_OPENIC_HOST = xxxxxxxxxxxx
    SF_OPENIC_DEV_ID = xxxxxxxxxxxx
    SF_OPENIC_DEV_KEY = xxxxxxxxxxxx
```

可以用两种方式来获取 Ycstar\\Sfopenic\\Sfopenic 实例：

- 方法参数注入 ```
      .
      .
      .
      public function preCreateOrder(Sfopenic $sfopenic)
      {
          $res = $sfopenic->preCreateOrder($data);
      }
      .
      .
      .
    ```
- 服务名访问 ```
      .
      .
      .
      public function preCreateOrder()
      {
          $res = app('sfopenic')->preCreateOrder($data);
      }
      .
      .
      .
    ```

参考
--

[](#参考)

- [顺丰同城开放平台接口文档](http://commit-openic.sf-express.com/open/api/docs/index#/apidoc)

License
-------

[](#license)

MIT

###  Health Score

36

—

LowBetter than 81% of packages

Maintenance47

Moderate activity, may be stable

Popularity17

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 91.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~106 days

Recently: every ~282 days

Total

12

Last Release

606d ago

Major Versions

1.0.3 → 2.02021-07-24

2.1 → 3.02024-09-10

### Community

Maintainers

![](https://www.gravatar.com/avatar/b48755fd0e2c4a8c7724909b9c26c024494619c84a98dc43fcde7cdf0a7bf605?d=identicon)[ycstar](/maintainers/ycstar)

---

Top Contributors

[![ycstar](https://avatars.githubusercontent.com/u/17920927?v=4)](https://github.com/ycstar "ycstar (21 commits)")[![Jefsky](https://avatars.githubusercontent.com/u/7386165?v=4)](https://github.com/Jefsky "Jefsky (1 commits)")[![yangchen5710](https://avatars.githubusercontent.com/u/44995973?v=4)](https://github.com/yangchen5710 "yangchen5710 (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ycstar-sfopenic/health.svg)

```
[![Health](https://phpackages.com/badges/ycstar-sfopenic/health.svg)](https://phpackages.com/packages/ycstar-sfopenic)
```

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k20](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[ralphjsmit/laravel-helpers

A package containing handy helpers for your Laravel-application.

13704.6k2](/packages/ralphjsmit-laravel-helpers)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)