ultracart_rest_api_v2_typescript 4.0.225 → 4.0.226

package/.openapi-generator/FILES

@@ -561,6 +561,9 @@ src/models/ItemIdentifiers.ts
 src/models/ItemInstantPaymentNotification.ts
 src/models/ItemInstantPaymentNotifications.ts
 src/models/ItemInternal.ts
+src/models/ItemInventorySnapshot.ts
+src/models/ItemInventorySnapshotDistributionCenter.ts
+src/models/ItemInventorySnapshotResponse.ts
 src/models/ItemKitComponent.ts
 src/models/ItemKitDefinition.ts
 src/models/ItemOption.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.225
+## ultracart_rest_api_v2_typescript@4.0.226
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.225 --save
+npm install ultracart_rest_api_v2_typescript@4.0.226 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.226 | 05/31/2024 | ItemApi.getInventorySnapshot method |
 | 4.0.225 | 05/30/2024 | add adult sig req. to the merchant item destination markup for items |
 | 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
 | 4.0.223 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |

package/dist/apis/ItemApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
+import { Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemInventorySnapshotResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
 export interface DeleteDigitalItemRequest {
     digitalItemOid: number;
 }
@@ -385,6 +385,19 @@ export interface ItemApiInterface {
      * Upsert an item content attribute
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApiInterface
+     */
+    restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
+    /**
+     * Retrieves a list of item inventories.
+     * Retrieve a list of item inventories
+     */
+    restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library
@@ -639,6 +652,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
      * Upsert an item content attribute
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves a list of item inventories.
+     * Retrieve a list of item inventories
+     */
+    restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
+    /**
+     * Retrieves a list of item inventories.
+     * Retrieve a list of item inventories
+     */
+    restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * Updates a file within the digital library

package/dist/apis/ItemApi.js

@@ -1163,6 +1163,62 @@ var ItemApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieves a list of item inventories.
+     * Retrieve a list of item inventories
+     */
+    ItemApi.prototype.restItemInventorySnapshotResponseRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/item/items/inventory_snapshot",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemInventorySnapshotResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves a list of item inventories.
+     * Retrieve a list of item inventories
+     */
+    ItemApi.prototype.restItemInventorySnapshotResponse = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.restItemInventorySnapshotResponseRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * Updates a file within the digital library

package/dist/models/ItemInventorySnapshot.d.ts

@@ -0,0 +1,58 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemInventorySnapshotDistributionCenter } from './ItemInventorySnapshotDistributionCenter';
+/**
+ *
+ * @export
+ * @interface ItemInventorySnapshot
+ */
+export interface ItemInventorySnapshot {
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    available_to_allocate?: number;
+    /**
+     *
+     * @type {Array<ItemInventorySnapshotDistributionCenter>}
+     * @memberof ItemInventorySnapshot
+     */
+    distribution_centers?: Array<ItemInventorySnapshotDistributionCenter>;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemInventorySnapshot
+     */
+    merchant_item_id?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    quantity?: number;
+}
+export declare function ItemInventorySnapshotFromJSON(json: any): ItemInventorySnapshot;
+export declare function ItemInventorySnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemInventorySnapshot;
+export declare function ItemInventorySnapshotToJSON(value?: ItemInventorySnapshot | null): any;

package/dist/models/ItemInventorySnapshot.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemInventorySnapshotToJSON = exports.ItemInventorySnapshotFromJSONTyped = exports.ItemInventorySnapshotFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ItemInventorySnapshotDistributionCenter_1 = require("./ItemInventorySnapshotDistributionCenter");
+function ItemInventorySnapshotFromJSON(json) {
+    return ItemInventorySnapshotFromJSONTyped(json, false);
+}
+exports.ItemInventorySnapshotFromJSON = ItemInventorySnapshotFromJSON;
+function ItemInventorySnapshotFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'allocated_to_placed_orders': !(0, runtime_1.exists)(json, 'allocated_to_placed_orders') ? undefined : json['allocated_to_placed_orders'],
+        'allocated_to_shopping_carts': !(0, runtime_1.exists)(json, 'allocated_to_shopping_carts') ? undefined : json['allocated_to_shopping_carts'],
+        'available_to_allocate': !(0, runtime_1.exists)(json, 'available_to_allocate') ? undefined : json['available_to_allocate'],
+        'distribution_centers': !(0, runtime_1.exists)(json, 'distribution_centers') ? undefined : (json['distribution_centers'].map(ItemInventorySnapshotDistributionCenter_1.ItemInventorySnapshotDistributionCenterFromJSON)),
+        'merchant_item_id': !(0, runtime_1.exists)(json, 'merchant_item_id') ? undefined : json['merchant_item_id'],
+        'quantity': !(0, runtime_1.exists)(json, 'quantity') ? undefined : json['quantity'],
+    };
+}
+exports.ItemInventorySnapshotFromJSONTyped = ItemInventorySnapshotFromJSONTyped;
+function ItemInventorySnapshotToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'allocated_to_placed_orders': value.allocated_to_placed_orders,
+        'allocated_to_shopping_carts': value.allocated_to_shopping_carts,
+        'available_to_allocate': value.available_to_allocate,
+        'distribution_centers': value.distribution_centers === undefined ? undefined : (value.distribution_centers.map(ItemInventorySnapshotDistributionCenter_1.ItemInventorySnapshotDistributionCenterToJSON)),
+        'merchant_item_id': value.merchant_item_id,
+        'quantity': value.quantity,
+    };
+}
+exports.ItemInventorySnapshotToJSON = ItemInventorySnapshotToJSON;

package/dist/models/ItemInventorySnapshotDistributionCenter.d.ts

@@ -0,0 +1,51 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ItemInventorySnapshotDistributionCenter
+ */
+export interface ItemInventorySnapshotDistributionCenter {
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    available_to_allocate?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    code?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    quantity?: number;
+}
+export declare function ItemInventorySnapshotDistributionCenterFromJSON(json: any): ItemInventorySnapshotDistributionCenter;
+export declare function ItemInventorySnapshotDistributionCenterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemInventorySnapshotDistributionCenter;
+export declare function ItemInventorySnapshotDistributionCenterToJSON(value?: ItemInventorySnapshotDistributionCenter | null): any;

package/dist/models/ItemInventorySnapshotDistributionCenter.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemInventorySnapshotDistributionCenterToJSON = exports.ItemInventorySnapshotDistributionCenterFromJSONTyped = exports.ItemInventorySnapshotDistributionCenterFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function ItemInventorySnapshotDistributionCenterFromJSON(json) {
+    return ItemInventorySnapshotDistributionCenterFromJSONTyped(json, false);
+}
+exports.ItemInventorySnapshotDistributionCenterFromJSON = ItemInventorySnapshotDistributionCenterFromJSON;
+function ItemInventorySnapshotDistributionCenterFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'allocated_to_placed_orders': !(0, runtime_1.exists)(json, 'allocated_to_placed_orders') ? undefined : json['allocated_to_placed_orders'],
+        'allocated_to_shopping_carts': !(0, runtime_1.exists)(json, 'allocated_to_shopping_carts') ? undefined : json['allocated_to_shopping_carts'],
+        'available_to_allocate': !(0, runtime_1.exists)(json, 'available_to_allocate') ? undefined : json['available_to_allocate'],
+        'code': !(0, runtime_1.exists)(json, 'code') ? undefined : json['code'],
+        'quantity': !(0, runtime_1.exists)(json, 'quantity') ? undefined : json['quantity'],
+    };
+}
+exports.ItemInventorySnapshotDistributionCenterFromJSONTyped = ItemInventorySnapshotDistributionCenterFromJSONTyped;
+function ItemInventorySnapshotDistributionCenterToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'allocated_to_placed_orders': value.allocated_to_placed_orders,
+        'allocated_to_shopping_carts': value.allocated_to_shopping_carts,
+        'available_to_allocate': value.available_to_allocate,
+        'code': value.code,
+        'quantity': value.quantity,
+    };
+}
+exports.ItemInventorySnapshotDistributionCenterToJSON = ItemInventorySnapshotDistributionCenterToJSON;

package/dist/models/ItemInventorySnapshotResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemInventorySnapshot } from './ItemInventorySnapshot';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface ItemInventorySnapshotResponse
+ */
+export interface ItemInventorySnapshotResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    error?: ModelError;
+    /**
+     * inventories
+     * @type {Array<ItemInventorySnapshot>}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    inventories?: Array<ItemInventorySnapshot>;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    warning?: Warning;
+}
+export declare function ItemInventorySnapshotResponseFromJSON(json: any): ItemInventorySnapshotResponse;
+export declare function ItemInventorySnapshotResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemInventorySnapshotResponse;
+export declare function ItemInventorySnapshotResponseToJSON(value?: ItemInventorySnapshotResponse | null): any;

package/dist/models/ItemInventorySnapshotResponse.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemInventorySnapshotResponseToJSON = exports.ItemInventorySnapshotResponseFromJSONTyped = exports.ItemInventorySnapshotResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ItemInventorySnapshot_1 = require("./ItemInventorySnapshot");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function ItemInventorySnapshotResponseFromJSON(json) {
+    return ItemInventorySnapshotResponseFromJSONTyped(json, false);
+}
+exports.ItemInventorySnapshotResponseFromJSON = ItemInventorySnapshotResponseFromJSON;
+function ItemInventorySnapshotResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'inventories': !(0, runtime_1.exists)(json, 'inventories') ? undefined : (json['inventories'].map(ItemInventorySnapshot_1.ItemInventorySnapshotFromJSON)),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.ItemInventorySnapshotResponseFromJSONTyped = ItemInventorySnapshotResponseFromJSONTyped;
+function ItemInventorySnapshotResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'inventories': value.inventories === undefined ? undefined : (value.inventories.map(ItemInventorySnapshot_1.ItemInventorySnapshotToJSON)),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.ItemInventorySnapshotResponseToJSON = ItemInventorySnapshotResponseToJSON;

package/dist/models/index.d.ts

@@ -534,6 +534,9 @@ export * from './ItemIdentifiers';
 export * from './ItemInstantPaymentNotification';
 export * from './ItemInstantPaymentNotifications';
 export * from './ItemInternal';
+export * from './ItemInventorySnapshot';
+export * from './ItemInventorySnapshotDistributionCenter';
+export * from './ItemInventorySnapshotResponse';
 export * from './ItemKitComponent';
 export * from './ItemKitDefinition';
 export * from './ItemOption';

package/dist/models/index.js

@@ -552,6 +552,9 @@ __exportStar(require("./ItemIdentifiers"), exports);
 __exportStar(require("./ItemInstantPaymentNotification"), exports);
 __exportStar(require("./ItemInstantPaymentNotifications"), exports);
 __exportStar(require("./ItemInternal"), exports);
+__exportStar(require("./ItemInventorySnapshot"), exports);
+__exportStar(require("./ItemInventorySnapshotDistributionCenter"), exports);
+__exportStar(require("./ItemInventorySnapshotResponse"), exports);
 __exportStar(require("./ItemKitComponent"), exports);
 __exportStar(require("./ItemKitDefinition"), exports);
 __exportStar(require("./ItemOption"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.225",
+  "version": "4.0.226",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/ItemApi.ts

@@ -33,6 +33,9 @@ import {
     ItemDigitalItemsResponse,
     ItemDigitalItemsResponseFromJSON,
     ItemDigitalItemsResponseToJSON,
+    ItemInventorySnapshotResponse,
+    ItemInventorySnapshotResponseFromJSON,
+    ItemInventorySnapshotResponseToJSON,
     ItemResponse,
     ItemResponseFromJSON,
     ItemResponseToJSON,
@@ -489,6 +492,21 @@ export interface ItemApiInterface {
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Retrieves a list of item inventories. 
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApiInterface
+     */
+    restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
+
+    /**
+     * Retrieves a list of item inventories. 
+     * Retrieve a list of item inventories
+     */
+    restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
+
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
      * @summary Updates a file within the digital library
@@ -1398,6 +1416,43 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
         await this.insertUpdateItemContentAttributeRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Retrieves a list of item inventories. 
+     * Retrieve a list of item inventories
+     */
+    async restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["item_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/item/items/inventory_snapshot`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ItemInventorySnapshotResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of item inventories. 
+     * Retrieve a list of item inventories
+     */
+    async restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse> {
+        const response = await this.restItemInventorySnapshotResponseRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
      * Updates a file within the digital library

package/src/models/ItemInventorySnapshot.ts

@@ -0,0 +1,103 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ItemInventorySnapshotDistributionCenter,
+    ItemInventorySnapshotDistributionCenterFromJSON,
+    ItemInventorySnapshotDistributionCenterFromJSONTyped,
+    ItemInventorySnapshotDistributionCenterToJSON,
+} from './ItemInventorySnapshotDistributionCenter';
+
+/**
+ * 
+ * @export
+ * @interface ItemInventorySnapshot
+ */
+export interface ItemInventorySnapshot {
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    available_to_allocate?: number;
+    /**
+     * 
+     * @type {Array<ItemInventorySnapshotDistributionCenter>}
+     * @memberof ItemInventorySnapshot
+     */
+    distribution_centers?: Array<ItemInventorySnapshotDistributionCenter>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ItemInventorySnapshot
+     */
+    merchant_item_id?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    quantity?: number;
+}
+
+export function ItemInventorySnapshotFromJSON(json: any): ItemInventorySnapshot {
+    return ItemInventorySnapshotFromJSONTyped(json, false);
+}
+
+export function ItemInventorySnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemInventorySnapshot {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'allocated_to_placed_orders': !exists(json, 'allocated_to_placed_orders') ? undefined : json['allocated_to_placed_orders'],
+        'allocated_to_shopping_carts': !exists(json, 'allocated_to_shopping_carts') ? undefined : json['allocated_to_shopping_carts'],
+        'available_to_allocate': !exists(json, 'available_to_allocate') ? undefined : json['available_to_allocate'],
+        'distribution_centers': !exists(json, 'distribution_centers') ? undefined : ((json['distribution_centers'] as Array<any>).map(ItemInventorySnapshotDistributionCenterFromJSON)),
+        'merchant_item_id': !exists(json, 'merchant_item_id') ? undefined : json['merchant_item_id'],
+        'quantity': !exists(json, 'quantity') ? undefined : json['quantity'],
+    };
+}
+
+export function ItemInventorySnapshotToJSON(value?: ItemInventorySnapshot | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'allocated_to_placed_orders': value.allocated_to_placed_orders,
+        'allocated_to_shopping_carts': value.allocated_to_shopping_carts,
+        'available_to_allocate': value.available_to_allocate,
+        'distribution_centers': value.distribution_centers === undefined ? undefined : ((value.distribution_centers as Array<any>).map(ItemInventorySnapshotDistributionCenterToJSON)),
+        'merchant_item_id': value.merchant_item_id,
+        'quantity': value.quantity,
+    };
+}
+

package/src/models/ItemInventorySnapshotDistributionCenter.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ItemInventorySnapshotDistributionCenter
+ */
+export interface ItemInventorySnapshotDistributionCenter {
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    available_to_allocate?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    code?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    quantity?: number;
+}
+
+export function ItemInventorySnapshotDistributionCenterFromJSON(json: any): ItemInventorySnapshotDistributionCenter {
+    return ItemInventorySnapshotDistributionCenterFromJSONTyped(json, false);
+}
+
+export function ItemInventorySnapshotDistributionCenterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemInventorySnapshotDistributionCenter {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'allocated_to_placed_orders': !exists(json, 'allocated_to_placed_orders') ? undefined : json['allocated_to_placed_orders'],
+        'allocated_to_shopping_carts': !exists(json, 'allocated_to_shopping_carts') ? undefined : json['allocated_to_shopping_carts'],
+        'available_to_allocate': !exists(json, 'available_to_allocate') ? undefined : json['available_to_allocate'],
+        'code': !exists(json, 'code') ? undefined : json['code'],
+        'quantity': !exists(json, 'quantity') ? undefined : json['quantity'],
+    };
+}
+
+export function ItemInventorySnapshotDistributionCenterToJSON(value?: ItemInventorySnapshotDistributionCenter | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'allocated_to_placed_orders': value.allocated_to_placed_orders,
+        'allocated_to_shopping_carts': value.allocated_to_shopping_carts,
+        'available_to_allocate': value.available_to_allocate,
+        'code': value.code,
+        'quantity': value.quantity,
+    };
+}
+

package/src/models/ItemInventorySnapshotResponse.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ItemInventorySnapshot,
+    ItemInventorySnapshotFromJSON,
+    ItemInventorySnapshotFromJSONTyped,
+    ItemInventorySnapshotToJSON,
+} from './ItemInventorySnapshot';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface ItemInventorySnapshotResponse
+ */
+export interface ItemInventorySnapshotResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    error?: ModelError;
+    /**
+     * inventories
+     * @type {Array<ItemInventorySnapshot>}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    inventories?: Array<ItemInventorySnapshot>;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    warning?: Warning;
+}
+
+export function ItemInventorySnapshotResponseFromJSON(json: any): ItemInventorySnapshotResponse {
+    return ItemInventorySnapshotResponseFromJSONTyped(json, false);
+}
+
+export function ItemInventorySnapshotResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemInventorySnapshotResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'inventories': !exists(json, 'inventories') ? undefined : ((json['inventories'] as Array<any>).map(ItemInventorySnapshotFromJSON)),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function ItemInventorySnapshotResponseToJSON(value?: ItemInventorySnapshotResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'inventories': value.inventories === undefined ? undefined : ((value.inventories as Array<any>).map(ItemInventorySnapshotToJSON)),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -536,6 +536,9 @@ export * from './ItemIdentifiers';
 export * from './ItemInstantPaymentNotification';
 export * from './ItemInstantPaymentNotifications';
 export * from './ItemInternal';
+export * from './ItemInventorySnapshot';
+export * from './ItemInventorySnapshotDistributionCenter';
+export * from './ItemInventorySnapshotResponse';
 export * from './ItemKitComponent';
 export * from './ItemKitDefinition';
 export * from './ItemOption';