lojametastore/melhorenvio-sdk-php

此包负责进行报价计算。

1.2.0.1 2021-10-22 17:10 UTC

This package is auto-updated.

Last update: 2024-09-09 03:02:59 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

现在,在您的电子商务项目中使用Melhor Envio的报价服务变得更加容易。

索引

依赖

require

  • PHP >= 7.0
  • Ext-json = *
  • Guzzlehttp/guzzle >= 7.4

require-dev

  • phpunit/phpunit >= 5

安装

您可以通过运行以下命令安装此包:

composer require melhorenvio/shipment-sdk-php

初始配置

创建的发货实例允许您传递参数(您的token和您将工作的环境),因此将准备好认证。

请注意,只有当创建token的环境与作为参数传递的环境相同时,它才是有效的。

如果您尚未完成授权过程,Melhor Envio 拥有另一个包来简化此过程。您可以点击此处访问。

require "vendor/autoload.php";

use MelhorEnvio\Shipment;
use MelhorEnvio\Resources\Shipment\Package;
use MelhorEnvio\Enums\Service;
use MelhorEnvio\Enums\Environment;

// Create Shipment Instance
$shipment = new Shipment('your-token', Environment::PRODUCTION);

创建计算器实例

在此示例中,您将在代码中创建一个计算器实例。

// Create Calculator Instance
    $calculator = $shipment->calculator();

构建计算器的有效负载

添加起点和终点的CEP

在此部分,您必须分别定义起点和终点的CEP。

//Builds calculator payload
$calculator->postalCode('01010010', '20271130');

产品

添加产品进行报价

在此部分,您将定义用于报价的产品,应作为参数传递的信息如下

  • 高度
  • 宽度
  • 长度
  • 重量
  • 保险价值
  • 数量

请注意,默认情况下,保险价值应为产品的价值。

$calculator->addProducts(
        new Product(uniqid(), 40, 30, 50, 10.00, 100.0, 1),
        new Product(uniqid(), 5, 1, 10, 0.1, 50.0, 1)
    );

包裹

添加包裹进行报价

在此部分,您将定义用于报价的包裹,应作为参数传递的信息如下

  • 高度
  • 宽度
  • 长度
  • 重量
  • 保险价值

尺寸始终应以厘米为单位传递,重量应以千克为单位。这是Melhor Envio操作的单元。

请注意,默认情况下,保险价值应为产品的价值(以雷亚尔为单位)。

 $calculator->addPackages(
        new Package(12, 4, 17, 0.1, 6.0),
        new Package(12, 4, 17, 0.1, 6.0),
        new Package(12, 4, 17, 0.1, 6.0),
        new Package(12, 4, 17, 0.1, 6.0)
    );

重要的是要强调,PACOTES和PRODUTOS方法不能同时使用,应仅使用其中一个。

添加运输公司的服务

如果您想自定义,在此部分将选择您想使用的运输公司的服务。今天,在Melhor Envio中,以下服务可用:

  • Correios
  • Jadlog
  • Via Brasil
  • Azul Cargo
  • Latam Cargo
$calculator->addServices(
        Service::CORREIOS_PAC, 
        Service::CORREIOS_SEDEX,
        Service::CORREIOS_MINI,
        Service::JADLOG_PACKAGE, 
        Service::JADLOG_COM, 
        Service::AZULCARGO_AMANHA,
        Service::AZULCARGO_ECOMMERCE,
        Service::LATAMCARGO_JUNTOS,
        Service::VIABRASIL_RODOVIARIO
    );

添加附加服务

如果您想自定义,可以在报价中配置一些附加服务,它们是

  • Mão própria
  • Aviso de recebimento
  • Coleta

请注意,添加这些服务可能会在报价时增加价格。

$calculator->setOwnHand();
$calculator->setReceipt();
$calculator->setCollect();

返回报价信息

在这里,您将返回构建的有效负载信息。

$quotations = $calculator->calculate();

更多示例

在这里,您可以访问更多实现示例

测试

在项目中,您将找到一些基于单元测试的测试文档

您可以在应用程序中使用以下命令

composer test

或者

vendor/bin/phpunit tests 

变更日志

请参阅CHANGELOG 获取最新更改的更多信息。

贡献

请参阅CONTRIBUTING 获取更多详细信息。

安全

如果您发现任何安全问题,请通过电子邮件发送给 tecnologia@melhorenvio.com,而不是使用 问题跟踪器

致谢

许可

Melhor Envio。有关更多信息,请参阅 许可文件