Shippo Node.js API 客户端使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00086/article/details/139733244

Shippo Node.js API 客户端使用教程

shippo-node-client Shipping API Node.js library (USPS, FedEx, UPS and more) 项目地址: https://gitcode.com/gh_mirrors/sh/shippo-node-client

1. 项目介绍

Shippo Node.js API 客户端是一个用于与 Shippo 物流 API 进行交互的 Node.js 库。Shippo 是一个物流 API，通过单一接口连接多个物流服务商（如 USPS、FedEx、UPS 等）。使用 Shippo，您可以轻松打印运输标签、跟踪包裹、管理物流事务等。

该库提供了对 Shippo API 的封装，使得开发者可以方便地在 Node.js 项目中集成 Shippo 的物流服务。

2. 项目快速启动

2.1 安装

首先，您需要安装 shippo 包。您可以通过 npm 来安装：

npm install shippo

2.2 初始化

安装完成后，您可以在项目中引入 shippo 并初始化实例。您需要使用从 Shippo 控制台获取的私钥进行初始化：

const shippo = require('shippo')('<YOUR_PRIVATE_KEY>');

2.3 创建地址对象

以下是一个创建地址对象的示例代码：

shippo.address.create({
  name: 'Mr Hippo',
  company: 'SF Zoo',
  street1: '2945 Sloat Blvd',
  city: 'San Francisco',
  state: 'CA',
  zip: '94132',
  country: 'US',
  phone: '+1 555 341 9393',
  email: 'mrhippo@goshippo.com'
}).then(function(address) {
  console.log("Address created: %s", JSON.stringify(address));
}).catch(function(err) {
  console.error("Error creating address: %s", err.message);
});

2.4 创建运输标签

以下是一个创建运输标签的示例代码：

const addressFrom = {
  name: "Ms Hippo",
  company: "Shippo",
  street1: "215 Clayton St",
  city: "San Francisco",
  state: "CA",
  zip: "94117",
  country: "US",
  phone: "+1 555 341 9393",
  email: "support@goshippo.com"
};

const addressTo = {
  name: "Ms Hippo",
  company: "Shippo",
  street1: "803 Clayton St",
  city: "San Francisco",
  state: "CA",
  zip: "94117",
  country: "US",
  phone: "+1 555 341 9393",
  email: "support@goshippo.com"
};

const parcelOne = {
  length: "5",
  width: "5",
  height: "5",
  distance_unit: "in",
  weight: "2",
  mass_unit: "lb"
};

const parcelTwo = {
  length: "5",
  width: "5",
  height: "5",
  distance_unit: "in",
  weight: "2",
  mass_unit: "lb"
};

const shipment = {
  address_from: addressFrom,
  address_to: addressTo,
  parcels: [parcelOne, parcelTwo]
};

shippo.transaction.create({
  shipment: shipment,
  servicelevel_token: "ups_ground",
  carrier_account: "558c84bbc25a4f609f9ba02da9791fe4",
  label_file_type: "png"
}).then(function(transaction) {
  console.log("Label URL: %s", transaction.label_url);
  console.log("Tracking Number: %s", transaction.tracking_number);
}).catch(function(err) {
  console.error("Error creating transaction: %s", err.message);
});