npm 包 @genomeinc/shipping-ups 使用教程

阅读时长 6 分钟读完

简介

这是一个用于集成空运物流服务 UPS 的 npm 包,供前端开发人员使用。该包提供了一组易于使用的 API,使得前端开发人员无需学习底层的 UPS API,并快速实现空运物流服务。

安装

您可以通过 npm 安装 @genomeinc/shipping-ups:

npm install @genomeinc/shipping-ups

快速入门

首先,您需要创建一个 UPS 的账户,以获得访问 UPS API 的权限。然后,您需要配置以下环境变量,以便访问 UPS API:

接下来,我们可以使用以下代码,来创建我们的第一个 Shipment:

-- -------------------- ---- -------
----- - ----------- - - -----------------------------------

----- --- - --- --------------

----- -------- - -
  ----- -
    ----- -------
    -------- -------
    -------- ---- ---- -----
    ----- ----------
    ------ -----
    ----------- --------
    ------------ -----
  --
  --- -
    ----- -------
    -------- ---- ------ -----
    ----- ----------
    ------ -----
    ----------- --------
    ------------ -----
  --
  --------- -
    -
      ------- ---
      ------- --
      ------ --
      ------- --
    --
    -
      ------- --
      ------- --
      ------ --
      ------- --
    --
  --
--

------------------
  -------------- -- -
    --------------------
  --
  -------------- -- -
    ---------------------
  ---

在这个例子中,我们首先创建了一个 UPS 对象,然后创建了一个 shipment 对象,该对象包含了我们要寄送的包裹的各种信息。接下来,我们调用了 ups.ship() 方法,该方法会将 shipment 对象作为参数,并返回一个 Promise。如果一切正常,我们可以在 Promise 的 then() 方法中获取到返回的结果。如果出现了错误,则在 catch() 方法中处理。

API

ShippingUps 对象提供了以下方法:

ship(shipment)

该方法用于创建一个新的 Shipment,并向 UPS API 发送请求。

  • shipment: 一个对象,包含了我们要寄送的包裹的各种信息。

getResult(trackingNumber)

该方法用于获取一个 Shipment 的结果。

  • trackingNumber: 跟踪号,用于唯一标识一个 Shipment。

cancelShipment(trackingNumber)

该方法用于取消一个 Shipment。

  • trackingNumber: 跟踪号,用于唯一标识一个 Shipment。

示例代码

创建一个新的 Shipment

-- -------------------- ---- -------
----- - ----------- - - -----------------------------------

----- --- - --- --------------

----- -------- - -
  ----- -
    ----- -------
    -------- -------
    -------- ---- ---- -----
    ----- ----------
    ------ -----
    ----------- --------
    ------------ -----
  --
  --- -
    ----- -------
    -------- ---- ------ -----
    ----- ----------
    ------ -----
    ----------- --------
    ------------ -----
  --
  --------- -
    -
      ------- ---
      ------- --
      ------ --
      ------- --
    --
    -
      ------- --
      ------- --
      ------ --
      ------- --
    --
  --
--

------------------
  -------------- -- -
    --------------------
  --
  -------------- -- -
    ---------------------
  ---

获取一个 Shipment 的结果

-- -------------------- ---- -------
----- - ----------- - - -----------------------------------

----- --- - --- --------------

----- -------------- - ---------

-----------------------------
  -------------- -- -
    --------------------
  --
  -------------- -- -
    ---------------------
  ---

取消一个 Shipment

-- -------------------- ---- -------
----- - ----------- - - -----------------------------------

----- --- - --- --------------

----- -------------- - ---------

----------------------------------
  -------- -- -
    --------------------- ------------
  --
  -------------- -- -
    ---------------------
  ---

总结

通过这篇文章,我们介绍了 @genomeinc/shipping-ups 的使用方法。该包提供了一组易于使用的 API,方便前端开发人员使用 UPS 的空运物流服务。我们还提供了一些示例代码,以便开发人员更好地了解使用方法。在您的实际开发工作中,您也可以依照这些方法来快速集成 UPS 的物流服务。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562da81e8991b448e03c6

纠错
反馈