setono/sylius-peak-wms-plugin

将您的商店与Peak WMS集成

安装: 367

依赖关系: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

开放问题: 0

类型:sylius-plugin

dev-master / 1.0.x-dev 2024-09-16 08:48 UTC

This package is auto-updated.

Last update: 2024-09-16 08:48:58 UTC


README

Latest Version Software License Build Status Code Coverage Mutation testing

安装

composer require setono/sylius-peak-wms-plugin

将插件类添加到您的 bundles.php

确保您在 SyliusGridBundle 之前添加它,否则您将收到 您请求了一个不存在的参数 "setono_sylius_peak.model.upload_order_request.class". 异常。

<?php
$bundles = [
    // ...
    Setono\SyliusPeakPlugin\SetonoSyliusPeakPlugin::class => ['all' => true],
    Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
    // ...
];

导入路由

# config/routes/setono_sylius_peak.yaml
setono_sylius_peak:
    resource: "@SetonoSyliusPeakPlugin/Resources/config/routes.yaml"

如果您的应用程序不使用区域设置

# config/routes/setono_sylius_peak.yaml
setono_sylius_peak:
    resource: "@SetonoSyliusPeakPlugin/Resources/config/routes_no_locale.yaml"

添加环境变量

将以下变量添加到您的 .env 文件中

###> setono/sylius-peak-wms-plugin ###
PEAK_WMS_API_KEY=YOUR_API_KEY
###< setono/sylius-peak-wms-plugin ###

扩展实体

订单 实体

<?php

# src/Entity/Order/Order.php

declare(strict_types=1);

namespace App\Entity\Order;

use Setono\SyliusPeakPlugin\Model\OrderInterface as PeakOrderInterface;
use Setono\SyliusPeakPlugin\Model\OrderTrait as PeakOrderTrait;
use Sylius\Component\Core\Model\Order as BaseOrder;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 *
 * @ORM\Table(name="sylius_order")
 */
class Order extends BaseOrder implements PeakOrderInterface
{
    use PeakOrderTrait;
}

产品变体 实体

<?php

# src/Entity/Product/ProductVariant.php

declare(strict_types=1);

namespace App\Entity\Order;

use Doctrine\ORM\Mapping as ORM;
use Setono\SyliusPeakPlugin\Model\ProductVariantInterface as PeakProductVariantInterface;
use Setono\SyliusPeakPlugin\Model\ProductVariantTrait as PeakProductVariantTrait;
use Sylius\Component\Core\Model\ProductVariant as BaseProductVariant;

/**
 * @ORM\Entity
 *
 * @ORM\Table(name="sylius_product_variant")
 */
class ProductVariant extends BaseProductVariant implements PeakProductVariantInterface
{
    use PeakProductVariantTrait;
}

更新您的数据库

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

将作业添加到您的cron

# Will process the orders that are ready to be sent to Peak WMS
php bin/console setono:sylius-peak-wms:process-upload-order-requests

# Will create upload product variant requests for all product variants
php bin/console setono:sylius-peak-wms:create-upload-product-variant-requests

# Will process the upload product variant requests
php bin/console setono:sylius-peak-wms:process-upload-product-variant-requests

# Will update the inventory in Sylius based on the inventory in Peak WMS
php bin/console setono:sylius-peak-wms:update-inventory

# Will remove webhooks older than the given threshold (default is 30 days)
php bin/console setono:sylius-peak-wms:prune-webhooks

注册webhooks

要从Peak WMS接收库存调整和订单状态更新,您需要在Peak WMS中注册webhooks。

通过运行以下命令来完成此操作

php bin/console setono:sylius-peak-wms:register-webhooks

注意 您还需要在Peak界面中启用webhooks的发送。

开发

(cd tests/Application && yarn install)
(cd tests/Application && yarn build)
(cd tests/Application && bin/console assets:install)

(cd tests/Application && bin/console doctrine:database:create)
(cd tests/Application && bin/console doctrine:schema:create)

(cd tests/Application && bin/console sylius:fixtures:load -n)

(cd tests/Application && symfony serve -d)

vendor/bin/expose token <your expose token>
vendor/bin/expose default-server free # If you are not paying for Expose
vendor/bin/expose share https://127.0.0.1:8000