alexmg86/laravel-goodsru

Laravel Goodsru API

v1.1 2020-10-23 14:39 UTC

This package is auto-updated.

Last update: 2024-09-23 23:08:39 UTC


README

PHP Composer Latest Stable Version License

此包的用途

此包旨在在Laravel中处理GoodsRu API。

喜欢吗?

如果你喜欢这个包,可以给我点个赞 🙏 😌

安装

通过composer安装

composer require alexmg86/laravel-goodsru

在.ENV文件中添加并填写变量

GOODSRU_URL= //https://site_goodsru.ru/api/market/v1/orderService
GOODSRU_TOKEN=
GOODSRU_LOGIN=
GOODSRU_PASSWORD=
GOODSRU_MERCHANT_ID=
GOODSRU_MERCHANT_NAME=

如果您需要更改配置,请将其添加到配置文件夹

php artisan vendor:publish --provider="Alexmg86\LaravelGoodsru\ServiceProvider"

使用

初始化

可以通过几种方式初始化

use Alexmg86\LaravelGoodsru\LaravelGoodsru;

$api = new LaravelGoodsru();

可以直接指定 $shipmentId$orderCode

$api = new LaravelGoodsru($shipmentId, $orderCode);

可以在任何时候指定 $shipmentId$orderCode

$api = new LaravelGoodsru();
$api->initOrder($shipmentId, $orderCode);

或者分别设置它们

$api = new LaravelGoodsru();
$api->setOrder($orderCode);
$api->setShipment($shipmentId);

请求

get

获取发货详细信息。
可以指定一个或多个 $shipmentId

$api = new LaravelGoodsru();
$data = $api->get($shipmentId);
$data = $api->get([$shipmentId1, $shipmentId2]);

confirm

卖家确认发货中的批次。
指定 $shipmentId 并传递数组 $itemIndex => $goodId

$api = new LaravelGoodsru();
$api->setShipment($shipmentId);
$data = $api->confirm([1 => 1111, 2 => 2222]);

reject

卖家取消发货中的批次。
指定 $shipmentId 并传递数组 $itemIndex => $goodId
可以指定取消原因 $reason。默认将传递 OUT_OF_STOCK

$api = new LaravelGoodsru();
$api->setShipment($shipmentId);
$data = $api->reject([1 => 1111, 2 => 2222], $reason);

获取可用状态列表。

$reasons = $api->getReasons();

packing

卖家确认打包。
指定 $shipmentId$orderCode 并传递数组 $itemIndex => $boxIndex
$boxIndex 参与生成条形码 (boxCode)。

$api = new LaravelGoodsru();
$api->initOrder($shipmentId, $orderCode);
$data = $api->packing([1 => 1, 2 => 1]);

print

获取标签。
指定 $shipmentId 并传递数组 $boxIndex

$api = new LaravelGoodsru();
$api->setShipment($shipmentId);
$data = $api->print([1, 2]);

shipping

卖家确认发货。
指定 $shipmentId$shippingDate 并传递数组 $boxIndex

$api = new LaravelGoodsru();
$api->setShipment($shipmentId);
// формат YYYY-MM-DDThh:mm:ss+hh:mm
$api->setShippingDate($shippingDate);
$data = $api->shipping([1, 2]);

search

按发货查找。
传递 $period 等于当前日期前的天数。
可选数组 $statuses 用于按特定状态搜索。默认将搜索所有状态。

$api = new LaravelGoodsru();
$data = $api->search($period, $statuses);

可用状态列表。

$api->getStatuses();

还可以通过 $orderCode$shippingDate 进行额外搜索。

$api->setOrder($orderCode);
// формат YYYY-MM-DDThh:mm:ss+hh:mm
$api->setShippingDate($shippingDate);

默认将返回 100 条记录。最大数量可以在配置文件 count 中指定,或在任何时候指定。

$api->setCount(200);

额外方法

获取配置。

$api->getConfig();

获取和设置搜索结果中最大数量的结果。

$api->getCount();
$api->setCount(200);

获取折扣类型代码。

$api->getDiscount();

获取和设置订单号。

$api->getOrder();
$api->setOrder($orderCode);

获取商家ID。

$api->getMerchantId();

获取商家名称。

$api->getMerchantName();

获取取消原因代码。

$api->getReasons();

获取 MERCHANT_CANCELED 状态的取消原因代码。

$api->getCanceles();

获取状态代码。

$api->getStatuses();

获取和设置 GoodsRu 订单号。

$api->getShipment();
$api->setShipment($shipmentId);

设置发货日期。

$api->setShippingDate($shippingDate);