@shipengine/js-api 1.28.0 → 1.29.0

package/index.js

@@ -3963,6 +3963,12 @@ class ShipmentsAPI {
     this.list = (options) => {
       return this.client.get("/v1/shipments", { params: options });
     };
+    /**
+     * Retrieve a shipment using an external shipment Id
+     */
+    this.getByExternalId = (externalId) => {
+      return this.client.get(`/v1/shipments/external_shipment_id/${externalId}`);
+    };
     /**
      * The `create` method allows for creating shipments based on a list of shipment
      * items passed into this method.

package/index.mjs

@@ -3959,6 +3959,12 @@ class ShipmentsAPI {
     this.list = (options) => {
       return this.client.get("/v1/shipments", { params: options });
     };
+    /**
+     * Retrieve a shipment using an external shipment Id
+     */
+    this.getByExternalId = (externalId) => {
+      return this.client.get(`/v1/shipments/external_shipment_id/${externalId}`);
+    };
     /**
      * The `create` method allows for creating shipments based on a list of shipment
      * items passed into this method.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/shipments/api.d.ts

@@ -64,6 +64,10 @@ export declare class ShipmentsAPI {
      * The `list` method retrieves a list of shipments for a given user.
      */
     list: (options?: ListShipmentOptions) => Promise<import("axios").AxiosResponse<ListShipmentResult, any>>;
+    /**
+     * Retrieve a shipment using an external shipment Id
+     */
+    getByExternalId: (externalId: string) => Promise<import("axios").AxiosResponse<Shipment, any>>;
     /**
      * The `create` method allows for creating shipments based on a list of shipment
      * items passed into this method.