为 Node.js 的 Ship 跟踪 API 库之后

这个库允许您通过Node.js快速并方便地使用AfterShip跟踪API.

欲知此库的更新情况,请参见: GitHub 发布页面。 。 。 .

如果您需要使用 AfterShip 产品支持,请联系 支持@aftership.com。 。 。 .

目录

• 为 Node.js 的 Ship 跟踪 API 库之后
  • 目录
  • 在你开始之前
    • API 和 SDK 版本
  • 快速启动
    • 安装
  • 构造器
    • 示例
  • 限制费率
  • 处理错误
    • 错误列表
  • 终点
    • /跟踪
    • 警车
    • / cour- 连接
    • /估计交付日期
  • 帮助
  • 许可证

在你开始之前

在开始整合之前:

• 创建 AfterShip 账户。 。 。 .
• 创建 API 密钥。 。 。 .
• 安装节点.js 16版或稍后版本.

API 和 SDK 版本

• SDK版本: 17.0
• API 版本: 2026-07

快速启动

安装

npm install --save @aftership/tracking-sdk

构造器

使用选项创建 Ship 后实例

示例

// Step 1: Import the AfterShip client
import { AfterShip } from "@aftership/tracking-sdk";
// or
// const { AfterShip } = require('@aftership/tracking-sdk');

// Step 2: Initialize the client object
const aftership = new AfterShip({ api_key: "YOUR_API_KEY" });

// Step 3: Create the query object
const query = {};

// Step 4: Make the request
aftership.tracking
  .getTrackingById(
    "valid_value",

    query,
  )
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

限制费率

见 费率限制 以了解AfterShip利率限制政策.

API返回其在每个响应头的当前速率限制状态,SDK在成功响应和速率限制错误上都会暴露出这些头,这样您就可以主动地监视您的消费,而不是等待 429 错误.

每一次成功的对策都表明 response_headers 对象并列 data (标题名称为小写). 以上面的快速启动为例:

const remaining = Number(result.response_headers["x-ratelimit-remaining"]);
const resetAt = Number(result.response_headers["x-ratelimit-reset"]);

if (remaining <= 1) {
  // Throttle or defer lower-priority requests until `resetAt`
}

当超过费率限制时,请求失败 429 带有相同信头的错误——见 处理错误。 。 。 .

处理错误

SDK会在请求中出现出错时返回出错对象,其规格如下:

错误列表

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

终点

AfterShip 实例的属性与 API 端点完全相同 :

• 跟踪
  • 获取跟踪
  • 创建跟踪
  • 通过身份追踪
  • 以 ID 更新跟踪
  • 以 ID 删除跟踪
  • 以 ID 重追踪已过期的跟踪
  • 标记跟踪由 ID 完成
• 邮递员
  • 找快递员
  • 侦测信使
• 信使连接
  • 获取信使连接
  • 创建信使连接
  • 通过 id 获取快递连接
  • 通过 id 更新快递连接
  • 以 id 删除信使连接
• 估计交付日期
  • 估计交付日期的预测
  • 估计交付日期批次预测

/跟踪

获取 /跟踪

const query = {};

aftership.tracking
  .getTrackings(query)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

邮政 /跟踪

const createTrackingRequestBody = {
  tracking_number: "valid_value",
};

aftership.tracking
  .createTracking(createTrackingRequestBody)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

获取 /跟踪/{id}

const query = {};

aftership.tracking
  .getTrackingById(
    "valid_value",

    query,
  )
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

点 /跟踪/{id}

const updateTrackingByIdRequestBody = {};

aftership.tracking
  .updateTrackingById("valid_value", updateTrackingByIdRequestBody)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

迪莱特 /跟踪/{id}

aftership.tracking
  .deleteTrackingById("valid_value")
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

邮政 /跟踪/{id}/再跟踪

aftership.tracking
  .retrackTrackingById("valid_value")
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

邮政 /跟踪/{id}/标记-已完成

const markTrackingCompletedByIdRequestBody = {};

aftership.tracking
  .markTrackingCompletedById(
    "valid_value",
    markTrackingCompletedByIdRequestBody,
  )
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

警车

获取 警车

const query = {};

aftership.courier
  .getCouriers(query)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

邮政 警监/侦察员

const detectCourierRequestBody = {
  tracking_number: "valid_value",
};

aftership.courier
  .detectCourier(detectCourierRequestBody)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

/ cour- 连接

获取 / cour- 连接

const query = {};

aftership.courierConnection
  .getCourierConnections(query)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

邮政 / cour- 连接

const postCourierConnectionsRequestBody = {
  courier_slug: "valid_value",
  credentials: {},
};

aftership.courierConnection
  .postCourierConnections(postCourierConnectionsRequestBody)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

获取 /courier-连接/{id}

aftership.courierConnection
  .getCourierConnectionsById("valid_value")
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

帕齐 /courier-连接/{id}

const putCourierConnectionsByIdRequestBody = {
  credentials: {},
};

aftership.courierConnection
  .putCourierConnectionsById(
    "valid_value",
    putCourierConnectionsByIdRequestBody,
  )
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

迪莱特 /courier-连接/{id}

aftership.courierConnection
  .deleteCourierConnectionsById("valid_value")
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

/估计交付日期

邮政 /估计交付日期/预测

const predictRequestBody = {
  slug: "valid_value",
  origin_address: {}, // EstimatedDeliveryDateRequestOriginAddress
  destination_address: {}, // EstimatedDeliveryDateRequestDestinationAddress
};

aftership.estimatedDeliveryDate
  .predict(predictRequestBody)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

邮政 估计交付日期/预期批次

const predictBatchRequestBody = {};

aftership.estimatedDeliveryDate
  .predictBatch(predictBatchRequestBody)
  .then((result) => console.log(result))
  .catch((e) => console.log(e));

帮助

如果你被卡住,我们在这里帮助:

• 问题跟踪器 对于与本套件相关的问题、特性请求、错误报告和一般性讨论。 在创建新问题之前尝试搜索 .
• 通过Ship 正式支持后联系 支持@aftership.com

许可证

版权 (c) 2025 Sip之后

持有麻省理工学院执照.