hugomarques62/shipment-sdk-php

此包负责执行报价计算。

1.0.1 2020-12-21 20:35 UTC

This package is not auto-updated.

Last update: 2024-09-25 08:25:00 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

现在在您的电子商务项目中获得最佳发货报价服务变得更容易了。

目录

依赖关系

require

  • PHP >= 5.6
  • Ext-json = *
  • Guzzlehttp/guzzle >= 6.5

require-dev

  • phpunit/phpunit >= 5

安装

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

composer require hugomarques62/shipment-sdk-php

初始配置

创建的Shipment实例允许您通过参数传递您的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 

变更日志

请参阅变更日志以获取最近更改的更多信息。

贡献

请参阅贡献指南以获取更多详细信息。

安全性

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

致谢

许可证

梅洛尔·恩维奥。请参阅许可文件以获取更多信息。