@shipengine/js-api 1.28.0 → 1.30.0

package/addresses/types.d.ts

@@ -11,13 +11,20 @@ export interface Address {
     companyName?: string;
     countryCode: string;
     email?: string;
-    geolocation?: string;
+    geolocation?: AddressGeolocation[];
     instructions?: string;
     name: string;
     phone: string;
     postalCode: string;
     stateProvince: string;
 }
+/**
+ * @category Entities
+ */
+export interface AddressGeolocation {
+    type: string;
+    value: string;
+}
 /**
  * @category Entities
  */

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.30.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.

package/shipments/types.d.ts

@@ -35,8 +35,8 @@ export interface CustomsInvoiceAdditionalDetails {
     discount?: Money;
     freightCharge?: Money;
     insuranceCharge?: Money;
+    otherCharge?: Money;
     otherChargeDescription?: string;
-    otherCharges?: Money;
 }
 export interface DangerousGoods {
     AddionalDescription?: string;
@@ -106,12 +106,14 @@ export type ShipmentPackage = Omit<CarrierPackage, "name"> & {
     insuredValue?: Money;
     labelDownload?: Download;
     labelMessages?: {
-        reference1: string;
-        reference2: string;
-        reference3: string;
+        reference1?: string;
+        reference2?: string;
+        reference3?: string;
     };
+    packageName: string;
     products?: Product[];
     sequence?: number;
+    shipmentPackageId: string;
     trackingNumber?: string;
     weight: WeightWithUnit;
 };
@@ -197,7 +199,7 @@ export interface Shipment {
     isReturn?: boolean;
     items: ShipmentItem[];
     modifiedAt: string;
-    orderSourceCode: OrderSourceCode;
+    orderSourceCode: OrderSourceCode | null;
     originType?: OriginTypes;
     packages: ShipmentPackage[];
     returnTo: Address | null;