imn / api-php-client
1.1
2023-04-26 09:43 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is not auto-updated.
Last update: 2024-09-25 16:56:25 UTC
README
IMN系统REST API ## 概述 REST API提供了读取和写入IMN数据的编程访问。基本上,使用此API,您将能够执行像在https://go.imn.io浏览器上一样的一切!主要功能包括:- 注册和管理您的商户账户- 声明您的源市场以获取您的报价- 配置您的市场API凭证- 定义您想要进入的目标市场,然后您将能够配置:- 定价设置- 配送设置- ...等等!## 注意事项### API速率限制 - IMN REST API限制为每分钟100次调用。### 媒体类型请求和响应的默认媒体类型为application/json。如有说明,某些操作支持其他内容类型。如果特定操作未提及其他内容类型,则媒体类型为application/json。### 必需内容类型请求和响应的必需和默认编码为UTF8。### 必需日期时间格式所有日期时间都按ISO 8601格式格式化:2014-06-24T16:25:00Z。### 基础URL IMN API订单管理REST API的基础URL符合以下模板。https://api.imn.io所有由IMN API返回的URL都相对于此基础URL,所有对REST API的请求都必须使用此基础URL模板。您可以在https://api-docs.imn.io/swagger-ui\\\\测试我们的API。您可以在gitter, #IMN/API联系我们
此PHP包由Swagger Codegen项目自动生成
- API版本:1.0
- 构建包:io.swagger.codegen.languages.PhpClientCodegen
要求
PHP 5.5及更高版本
安装与使用
Composer
要使用Composer安装绑定,请将以下内容添加到composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com//.git"
}
],
"require": {
"/": "*@dev"
}
}
然后运行composer install
手动安装
下载文件并包含autoload.php
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门
请按照安装过程进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new IMN\Swagger\Client\Api\MerchantAPIListOfValuesLOVApi( // 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() ); $list_name = "list_name_example"; // string | The list of value name your want to get $accept_language = array("accept_language_example"); // string[] | Indicates that the client accepts the following languages. $if_none_match = "if_none_match_example"; // string | ETag value to identify the last known version of requested resource.\\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3 try { $result = $apiInstance->getUserListOfValues($list_name, $accept_language, $if_none_match); print_r($result); } catch (Exception $e) { echo 'Exception when calling MerchantAPIListOfValuesLOVApi->getUserListOfValues: ', $e->getMessage(), PHP_EOL; } ?>
API端点文档
所有URI均相对于https://api.imn.io
模型文档
- AcceptOrderListRequest
- AcceptOrderListRequestItem
- ApiToken
- BatchMerchantMarketplaceOrders
- BatchMerchantOfferChanges
- BatchOrderOperationResponse
- BeezUPChannelCatalogId
- BeezUPChannelId
- BeezUPExecutionId
- BeezUPMarketplaceAccountId
- BeezUPMarketplaceAccountIdentifier
- BeezUPMarketplaceTechnicalCode
- BeezUPOrderId
- BeezUPOrderIdentifier
- CancelOrderListRequest
- CancelOrderListRequestItem
- CancelOrderRequest
- CancellationReason
- CarrierCode
- CarrierName
- CauseId
- ChangeOrderReporting
- ClearMerchantOrderInfoListRequest
- ClearMerchantOrderInfoListRequestItem
- ClearOrderMerchantInfo
- ConfigureOrderMerchantInfo
- CorrelationId
- CountryIsoCodeAlpha3
- CreateMerchant
- CreateMerchantAccountRequest
- CreateSubscriptionRequest
- CredentialNotConfiguredException
- CultureName
- CurrencyCode
- DeliveryLeadTime
- DeliveryMethod
- DeliverySpecification
- DependencyProjectionException
- 文档URL
- 重复商家市场平台出价操作异常
- 重复商家出价操作异常
- 电子商务软件名称
- 电子邮件
- 错误代码
- 错误响应消息
- 错误摘要
- 事件类型
- 异常详情
- 外部商家市场订阅请求
- 名
- 履行方
- 全球统一标识码
- 健康检查
- 健康检查状态
- 链接
- HTTP方法
- HTTP URL
- IMN订单状态
- 信息摘要
- 信息摘要
- 无效市场代码异常
- 无效市场凭证异常
- 无效商家代码异常
- 在声明的商家出价源市场执行无效操作异常
- 库存水平
- 商品状况
- LOV链接2
- LOV链接3
- 姓
- 链接2
- 链接3
- 链接参数2
- 链接参数2类型
- 链接参数3
- 链接参数3类型
- 链接参数属性3
- 值列表项
- 市场API凭证
- 市场API集成状态
- 市场代码
- 市场代码未找到异常
- 市场凭证状态
- 市场配送设置
- 市场配送设置列表
- 市场索引
- 市场索引链接
- 市场信息
- 市场商家代码
- 市场出价发布状态
- 市场订单ID
- 市场订单状态
- 市场准备规则类型
- 市场准备设置
- 市场定价规则操作类型
- 市场定价规则类型
- 市场定价规则单位
- 市场定价设置
- 市场定价值
- 市场配送费用规则类型
- 市场配送设置
- 市场配送设置状态
- 市场状态
- 市场订阅消息
- 市场订阅消息发送者类型
- 市场订阅报告
- 市场订阅状态
- 市场索引
- 市场索引链接
- 商家账户索引
- 商家账户索引链接
- 商家账户信息
- 商家账户信息链接
- 商家账户信息已更新
- 商家代码
- 商家代码已被使用异常
- 商家代码未找到异常
- 商家公司名称
- 商家创建
- 商家电子商务软件版本
- 商家事件
- 商家事件已推送
- 商家事件
- 商家市场基础
- 商家市场订阅拒绝原因
- 商家出价标识符
- 商家出价列表
- 商家出价无导入原因
- 商家出价无导入原因代码
- 商家出价推送队列提醒
- 商家订单ID
- 消息基础
- 消息ID
- 最小价格
- 非出价源市场异常
- 出价发布状态
- 出价源状态
- 操作ID
- 操作源类型
- 订单API索引
- 订单API索引链接
- 订单计费信息
- 订单更改命令基础
- 订单更改完成
- 订单更改事件基础
- 订单更改类型
- 订单更改用户名
- 订单日期搜索类型
- 订单Etag
- 订单异常基础
- 订单一般信息
- 订单历史
- 订单IMN信息
- 订单标识符
- 订单索引
- 订单项目
- 订单项目
- 订单链接
- 订单列表完整
- 订单列表完整链接
- 无分页的订单列表请求
- 订单管理禁用异常
- 订单市场信息
- 订单商家信息
- 订单商家信息已清除
- 订单商家信息已配置
- 订单操作响应
- 订单定价信息
- 订单处理
- 订单配送信息
- 订单转换链接
- 页码
- 每页大小
- 分页请求参数
- 分页结果
- 分页结果链接
- 输入参数
- 参数类型
- 合作伙伴HTTP异常
- 合作伙伴无效响应
- 人员
- 邮政地址
- 价格
- 价格货币
- 价格规范
- 处理状态
- 产品基本信息
- 产品过滤器操作员名称
- 产品ID
- 退款订单列表请求
- 退款订单列表请求项
- 退款订单请求
- 退款原因
- 拒绝订单列表请求
- 拒绝订单列表请求项
- 按日报告
- 按市场按日报告
- 按日报告请求
- 按日报告响应
- 按市场报告状态
- 设置商家订单信息列表请求
- 设置商家订单信息列表请求项
- 设置商家订单信息请求
- 发货订单列表请求
- 发货订单列表请求项
- 发货订单请求
- 带追踪URL的发货订单列表请求
- 带追踪URL的发货订单列表请求项
- 带追踪URL的发货订单请求
- SKU
- 排序
- 订阅
- 订阅应用程序名称
- 订阅应用程序版本
- 订阅ID
- 订阅名称
- 订阅不接受异常
- 订阅状态
- 成功摘要
- 电话号码
- 追踪号码
- 追踪URL
- 运输时间
- 更新商家账户请求
- 更新商家账户信息
- 用户错误消息
- 用户错误消息参数
- 用户ID
- 用户值列表响应
- 用户值列表响应链接
- 用户值索引
- 用户值索引链接
- 用户值链接
- 有效开始日期
- 有效结束日期
- 验证模式
- 警告摘要
- 接受商家市场订阅
- 接受订单
- BeezUP商家产品标识符
- BeezUP订单变更执行
- 阻止商家市场订阅
- 取消订单
- 配置市场商家代码
- 配置市场定价设置
- 配置市场配送设置
- 配置商家市场凭证
- 声明商家产品来源市场
- 禁用市场配送配送设置
- 禁用商家市场
- 禁用商家市场订单导入
- 重复订单操作异常
- 启用商家市场
- 事件基础
- 链接接受订单链接
- 链接取消订单链接
- 链接检查商家代码可用性链接
- 链接清除商家订单信息链接
- 链接清除商家订单信息列表链接
- 链接创建商家账户链接
- 链接禁用市场链接
- 链接禁用订单导入链接
- 链接启用市场链接
- 链接外部市场订阅表单链接
- 链接获取市场API凭证链接
- 链接获取市场定价设置链接
- 链接获取市场配送设置链接
- 链接获取市场订阅报告链接
- 链接获取商家账户信息链接
- 链接获取商家API令牌链接
- 链接获取订单API索引链接
- 链接获取订单历史链接
- 链接获取订单链接
- 链接获取完整订单列表链接
- 链接获取用户值列表链接
- 链接获取用户值索引链接
- 链接重新启用订单导入链接
- 链接退款订单链接
- 链接拒绝订单链接
- 链接重置商家API令牌链接
- 链接设置商家订单信息链接
- 链接设置商家订单信息列表链接
- 链接发货订单链接
- 链接带追踪URL发货订单链接
- 链接更新商家账户信息链接
- 市场API信息
- 市场商家代码已配置
- 商家市场凭证已配置
- 商家市场事件基础
- 商家市场产品导入已禁用
- 商家市场产品导入已启用
- 商家市场产品发布已禁用
- 商家市场产品发布已启用
- 商家市场订单导入已禁用
- 商家市场订单导入已启用
- 商家市场定价设置已配置
- 商家市场配送配送设置已配置
- 商家市场配送配送设置已删除
- 商家市场配送配送设置已禁用
- 商家市场配送配送设置已启用
- 商家市场配送准备设置已配置
- 商家市场订阅已接受
- 商家市场订阅已阻止
- 商家市场订阅已拒绝
- 商家市场订阅已请求
- 商家产品
- 商家产品已删除
- 商家产品未导入
- 商家产品来源市场已声明
- 商家产品来源市场未声明
- 订单已接受
- 订单已取消
- 订单变更已在进行中异常
- 订单变更无效异常
- 订单变更未找到异常
- 订单客户
- 订单信息
- 订单无效Etag异常
- 订单列表请求
- 订单未找到异常
- 订单已接收
- 订单已退款
- 订单已拒绝
- 订单已发货
- 订单已发货并带有追踪URL
- 重新启用市场配送配送设置
- 重新启用商家市场订单导入
- 退款订单
- 拒绝商家市场订阅
- 拒绝订单
- 发货订单
- 带追踪URL发货订单
- 取消商家产品来源市场声明
- BeezUP商家产品
- BeezUP订单变更执行摘要
- 商家产品事件基础
- 商家产品已接收
授权文档
api_key
- 类型: API密钥
- API密钥参数名称: Ocp-Apim-Subscription-Key
- 位置: HTTP头