@shipengine/connect-carrier-api 4.33.0 → 4.34.0

package/lib/app/carrier-app-definition.d.ts

@@ -1,7 +1,7 @@
 import { ImportedTrackingEvent } from '../models';
 import type { Request } from 'express';
-import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest, UploadDocumentRequest } from '../requests';
-import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse, UploadDocumentResponse } from '../responses';
+import { RegisterRequest, BulkTrackingRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest, UploadDocumentRequest } from '../requests';
+import { RegisterResponse, BulkTrackingResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse, UploadDocumentResponse } from '../responses';
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
 /**
@@ -54,6 +54,11 @@ export interface CarrierAppDefinition {
      * @param request Data needed by the provider to track a shipment
      */
     Track?: (request: TrackingRequest) => TrackingResponse | Promise<TrackingResponse>;
+    /**
+     * @description This endpoint is used to get tracking information about multiple shipments in a single call
+     * @param request Data needed by the provider to track multiple shipments
+     */
+    BulkTrack?: (request: BulkTrackingRequest) => BulkTrackingResponse | Promise<BulkTrackingResponse>;
     /**
      * @description This endpoint is used to submit notification of the creation of a shipment
      * @param request Data needed by the provider to inform them of a shipment

package/lib/app/constants.d.ts

@@ -8,6 +8,7 @@ export declare enum ApiEndpoints {
     SchedulePickup = "/SchedulePickup",
     CancelPickup = "/CancelPickup",
     Track = "/Track",
+    BulkTrack = "/BulkTrack",
     CreateNotification = "/CreateNotification",
     CancelNotification = "/CancelNotification",
     ValidateInboundData = "/ValidateInboundData",

package/lib/app/constants.js

@@ -12,6 +12,7 @@ var ApiEndpoints;
     ApiEndpoints["SchedulePickup"] = "/SchedulePickup";
     ApiEndpoints["CancelPickup"] = "/CancelPickup";
     ApiEndpoints["Track"] = "/Track";
+    ApiEndpoints["BulkTrack"] = "/BulkTrack";
     ApiEndpoints["CreateNotification"] = "/CreateNotification";
     ApiEndpoints["CancelNotification"] = "/CancelNotification";
     ApiEndpoints["ValidateInboundData"] = "/ValidateInboundData";

package/lib/app/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;IAChD,kDAAkC,CAAA;IAClC,sDAAsC,CAAA;IACtC,oDAAoC,CAAA;IACpC,8DAA8C,CAAA;IAC9C,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,gDAAgC,CAAA;IAChC,kDAAkC,CAAA;AACpC,CAAC,EAtBW,YAAY,4BAAZ,YAAY,QAsBvB"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAuBX;AAvBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,wCAAwB,CAAA;IACxB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;IAChD,kDAAkC,CAAA;IAClC,sDAAsC,CAAA;IACtC,oDAAoC,CAAA;IACpC,8DAA8C,CAAA;IAC9C,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,gDAAgC,CAAA;IAChC,kDAAkC,CAAA;AACpC,CAAC,EAvBW,YAAY,4BAAZ,YAAY,QAuBvB"}

package/lib/app/create-endpoint-mapping.js

@@ -6,6 +6,7 @@ const constants_1 = require("./constants");
 const createEndpointMapping = (definition) => [
     //TODO: Remove `Method.POST` from this and all other maps since they are ALL post
     //TODO: Remove JOI validation from all endpoints and replace them with OpenAPI validation
+    [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.BulkTrack, definition.BulkTrack],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelNotification, definition.CancelNotification],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelPickup, definition.CancelPickup],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CreateLabel, definition.CreateLabel],

package/lib/app/create-endpoint-mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC;IACnE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AA3BW,QAAA,qBAAqB,yBA2BhC"}
+{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC;IAC3D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC;IACnE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AA5BW,QAAA,qBAAqB,yBA4BhC"}

package/lib/models/tracking/bulk-tracking-error.d.ts

@@ -0,0 +1,7 @@
+/** @description Error detail for a single item within a bulk tracking response */
+export declare class BulkTrackingError {
+    /** @description A code identifying the type of error encountered while tracking this item */
+    code: string;
+    /** @description A human readable description of the error */
+    message: string;
+}

package/lib/models/tracking/bulk-tracking-error.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkTrackingError = void 0;
+/** @description Error detail for a single item within a bulk tracking response */
+class BulkTrackingError {
+    /** @description A code identifying the type of error encountered while tracking this item */
+    code;
+    /** @description A human readable description of the error */
+    message;
+}
+exports.BulkTrackingError = BulkTrackingError;
+//# sourceMappingURL=bulk-tracking-error.js.map

package/lib/models/tracking/bulk-tracking-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-tracking-error.js","sourceRoot":"","sources":["../../../src/models/tracking/bulk-tracking-error.ts"],"names":[],"mappings":";;;AAAA,kFAAkF;AAClF,MAAa,iBAAiB;IAC5B,6FAA6F;IAC7F,IAAI,CAAU;IACd,6DAA6D;IAC7D,OAAO,CAAU;CAClB;AALD,8CAKC"}

package/lib/models/tracking/index.d.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-error';
 export * from './imported-tracking-event-schema';
 export * from './imported-tracking-event';
 export * from './lat-long-schema';

package/lib/models/tracking/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./bulk-tracking-error"), exports);
 tslib_1.__exportStar(require("./imported-tracking-event-schema"), exports);
 tslib_1.__exportStar(require("./imported-tracking-event"), exports);
 tslib_1.__exportStar(require("./lat-long-schema"), exports);

package/lib/models/tracking/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/tracking/index.ts"],"names":[],"mappings":";;;AAAA,2EAAiD;AACjD,oEAA0C;AAC1C,4DAAkC;AAClC,qDAA2B;AAC3B,2DAAiC;AACjC,oDAA0B;AAC1B,6EAAmD;AACnD,sEAA4C;AAC5C,+DAAqC;AACrC,wDAA8B;AAC9B,+DAAqC;AACrC,gEAAsC;AACtC,iEAAuC;AACvC,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC;AAChC,6EAAmD;AACnD,oFAA0D;AAC1D,kEAAwC;AACxC,yEAA+C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/tracking/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,2EAAiD;AACjD,oEAA0C;AAC1C,4DAAkC;AAClC,qDAA2B;AAC3B,2DAAiC;AACjC,oDAA0B;AAC1B,6EAAmD;AACnD,sEAA4C;AAC5C,+DAAqC;AACrC,wDAA8B;AAC9B,+DAAqC;AACrC,gEAAsC;AACtC,iEAAuC;AACvC,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC;AAChC,6EAAmD;AACnD,oFAA0D;AAC1D,kEAAwC;AACxC,yEAA+C"}

package/lib/requests/bulk-tracking-request.d.ts

@@ -0,0 +1,14 @@
+import { BaseRequest } from './base-request';
+import { TrackingIdentifier, TrackingAttribute } from '../models';
+/** @description A single shipment to request tracking information for as part of a bulk tracking request */
+export declare class BulkTrackingItem {
+    /** @description List of identifiers */
+    identifiers?: TrackingIdentifier[];
+    /** @description List of attributes */
+    attributes?: TrackingAttribute[];
+}
+/** @description Basic structure for a request to get tracking information for multiple shipments in a single call */
+export declare class BulkTrackingRequest extends BaseRequest {
+    /** @description The shipments to retrieve tracking information for */
+    items: BulkTrackingItem[];
+}

package/lib/requests/bulk-tracking-request.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkTrackingRequest = exports.BulkTrackingItem = void 0;
+const base_request_1 = require("./base-request");
+/** @description A single shipment to request tracking information for as part of a bulk tracking request */
+class BulkTrackingItem {
+    /** @description List of identifiers */
+    identifiers;
+    /** @description List of attributes */
+    attributes;
+}
+exports.BulkTrackingItem = BulkTrackingItem;
+/** @description Basic structure for a request to get tracking information for multiple shipments in a single call */
+class BulkTrackingRequest extends base_request_1.BaseRequest {
+    /** @description The shipments to retrieve tracking information for */
+    items;
+}
+exports.BulkTrackingRequest = BulkTrackingRequest;
+//# sourceMappingURL=bulk-tracking-request.js.map

package/lib/requests/bulk-tracking-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-tracking-request.js","sourceRoot":"","sources":["../../src/requests/bulk-tracking-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,4GAA4G;AAC5G,MAAa,gBAAgB;IAC3B,uCAAuC;IACvC,WAAW,CAAwB;IACnC,sCAAsC;IACtC,UAAU,CAAuB;CAClC;AALD,4CAKC;AAED,qHAAqH;AACrH,MAAa,mBAAoB,SAAQ,0BAAW;IAClD,sEAAsE;IACtE,KAAK,CAAsB;CAC5B;AAHD,kDAGC"}

package/lib/requests/index.d.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-request';
 export * from './cancel-notification-request';
 export * from './cancel-pickup-request';
 export * from './create-label-request';

package/lib/requests/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./bulk-tracking-request"), exports);
 tslib_1.__exportStar(require("./cancel-notification-request"), exports);
 tslib_1.__exportStar(require("./cancel-pickup-request"), exports);
 tslib_1.__exportStar(require("./create-label-request"), exports);

package/lib/requests/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,wEAA8C;AAC9C,kEAAwC;AACxC,iEAAuC;AACvC,oEAA0C;AAC1C,wEAA8C;AAC9C,iEAAuC;AACvC,8DAAoC;AACpC,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C;AAC7C,2EAAiD;AACjD,4EAAkD;AAClD,6DAAmC;AACnC,oEAA0C;AAC1C,iEAAuC;AACvC,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C;AAC1C,mEAAyC;AACzC,0EAAgD;AAChD,oEAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,wEAA8C;AAC9C,kEAAwC;AACxC,iEAAuC;AACvC,oEAA0C;AAC1C,wEAA8C;AAC9C,iEAAuC;AACvC,8DAAoC;AACpC,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C;AAC7C,2EAAiD;AACjD,4EAAkD;AAClD,6DAAmC;AACnC,oEAA0C;AAC1C,iEAAuC;AACvC,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C;AAC1C,mEAAyC;AACzC,0EAAgD;AAChD,oEAA0C"}

package/lib/responses/bulk-tracking-response.d.ts

@@ -0,0 +1,18 @@
+import { BaseResponse } from './base-response';
+import { TrackingInfo } from '../models';
+import { BulkTrackingError } from '../models/tracking/bulk-tracking-error';
+/** @description Tracking result for a single item within a bulk tracking response */
+export declare class BulkTrackingResultItem {
+    /** @description The carrier specific tracking identifier for this shipment */
+    tracking_number: string;
+    /** @description Tracking information for this shipment, present when tracking succeeded */
+    tracking_info?: TrackingInfo;
+    /** @description Error detail for this shipment, present when tracking failed */
+    error?: BulkTrackingError;
+}
+/** @description Basic structure for a response to get tracking information for multiple shipments in a single call */
+export declare class BulkTrackingResponse extends BaseResponse {
+    transaction_id: string;
+    /** @description Per-item tracking results, in no guaranteed order relative to the request's items */
+    results: BulkTrackingResultItem[];
+}

package/lib/responses/bulk-tracking-response.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkTrackingResponse = exports.BulkTrackingResultItem = void 0;
+const base_response_1 = require("./base-response");
+/** @description Tracking result for a single item within a bulk tracking response */
+class BulkTrackingResultItem {
+    /** @description The carrier specific tracking identifier for this shipment */
+    tracking_number;
+    /** @description Tracking information for this shipment, present when tracking succeeded */
+    tracking_info;
+    /** @description Error detail for this shipment, present when tracking failed */
+    error;
+}
+exports.BulkTrackingResultItem = BulkTrackingResultItem;
+/** @description Basic structure for a response to get tracking information for multiple shipments in a single call */
+class BulkTrackingResponse extends base_response_1.BaseResponse {
+    transaction_id;
+    /** @description Per-item tracking results, in no guaranteed order relative to the request's items */
+    results;
+}
+exports.BulkTrackingResponse = BulkTrackingResponse;
+//# sourceMappingURL=bulk-tracking-response.js.map

package/lib/responses/bulk-tracking-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-tracking-response.js","sourceRoot":"","sources":["../../src/responses/bulk-tracking-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAI/C,qFAAqF;AACrF,MAAa,sBAAsB;IACjC,8EAA8E;IAC9E,eAAe,CAAU;IACzB,2FAA2F;IAC3F,aAAa,CAAgB;IAC7B,gFAAgF;IAChF,KAAK,CAAqB;CAC3B;AAPD,wDAOC;AAED,sHAAsH;AACtH,MAAa,oBAAqB,SAAQ,4BAAY;IACpD,cAAc,CAAU;IACxB,qGAAqG;IACrG,OAAO,CAA4B;CACpC;AAJD,oDAIC"}

package/lib/responses/index.d.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-response';
 export * from './cancel-notification-response-schema';
 export * from './cancel-notification-response';
 export * from './cancel-pickup-response-schema';

package/lib/responses/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./bulk-tracking-response"), exports);
 tslib_1.__exportStar(require("./cancel-notification-response-schema"), exports);
 tslib_1.__exportStar(require("./cancel-notification-response"), exports);
 tslib_1.__exportStar(require("./cancel-pickup-response-schema"), exports);

package/lib/responses/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,yEAA+C;AAC/C,0EAAgD;AAChD,mEAAyC;AACzC,yEAA+C;AAC/C,kEAAwC;AACxC,4EAAkD;AAClD,qEAA2C;AAC3C,gFAAsD;AACtD,yEAA+C;AAC/C,2DAAiC;AACjC,sEAA4C;AAC5C,+DAAqC;AACrC,6EAAmD;AACnD,sEAA4C;AAC5C,8EAAoD;AACpD,uEAA6C;AAC7C,+EAAqD;AACrD,wEAA8C;AAC9C,oFAA0D;AAC1D,6EAAmD;AACnD,qEAA2C;AAC3C,8DAAoC;AACpC,4EAAkD;AAClD,qEAA2C;AAC3C,yEAA+C;AAC/C,kEAAwC;AACxC,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C;AAC3C,oEAA0C;AAC1C,2EAAiD;AACjD,qEAA2C;AAC3C,4EAAkD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,gFAAsD;AACtD,yEAA+C;AAC/C,0EAAgD;AAChD,mEAAyC;AACzC,yEAA+C;AAC/C,kEAAwC;AACxC,4EAAkD;AAClD,qEAA2C;AAC3C,gFAAsD;AACtD,yEAA+C;AAC/C,2DAAiC;AACjC,sEAA4C;AAC5C,+DAAqC;AACrC,6EAAmD;AACnD,sEAA4C;AAC5C,8EAAoD;AACpD,uEAA6C;AAC7C,+EAAqD;AACrD,wEAA8C;AAC9C,oFAA0D;AAC1D,6EAAmD;AACnD,qEAA2C;AAC3C,8DAAoC;AACpC,4EAAkD;AAClD,qEAA2C;AAC3C,yEAA+C;AAC/C,kEAAwC;AACxC,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C;AAC3C,oEAA0C;AAC1C,2EAAiD;AACjD,qEAA2C;AAC3C,4EAAkD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.33.0",
+  "version": "4.34.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/src/app/carrier-app-definition.ts

@@ -2,6 +2,7 @@ import { ImportedTrackingEvent } from '../models';
 import type { Request } from 'express';
 import {
   RegisterRequest,
+  BulkTrackingRequest,
   CreateLabelRequest,
   VoidLabelsRequest,
   CreateManifestRequest,
@@ -26,6 +27,7 @@ import {
 
 import {
   RegisterResponse,
+  BulkTrackingResponse,
   CreateLabelResponse,
   VoidLabelsResponse,
   CreateManifestResponse,
@@ -108,6 +110,13 @@ export interface CarrierAppDefinition {
    * @param request Data needed by the provider to track a shipment
    */
   Track?: (request: TrackingRequest) => TrackingResponse | Promise<TrackingResponse>;
+  /**
+   * @description This endpoint is used to get tracking information about multiple shipments in a single call
+   * @param request Data needed by the provider to track multiple shipments
+   */
+  BulkTrack?: (
+    request: BulkTrackingRequest,
+  ) => BulkTrackingResponse | Promise<BulkTrackingResponse>;
   /**
    * @description This endpoint is used to submit notification of the creation of a shipment
    * @param request Data needed by the provider to inform them of a shipment

package/src/app/constants.ts

@@ -8,6 +8,7 @@ export enum ApiEndpoints {
   SchedulePickup = '/SchedulePickup',
   CancelPickup = '/CancelPickup',
   Track = '/Track',
+  BulkTrack = '/BulkTrack',
   CreateNotification = '/CreateNotification',
   CancelNotification = '/CancelNotification',
   ValidateInboundData = '/ValidateInboundData',

package/src/app/create-endpoint-mapping.ts

@@ -7,6 +7,7 @@ export const createEndpointMapping = (
 ): [Method, string, Handler | undefined][] => [
   //TODO: Remove `Method.POST` from this and all other maps since they are ALL post
   //TODO: Remove JOI validation from all endpoints and replace them with OpenAPI validation
+  [Method.POST, ApiEndpoints.BulkTrack, definition.BulkTrack],
   [Method.POST, ApiEndpoints.CancelNotification, definition.CancelNotification],
   [Method.POST, ApiEndpoints.CancelPickup, definition.CancelPickup],
   [Method.POST, ApiEndpoints.CreateLabel, definition.CreateLabel],

package/src/models/tracking/bulk-tracking-error.ts

@@ -0,0 +1,7 @@
+/** @description Error detail for a single item within a bulk tracking response */
+export class BulkTrackingError {
+  /** @description A code identifying the type of error encountered while tracking this item */
+  code!: string;
+  /** @description A human readable description of the error */
+  message!: string;
+}

package/src/models/tracking/index.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-error';
 export * from './imported-tracking-event-schema';
 export * from './imported-tracking-event';
 export * from './lat-long-schema';

package/src/requests/bulk-tracking-request.ts

@@ -0,0 +1,16 @@
+import { BaseRequest } from './base-request';
+import { TrackingIdentifier, TrackingAttribute } from '../models';
+
+/** @description A single shipment to request tracking information for as part of a bulk tracking request */
+export class BulkTrackingItem {
+  /** @description List of identifiers */
+  identifiers?: TrackingIdentifier[];
+  /** @description List of attributes */
+  attributes?: TrackingAttribute[];
+}
+
+/** @description Basic structure for a request to get tracking information for multiple shipments in a single call */
+export class BulkTrackingRequest extends BaseRequest {
+  /** @description The shipments to retrieve tracking information for */
+  items!: BulkTrackingItem[];
+}

package/src/requests/index.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-request';
 export * from './cancel-notification-request';
 export * from './cancel-pickup-request';
 export * from './create-label-request';

package/src/responses/bulk-tracking-response.ts

@@ -0,0 +1,20 @@
+import { BaseResponse } from './base-response';
+import { TrackingInfo } from '../models';
+import { BulkTrackingError } from '../models/tracking/bulk-tracking-error';
+
+/** @description Tracking result for a single item within a bulk tracking response */
+export class BulkTrackingResultItem {
+  /** @description The carrier specific tracking identifier for this shipment */
+  tracking_number!: string;
+  /** @description Tracking information for this shipment, present when tracking succeeded */
+  tracking_info?: TrackingInfo;
+  /** @description Error detail for this shipment, present when tracking failed */
+  error?: BulkTrackingError;
+}
+
+/** @description Basic structure for a response to get tracking information for multiple shipments in a single call */
+export class BulkTrackingResponse extends BaseResponse {
+  transaction_id!: string;
+  /** @description Per-item tracking results, in no guaranteed order relative to the request's items */
+  results!: BulkTrackingResultItem[];
+}

package/src/responses/index.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-response';
 export * from './cancel-notification-response-schema';
 export * from './cancel-notification-response';
 export * from './cancel-pickup-response-schema';