@shipengine/js-api 3.2.0 → 3.4.0

package/addresses/types.d.ts

@@ -1,18 +1,28 @@
 export type AddressResidentialIndicator = "yes" | "no" | "unknown";
+/**
+ * @category Entities
+ */
+export interface ShippingAddress extends Address {
+    instructions?: string | null;
+}
+/**
+ * @category Entities
+ */
+export interface ShippingAddressTo extends ShippingAddress {
+    geolocation?: AddressGeolocation[] | null;
+}
 /**
  * @category Entities
  */
 export interface Address {
     addressLine1: string;
-    addressLine2?: string;
-    addressLine3?: string;
+    addressLine2?: string | null;
+    addressLine3?: string | null;
     addressResidentialIndicator?: AddressResidentialIndicator;
     cityLocality: string;
     companyName?: string;
     countryCode: string;
     email?: string;
-    geolocation?: AddressGeolocation[];
-    instructions?: string;
     name: string;
     phone: string;
     postalCode: string;

package/client.d.ts

@@ -8,6 +8,7 @@ import { CustomPackagesAPI } from "./custom-packages";
 import { CodedError } from "./errors";
 import { FundingSourcesAPI } from "./funding-sources";
 import { InsuranceAPI } from "./insurance";
+import { InvoiceAddressAPI } from "./invoice-address";
 import { LabelsAPI } from "./labels";
 import { OrderSourcesAPI } from "./order-sources";
 import { RateCardsAPI } from "./rate-cards";
@@ -143,6 +144,13 @@ export declare class ShipEngineAPI {
      * @see {@link InsuranceAPI | The Insurance API module}
      */
     get insurance(): InsuranceAPI;
+    /**
+     * The `invoiceAddress` method provides access to the Invoice Address endpoints
+     * in ShipEngine API.
+     *
+     * @see {@link InvoiceAddress | The Invoice Address API module}
+     */
+    get invoiceAddress(): InvoiceAddressAPI;
     /**
      * The `labels` method provides access to the Label endpoints in ShipEngine API.
      * e.g. Create Label, Get Label, Void Label, etc.

package/funding-sources/types.d.ts

@@ -64,7 +64,7 @@ export interface CarrierRegistration {
 /** @internal */
 export interface FundingSourceAddress {
     addressLine1: string;
-    addressLine2?: string;
+    addressLine2?: string | null;
     cityLocality: string;
     company?: string;
     countryCode: string;

package/index.d.ts

@@ -9,6 +9,7 @@ export * from "./dimensions";
 export * from "./errors";
 export * from "./funding-sources";
 export * from "./insurance";
+export * from "./invoice-address";
 export * from "./labels";
 export * from "./order-sources";
 export * from "./payments";

package/index.js

@@ -975,7 +975,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$6 = (__this, __arguments, generator) => {
+var __async$7 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -995,7 +995,7 @@ var __async$6 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$7(void 0, null, function* () {
   try {
     const response = yield axios.get("https://api.ipify.org/?format=json");
     if (response.data.ip && ipaddrExports.isValid(response.data.ip)) {
@@ -1069,7 +1069,7 @@ var __objRest$1 = (source, exclude) => {
     }
   return target;
 };
-var __async$5 = (__this, __arguments, generator) => {
+var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1109,7 +1109,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$5(this, null, function* () {
+    this.connect = (_a) => __async$6(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest$1(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1200,7 +1200,7 @@ class CarriersAPI {
   }
 }
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1242,7 +1242,7 @@ class ConnectionsAPI {
     /**
      * The `connectCarrier` method connects a carrier to account.
      */
-    this.connectCarrier = (carrierName, formData) => __async$4(this, null, function* () {
+    this.connectCarrier = (carrierName, formData) => __async$5(this, null, function* () {
       return yield this.client.post(
         `/v1/connections/carriers/${carrierName}`,
         formData,
@@ -3433,7 +3433,7 @@ var __spreadValues$3 = (a, b) => {
     }
   return a;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -3472,7 +3472,7 @@ class FundingSourcesAPI {
      * The `create` method creates a new funding source for a given user. This requires
      * payment information to be collected from the user.
      */
-    this.create = (createFundingSource) => __async$3(this, null, function* () {
+    this.create = (createFundingSource) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3486,7 +3486,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$3(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3504,7 +3504,7 @@ class FundingSourcesAPI {
      * The `registerCarrier` method registers a carrier account and associates
      * it with a given funding source.
      */
-    this.registerCarrier = (carrier) => __async$3(this, null, function* () {
+    this.registerCarrier = (carrier) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3516,7 +3516,7 @@ class FundingSourcesAPI {
     /**
      * The `addFunds` method allows you to add funds to a funding source.
      */
-    this.addFunds = (amount, fundingSourceId) => __async$3(this, null, function* () {
+    this.addFunds = (amount, fundingSourceId) => __async$4(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
         amount
@@ -3526,7 +3526,7 @@ class FundingSourcesAPI {
      * The `metadata` method returns seller-specific requirements for creating funding sources
      * and attaching carriers
      */
-    this.metadata = () => __async$3(this, null, function* () {
+    this.metadata = () => __async$4(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
     /**
@@ -3578,6 +3578,51 @@ class InsuranceAPI {
   }
 }
 
+var __async$3 = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+class InvoiceAddressAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the invoice address for a given user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/invoice_address");
+    };
+    /**
+     * The `create` method creates a new invoice address for a given user.
+     */
+    this.create = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.post("/v1/invoice_address", invoiceAddress);
+    });
+    /**
+     * The `update` method updates a invoice address for a given user.
+     */
+    this.update = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.put("/v1/invoice_address", invoiceAddress);
+    });
+    this.client = client;
+  }
+}
+
 class LabelsAPI {
   constructor(client) {
     this.client = client;
@@ -3790,10 +3835,14 @@ class SalesOrderShipmentsAPI {
     /**
      * The `list` method retrieves a list of sales order shipments for a given user.
      */
-    this.list = (body = {}, params) => {
-      return this.client.post("/v-beta/shipments/list", body, {
-        params
-      });
+    this.list = (body) => {
+      return this.client.post("/v-beta/shipments/list", body);
+    };
+    /**
+     * The `listShipmentsByExternalOrderId` method retrieves a list of shipments associated to a sales order that matches `externalOrderId`
+     */
+    this.listShipmentsByExternalOrderId = (externalOrderId) => {
+      return this.client.get(`/v-beta/shipments/external_order_id/${externalOrderId}`);
     };
     /**
      * The `get` method retrieves a specific sales order shipment by `shipmentId`.
@@ -3835,6 +3884,13 @@ class SalesOrdersAPI {
     this.get = (salesOrderId) => {
       return this.client.get(`/v-beta/sales_orders/${salesOrderId}`);
     };
+    /**
+     * The `getByExternalId` method retrieves a specific sales order by its `externalOrderId`.
+     * @param externalOrderId Id that matches that of the desired sales order.
+     */
+    this.getByExternalId = (externalOrderId) => {
+      return this.client.get(`/v-beta/sales_orders/external_order_id/${externalOrderId}`);
+    };
     /**
      * The `notifyShipped` method notifies order source that the order has been
      * shipped. Typically, the order source will then notify the user based on
@@ -21701,6 +21757,15 @@ class ShipEngineAPI {
   get insurance() {
     return new InsuranceAPI(this.client);
   }
+  /**
+   * The `invoiceAddress` method provides access to the Invoice Address endpoints
+   * in ShipEngine API.
+   *
+   * @see {@link InvoiceAddress | The Invoice Address API module}
+   */
+  get invoiceAddress() {
+    return new InvoiceAddressAPI(this.client);
+  }
   /**
    * The `labels` method provides access to the Label endpoints in ShipEngine API.
    * e.g. Create Label, Get Label, Void Label, etc.
@@ -21830,6 +21895,7 @@ exports.CustomsNonDeliveryType = CustomsNonDeliveryType;
 exports.FundingSourcesAPI = FundingSourcesAPI;
 exports.InsuranceAPI = InsuranceAPI;
 exports.InsuranceProviderType = InsuranceProviderType;
+exports.InvoiceAddressAPI = InvoiceAddressAPI;
 exports.LabelsAPI = LabelsAPI;
 exports.MetadataCapability = MetadataCapability;
 exports.MetadataRequirement = MetadataRequirement;

package/index.mjs

@@ -971,7 +971,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$6 = (__this, __arguments, generator) => {
+var __async$7 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -991,7 +991,7 @@ var __async$6 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$7(void 0, null, function* () {
   try {
     const response = yield axios.get("https://api.ipify.org/?format=json");
     if (response.data.ip && ipaddrExports.isValid(response.data.ip)) {
@@ -1065,7 +1065,7 @@ var __objRest$1 = (source, exclude) => {
     }
   return target;
 };
-var __async$5 = (__this, __arguments, generator) => {
+var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1105,7 +1105,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$5(this, null, function* () {
+    this.connect = (_a) => __async$6(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest$1(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1196,7 +1196,7 @@ class CarriersAPI {
   }
 }
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1238,7 +1238,7 @@ class ConnectionsAPI {
     /**
      * The `connectCarrier` method connects a carrier to account.
      */
-    this.connectCarrier = (carrierName, formData) => __async$4(this, null, function* () {
+    this.connectCarrier = (carrierName, formData) => __async$5(this, null, function* () {
       return yield this.client.post(
         `/v1/connections/carriers/${carrierName}`,
         formData,
@@ -3429,7 +3429,7 @@ var __spreadValues$3 = (a, b) => {
     }
   return a;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -3468,7 +3468,7 @@ class FundingSourcesAPI {
      * The `create` method creates a new funding source for a given user. This requires
      * payment information to be collected from the user.
      */
-    this.create = (createFundingSource) => __async$3(this, null, function* () {
+    this.create = (createFundingSource) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3482,7 +3482,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$3(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3500,7 +3500,7 @@ class FundingSourcesAPI {
      * The `registerCarrier` method registers a carrier account and associates
      * it with a given funding source.
      */
-    this.registerCarrier = (carrier) => __async$3(this, null, function* () {
+    this.registerCarrier = (carrier) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3512,7 +3512,7 @@ class FundingSourcesAPI {
     /**
      * The `addFunds` method allows you to add funds to a funding source.
      */
-    this.addFunds = (amount, fundingSourceId) => __async$3(this, null, function* () {
+    this.addFunds = (amount, fundingSourceId) => __async$4(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
         amount
@@ -3522,7 +3522,7 @@ class FundingSourcesAPI {
      * The `metadata` method returns seller-specific requirements for creating funding sources
      * and attaching carriers
      */
-    this.metadata = () => __async$3(this, null, function* () {
+    this.metadata = () => __async$4(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
     /**
@@ -3574,6 +3574,51 @@ class InsuranceAPI {
   }
 }
 
+var __async$3 = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+class InvoiceAddressAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the invoice address for a given user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/invoice_address");
+    };
+    /**
+     * The `create` method creates a new invoice address for a given user.
+     */
+    this.create = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.post("/v1/invoice_address", invoiceAddress);
+    });
+    /**
+     * The `update` method updates a invoice address for a given user.
+     */
+    this.update = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.put("/v1/invoice_address", invoiceAddress);
+    });
+    this.client = client;
+  }
+}
+
 class LabelsAPI {
   constructor(client) {
     this.client = client;
@@ -3786,10 +3831,14 @@ class SalesOrderShipmentsAPI {
     /**
      * The `list` method retrieves a list of sales order shipments for a given user.
      */
-    this.list = (body = {}, params) => {
-      return this.client.post("/v-beta/shipments/list", body, {
-        params
-      });
+    this.list = (body) => {
+      return this.client.post("/v-beta/shipments/list", body);
+    };
+    /**
+     * The `listShipmentsByExternalOrderId` method retrieves a list of shipments associated to a sales order that matches `externalOrderId`
+     */
+    this.listShipmentsByExternalOrderId = (externalOrderId) => {
+      return this.client.get(`/v-beta/shipments/external_order_id/${externalOrderId}`);
     };
     /**
      * The `get` method retrieves a specific sales order shipment by `shipmentId`.
@@ -3831,6 +3880,13 @@ class SalesOrdersAPI {
     this.get = (salesOrderId) => {
       return this.client.get(`/v-beta/sales_orders/${salesOrderId}`);
     };
+    /**
+     * The `getByExternalId` method retrieves a specific sales order by its `externalOrderId`.
+     * @param externalOrderId Id that matches that of the desired sales order.
+     */
+    this.getByExternalId = (externalOrderId) => {
+      return this.client.get(`/v-beta/sales_orders/external_order_id/${externalOrderId}`);
+    };
     /**
      * The `notifyShipped` method notifies order source that the order has been
      * shipped. Typically, the order source will then notify the user based on
@@ -21697,6 +21753,15 @@ class ShipEngineAPI {
   get insurance() {
     return new InsuranceAPI(this.client);
   }
+  /**
+   * The `invoiceAddress` method provides access to the Invoice Address endpoints
+   * in ShipEngine API.
+   *
+   * @see {@link InvoiceAddress | The Invoice Address API module}
+   */
+  get invoiceAddress() {
+    return new InvoiceAddressAPI(this.client);
+  }
   /**
    * The `labels` method provides access to the Label endpoints in ShipEngine API.
    * e.g. Create Label, Get Label, Void Label, etc.
@@ -21812,4 +21877,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/invoice-address/api.d.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from "axios";
+import { InvoiceAddress } from "./types";
+/**
+ * @internal
+ * # Invoice Address API module - /v1/invoice_address
+ */
+export declare class InvoiceAddressAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the invoice address for a given user.
+     */
+    get: () => Promise<import("axios").AxiosResponse<InvoiceAddress, any>>;
+    /**
+     * The `create` method creates a new invoice address for a given user.
+     */
+    create: (invoiceAddress: InvoiceAddress) => Promise<import("axios").AxiosResponse<InvoiceAddress, any>>;
+    /**
+     * The `update` method updates a invoice address for a given user.
+     */
+    update: (invoiceAddress: InvoiceAddress) => Promise<import("axios").AxiosResponse<InvoiceAddress, any>>;
+}

package/invoice-address/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./types";

package/invoice-address/types.d.ts

@@ -0,0 +1,13 @@
+/** @internal */
+export interface InvoiceAddress {
+    addressLine1: string;
+    addressLine2?: string;
+    cityLocality: string;
+    company?: string;
+    countryCode: string;
+    email: string;
+    fullName: string;
+    phone: string;
+    postalCode: string;
+    stateProvince: string;
+}

package/package.json

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

package/sales-order-shipments/api.d.ts

@@ -60,15 +60,19 @@ export type ListSalesOrderShipmentsParams = {
  * # Sales Order Shipments - List Sales Order Shipments Body
  */
 export type ListSalesOrderShipmentBody = {
+    /**
+     * `externalOrderIds` is an array of non-unique external ids that match to a sales order
+     */
+    externalOrderIds?: string[];
     /**
      * `salesOrderIds` is an array of sales order IDs to be used when listing sales
      * orders.
      */
     salesOrderIds?: string[];
     /**
-     * `shipments` is an array of shipments associated with the sales orders.
+     * `shipmentIds` is an array of shipments associated with the sales orders.
      */
-    shipments?: SalesOrderShipment[];
+    shipmentIds?: string[];
 };
 /**
  * # Sales Order Shipments - List Sales Order Shipments Result
@@ -88,7 +92,11 @@ export declare class SalesOrderShipmentsAPI {
     /**
      * The `list` method retrieves a list of sales order shipments for a given user.
      */
-    list: (body?: ListSalesOrderShipmentBody | undefined, params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
+    list: (body: ListSalesOrderShipmentBody) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
+    /**
+     * The `listShipmentsByExternalOrderId` method retrieves a list of shipments associated to a sales order that matches `externalOrderId`
+     */
+    listShipmentsByExternalOrderId: (externalOrderId: string) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
     /**
      * The `get` method retrieves a specific sales order shipment by `shipmentId`.
      */

package/sales-orders/api.d.ts

@@ -31,6 +31,11 @@ export declare class SalesOrdersAPI {
      * The `get` method retrieves a specific sales order by `salesOrderId`.
      */
     get: (salesOrderId: string) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
+    /**
+     * The `getByExternalId` method retrieves a specific sales order by its `externalOrderId`.
+     * @param externalOrderId Id that matches that of the desired sales order.
+     */
+    getByExternalId: (externalOrderId: string) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
     /**
      * The `notifyShipped` method notifies order source that the order has been
      * shipped. Typically, the order source will then notify the user based on

package/shipments/types.d.ts

@@ -1,4 +1,4 @@
-import { Address, AddressValidation } from "../addresses";
+import { Address, AddressValidation, ShippingAddress, ShippingAddressTo } from "../addresses";
 import { CarrierPackage } from "../carriers";
 import { CodedError } from "../errors";
 import { OrderSourceCode } from "../order-sources";
@@ -203,36 +203,47 @@ export interface Shipment {
         useUpsGroundFreightPricing?: boolean;
         windsorFrameworkDetails?: WindsorFrameworkDetails;
     };
+    amountPaid: Money;
+    assignedUser?: string | null;
     carrierId: string;
-    comparisonRateType?: string;
+    comparisonRateType?: string | null;
     confirmation: ConfirmationType;
     createdAt: string;
     customs?: Customs;
-    externalOrderId?: string;
-    externalShipmentId?: string;
+    externalOrderId?: string | null;
+    externalShipmentId?: string | null;
+    holdUntilDate?: string | null;
     insuranceProvider: InsuranceProviderType;
+    isGift?: boolean;
     isReturn?: boolean;
     items: ShipmentItem[];
     modifiedAt: string;
+    notesForGift?: string | null;
+    notesFromBuyer?: string | null;
     orderSourceCode: OrderSourceCode | null;
     originType?: OriginTypes;
     packages: ShipmentPackage[];
-    returnTo: Address | null;
+    requestedShipmentService?: string | null;
+    retailRate?: number | null;
+    returnTo: ShippingAddress | null;
     serviceCode: string | null;
+    shipByDate?: string | null;
     shipDate?: string;
-    shipFrom: Address | null;
+    shipFrom: ShippingAddress;
     shipmentId: string;
     shipmentNumber?: string;
     shipmentStatus: ShipmentStatus;
-    shippingRuleId?: string;
-    shipTo: Address;
+    shippingPaid: Money;
+    shippingRuleId?: string | null;
+    shipTo: ShippingAddressTo;
     tags: {
         name: string;
     }[];
     taxIdentifiers?: TaxIdentifier[];
+    taxPaid: Money;
     totalWeight: WeightWithUnit;
     validateAddress?: AddressValidationOptions;
-    warehouseId?: string;
+    warehouseId?: string | null;
 }
 export type ShipmentRateResponse = {
     createdAt: string;

package/types.d.ts

@@ -9,6 +9,7 @@ export * from "./dimensions/types";
 export * from "./errors/types";
 export * from "./funding-sources/types";
 export * from "./insurance/types";
+export * from "./invoice-address/types";
 export * from "./labels/types";
 export * from "./order-sources/types";
 export * from "./payments/types";