friends-of-ce / merchant-api-client-php
ChannelEngine API 商家版
2.15.0.1
2024-07-23 09:30 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
ChannelEngine API 商家版
安装与使用
需求
PHP 7.4 及更高版本。也应当与 PHP 8.0 兼容。
Composer
要通过 Composer 安装绑定,请将以下内容添加到 composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/friends-of-ce/merchant-api-client-php.git" } ], "require": { "friends-of-ce/merchant-api-client-php": "*@dev" } }
然后运行 composer install
手动安装
下载文件并包含 autoload.php
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
入门指南
请按照 安装过程 进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: apiKey $config = FriendsOfCE\Merchant\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = FriendsOfCE\Merchant\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer'); $apiInstance = new FriendsOfCE\Merchant\ApiClient\Api\CancellationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $merchantCancellationRequest = new \FriendsOfCE\Merchant\ApiClient\Model\MerchantCancellationRequest(); // \FriendsOfCE\Merchant\ApiClient\Model\MerchantCancellationRequest try { $result = $apiInstance->cancellationCreate($merchantCancellationRequest); print_r($result); } catch (Exception $e) { echo 'Exception when calling CancellationsApi->cancellationCreate: ', $e->getMessage(), PHP_EOL; }
API 端点
所有 URI 都相对于 https://demo.channelengine.net/api
模型
- 添加产品额外数据请求
- 高级设置响应
- API 响应
- 批量创建采购订单发票请求
- 更改采购订单出货行
- 渠道承运人集合方法 API
- 渠道承运人推荐 API
- 渠道响应
- 渠道导出状态
- 全局渠道响应
- 列表产品响应
- 渠道全局响应集合
- 渠道列表产品响应集合
- 采购订单集合
- 采购订单出货集合
- 商家取消响应集合
- 商家库存位置集合
- 商家通知响应集合
- 商家库存获取响应集合
- 商家订单响应集合
- 商家产品属性组与链接渠道响应集合
- 商家产品属性组与产品额外数据响应集合
- 商家产品捆绑响应集合
- 商家产品响应集合
- 商家产品与买框价格响应集合
- 商家退货响应集合
- 商家结算报告响应集合
- 商家出货标签承运人响应集合
- 商家出货响应集合
- 商家单个订单退货响应集合
- 商家库存位置与国家 ISO 响应集合
- 商家 Webhook 响应集合
- 条件
- 创建采购订单出货
- 创建者类型
- 创建者筛选器
- 创建者类型
- 额外数据类型
- 冻结产品请求
- 冻结动作请求
- 履约类型
- 性别
- IImportInformation
- IPurchaseOrderByFilter
- IPurchaseOrderLineByFilter
- IPurchaseOrderShipmentByFilter
- IPurchaseOrderShipmentLineByFilter
- IRefund
- IRefundCurrency
- IRefundLine
- IReturn
- IReturnLine
- IReturnLineHandlingResult
- IVendorParty
- 列表产品渠道状态
- 列表产品导出状态
- MancoReason
- 商家确认采购订单
- 商家确认采购订单行
- 商家确认退款
- 商家确认退货
- 商家地址响应
- 商家取消行请求
- 商家取消行响应
- 商家取消请求
- 商家取消响应
- 商家渠道标签出货请求
- 商家创建退款
- 商家创建退款行
- 商家创建报告响应
- 商家创建退货
- 商家创建退货行
- 商家创建结算报告请求
- 商家履约库存项目响应
- 商家履约库存位置响应
- 商家获取报告状态响应
- 商家处理退货
- 商家发票上传请求
- 商家通知响应
- 商家库存获取响应
- 商家库存更新请求
- 商家订单确认请求
- 商家订单评论更新请求
- 商家订单行额外数据响应
- 商家订单行响应
- 商家订单响应
- 商家产品属性组渠道信息响应
- 商家产品属性组与链接渠道响应集合
- 商家产品属性组与产品额外数据响应集合
- 商家产品捆绑部分响应
- 商家产品捆绑响应集合
- 商家产品额外数据项请求
- 商家产品额外数据项响应
- 商家产品额外数据请求
- 商家产品额外数据响应
- 商家产品请求
- 商家产品响应
- 商家产品与买框价格响应
- 商家采购订单发票
- 商户采购订单发票行
- 商户退货确认请求
- 商户退货行请求
- 商户退货行响应
- 商户退货行更新请求
- 商户退货请求
- 商户退货响应
- 商户退货更新请求
- 商户设置响应
- 商户结算报告响应
- 商户货运标签承运人请求
- 商户货运标签承运人响应
- 商户货运行请求
- 商户货运行响应
- 商户货运包装尺寸请求
- 商户货运包装重量请求
- 商户货运请求
- 商户货运响应
- 商户货运跟踪请求
- 商户单个订单退货行响应
- 商户单个订单退货响应
- 商户库存位置地址请求
- 商户库存位置创建请求
- 商户库存位置响应
- 商户库存位置更新请求
- 商户库存位置带国家ISO响应
- 商户库存价格更新请求
- 商户供应商方
- 商户Webhook请求
- 商户Webhook响应
- 模块履约类型
- 模块退货原因
- 模块退货状态
- 模块附加详细信息类型
- 模块津贴详细信息类型
- 模块费用详细信息类型
- 模块采购订单发票类型
- 模块采购订单状态
- 模块采购订单类型
- 模块税务登记类型
- 模块税务类型
- 通知类型
- 操作
- 订单标识符
- 订单行标识符
- 订单状态视图
- 订单支持
- 包装尺寸单位
- 包装重量单位
- 修补商户产品Dto
- 产品属性组请求
- 产品创建结果
- 产品额外数据请求
- 产品消息
- 采购订单确认代码
- 采购订单标识符类型
- 采购订单发票附加详细信息
- 采购订单发票津贴详细信息
- 采购订单发票费用详细信息
- 采购订单发票税务详细信息
- 采购订单行标识符类型
- 采购订单行计量单位
- 采购订单拒绝原因
- 采购订单相关项目导出状态
- 采购订单装运标识符类型值
- 按筛选标识符退款
- 退款标识符
- 退款原因
- 移除产品额外数据请求
- 重命名产品属性组请求
- 报告状态
- 报告类型
- 按筛选标识符退货
- 退货处理操作
- 退货标识符
- 退货行标识符
- 退货原因
- 退货状态
- 设置响应
- 装运履约类型
- 装运行状态
- 装运设置响应
- 装运类型
- 单个商户确认采购订单行请求
- 单个商户确认退款请求
- 单个商户确认退货请求
- 单个商户创建采购订单发票请求
- 单个商户创建采购订单装运请求
- 单个商户创建退款请求
- 单个商户创建退货请求
- 单个商户处理退货请求
- 单个商户更新采购订单装运请求
- 单个API响应
- 单个字典-of-字符串-and-字符串列表
- 单个退款引用
- 单个退货引用
- 单个商户产品响应
- 单个商户设置响应
- 单个产品创建结果
- 更新采购订单装运
- 增值税率类型
- 增值税设置响应
- 体积单位
- Webhook事件类型
- 重量单位
授权
为API定义的认证方案
apiKey
- 类型:API密钥
- API密钥参数名:apikey
- 位置:URL查询字符串
测试
要运行测试,请使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包是由OpenAPI Generator项目自动生成的
- API版本:
2.15.0
- 包版本:
2.15.0.1
- 生成器版本:
7.7.0
- 包版本:
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen