README

设置

为了让 Webshipper 设置正常工作，我们需要将 Webshipper 连接到 Magento，反之亦然。这将通过在 Webshipper 中创建一个 订单渠道 并通过一个提供 Webshipper 的 API_TOKEN 的 系统集成 连接到 Magento 来完成，该 token 可以由 Webshipper 用于与您的 Magento 平台通信。

同样，为了允许您的 Magento 平台与 Webshipper 通信，我们需要将 配置令牌 生成并提供给 Magento。

创建订单渠道

要创建订单渠道，请导航到您的 Webshipper 安装并点击 连接，然后点击 新建订单渠道。选择 Magento 2 并点击 连接

填写如图所示的 名称、Url、访问令牌、店铺 Id

如果您不知道如何获取 访问令牌，可以在 Magento 管理面板的 系统 => 扩展 => 集成 中生成一个。

然后在您的系统中创建一个新的集成，命名为 Webshipper 并授予它访问权限。创建后，您需要批准新的集成，之后它将为您生成一个 token。复制访问令牌并将其粘贴到 Webshipper 的订单渠道并点击创建。

现在 Webshipper 将尝试与 Magento 通信，如果一切顺利，则 订单渠道 现已准备好使用。

设置配置令牌

为了使 Magento 能够与 Webshipper 通信，我们需要在 Magento 中设置配置令牌。

转到您的 订单渠道 并复制 配置令牌。您可以在 连接 => 选择订单渠道 => 信息 下找到它。

然后将 配置令牌 粘贴到您的 Magento 后端 店铺 => 配置 => 销售 => 配送方式 => Webshipper => Webshipper 配置令牌 下。

配送方式（rate_quotes）

为了使 webshipper 能够理解您的 订单 的配送方式，我们需要将 Webshipper 的配送费率与您的 Magento 连接起来。一旦您设置了 配置令牌，它应该会自动工作。但是，如果您希望在请求配送方式时更改某些设置，请在此处进行更改。

注意： 这只会影响结账和后端显示的配送方式，与 Webshipper 内部的 订单 或 订单行 数据无关。这是两个不同的功能。

寄件人地址和配送地址

如果您想自定义发送到 webshipper 中 Rate Quotes API 的数据，您可以创建一个自定义映射。默认情况下，我们尽可能发送尽可能多的信息到 Webshipper。但是，如果您想使用自定义属性来过滤 配送方式，请在此处添加它们。

附加数据

如果更改寄件人或配送地址上的数据不足以，则 Rate Quotes 对象接受一个 附加数据 字段。当在 Webshipper 后端使用 WEL 条件时，可以使用此字段。

订单同步

该 Magento 模块具有将订单导出到 Webshipper 的功能。这可以通过手动（通过订单上的按钮）或自动（基于订单 状态）完成。

虽然此模块导出订单到Webshipper，但由Magento创建的发票和发货仍通过Webshipper服务的Magento Rest API触发。

如果您希望自行处理这种行为（如果您有自己的仓库集成），您可以在Webshipper管理员面板的连接 => 订单渠道 => 编辑订单渠道下禁用自动创建发票和发货。

验证连接

为了确保正确设置与webshipper的连接，我们建议在设置页面使用验证连接按钮。

此按钮尝试使用之前步骤中设置的配置令牌与Webshipper通信。它还将尝试从订单渠道（transfer_status、weight_unit、additional_item_attributes、additional_order_attributes）复制设置。

成功连接后，您还会看到订单渠道出现新的横幅。

已知问题

• 没有令牌 - 如果您尚未完成配置令牌步骤，请完成它。

• 权限，如果您收到403 HTTP响应，可能是因为您的配置令牌需要刷新，您可以从Webshipper管理员面板的连接 => 订单渠道 => 信息中刷新它，然后点击刷新按钮。然后按照上面的步骤在Magento中插入新的配置令牌。

订单状态

如果您希望在创建订单时自动将订单传输到Webshipper，可以根据订单的状态选择多选框中的状态。

如果您希望订单被导出多次，可以选中多个值。请注意，您只能发货/开票一次，如果您想在Webshipper中自动处理订单的工作流，您需要处理这个问题。

订单按钮（手动传输）

如果您希望手动处理订单导出，或者有订单没有出现在您的Webshipper后端，您可以使用此按钮来调试问题。

每次导出订单时，Webshipper日志中都会出现一条日志条目。您还可以查看订单状态历史记录以获取更多详细信息。

Webshipper日志

为了在订单同步中提供清晰的区分，我们提供了一个日志。

这包含尝试发送到webshipper的每个订单。状态列将附加每个尝试的消息。

订单网格状态

您还可以从订单网格中查看订单的导出状态。

订单状态历史

在订单本身，我们也提供了发生的详细历史记录。

如果导出发生错误，您也可以在历史记录中找到记录。

订单设置

为了尽可能遵守设置，您可以编辑Webshipper订单的几乎所有方面。以下设置将允许您修改传输的数据。请注意，更改orders和order_lines上的外部引用可能会影响Webshipper与Magento Rest Api的通信。

用于选择订单属性的下拉列表是我们可以在订单中找到的每个属性。

自动创建发货

此设置允许webshipper在订单传输后自动创建发货。这仅适用于webshipper，与Magento发货无关。

注释（external_comment / internal_comment）

外部注释是为最终用户准备的注释，而内部注释是为内部使用准备的。您可以使用这些字段从Magento后端向您的仓库发送消息。

参考（external_ref / visible_ref）

外部参考是Webshipper用于联系其他提供商的参考。更改此设置将影响Magento和Webshipper通信之间的功能。

可见参考 是对订单的可见引用。这通常是 增量ID，将在 Webshipper 中对任何人可见，通常作为参考发送给第三方提供者，如运输公司。此设置仅更改订单编号的视觉引用，而不是内部API引用。

附加数据

如果您有一些自定义数据，您可以通过“附加属性”将它们添加到您的订单中。下拉菜单中提供的列表是订单的所有可用属性。如果您看不到您的属性，请确保它已正确安装。我们尝试查找与订单相关的任何和所有属性，尽管我们不包括通过模型覆盖注入的自定义属性。要么将您的属性添加到订单表中，要么将其添加为扩展属性。

开发者注意： 属性是通过使用 getData(<attribute_code>) 获取的，因此如果您对特定属性的 Order 模型进行了自定义覆盖，您可能看不到它的反映。

订单行设置

与 Order 设置一样，您也有权自定义每个订单行看起来如何。通常，订单行 只被当作参考，但一些提供者可能需要更多的信息才能允许创建运输。通常在国与国之间运输时使用 运费 和 危险货物。每个服务提供者的处理方式不同，因此请确保您的产品已更新为针对特定提供者的正确信息。

标识符（sku）

标识符属性用于在订单行中区分每个实体，这通常是产品的 sku，但如果您想向 Webshipper 展示不同的标识符，则应更改此属性。

外部参考（product_id / entity_id）

当您与 Webshipper 有自定义集成时，外部参考 由外部提供者使用。

描述（name）

描述 字段用于在订单行中视觉识别产品。这是客户最有可能看到的字段，当与 运费 结合使用时，可以向边境控制显示产品的类型。

制造商（country_of_manufacture）

一些提供者要求传递 原产国，通常作为 运费 的一部分。如果对如何设置感到好奇，则 Magento 默认具有内置的 country_of_manufacture 属性。

运费 & 危险货物

当国与国之间运输时，您需要了解针对每种产品类型应用的不同的税收。大多数国家都有一套基于 运费 编号的协议来识别每种产品类型。您可以使用此属性向订单行添加运费编号。

危险货物 有时是必需的，比 运费 编号复杂。

来自 Webshipper API 文档

dangerous_goods_details object
Optional object of key value pairs used for providing information of dangerous goods. 
For use with DGOffice, use keys: article_no, package_type_id and packaging_instruction_type.

我们建议您在产品上存储包含所需信息的 JSON 对象。

重量（weight）

重量 由不同的服务提供者用来确定他们是否可以递送包裹，它也是税收和海关的一部分。

根据您与运输提供商的协议，您需要以他们确定的 重量单位 发送重量。我们使用在 销售 => 配送方式 => Webshipper 上配置的 重量单位。

附加数据

与 Order 一样，每个 Order Line 也有通过 附加数据 属性发送自定义数据的能力。

开发者注意： 属性是通过使用 getData(<attribute_code>) 获取的，因此如果您对特定属性的 Product 模型进行了自定义覆盖，您可能看不到它的反映。