shipbob-node-sdk 0.0.13 → 0.0.16

package/README.md

@@ -1,5 +1,7 @@
 # ShipBob Node SDK
 
+Feb 2026 - The various versions of their API are all set to expire soon. They have published a policy (https://developer.shipbob.com/versioning) indicating that future versions will be supported for 12 months from release date and that versions `1.0` and `2.0` are deprecated.
+
 First of all there are no official SDKs for ShipBob. I'm just dropping this here, in case it will speed up somebody else getting started using their API.
 
 This library uses the built-in node.js fetch, so you'll want a newer node version with undici support.
@@ -11,6 +13,25 @@ This SDK exposes some endpoints not available in the OpenAPI including:
 - `/experimental/product` :skull:
 - `/experimental/receiving` :skull:
 
+As of Nov 2025 the OpenAPI specs (including 2025-07) are available for additional versions:
+[Open API specs](https://developer.shipbob.com/faq#how-can-i-find-openapi-specs-for-each-api-version)
+
+<div align="center">
+ <a href="https://www.npmjs.com/package/shipbob-node-sdk">
+  <img alt="Weekly downloads" src="https://badgen.net/npm/dw/shipbob-node-sdk?color=blue" />
+ </a>
+</div>
+
+## install
+
+```bash
+npm i shipbob-node-sdk
+```
+
+```bash
+yarn add shipbob-node-sdk
+```
+
 Have a look in the `/test` folder. You might like more something like PostMan, but you can run and debug these "tests" in VS Code. You need a `.env` file like this:
 
 ```bash
@@ -372,3 +393,34 @@ const results = await api.experimentalReceivingSetExternalSync([443001], true);
 - Iterate through each box
 - Iterate through each item in the box_items array
 - Sync the stowed_quantity for each item back to your system
+
+# Synchronizing inventory levels
+
+There are no webhooks or easy way to sync. Plus once you place an order there is a delay (~1 minute) before the inventory levels are impacted.
+
+So, if you have one FC, you can use total_sellable_quantity for each inventory item.
+
+For multiple FCs - their recommendation is to use for each FC the fulfillable_quantity and subtract the total_exception_quantity (since it could be assigned to either FC).
+
+```json
+{
+  "id": 1234,
+  "name": "...",
+  "total_fulfillable_quantity": 1688,
+  "total_onhand_quantity": 1688,
+  "total_committed_quantity": 0,
+  "total_sellable_quantity": 1688,
+  "total_exception_quantity": 0,
+  "fulfillable_quantity_by_fulfillment_center": [
+    {
+      "id": 211,
+      "name": "Fairburn (GA)",
+      "fulfillable_quantity": 1688,
+      "onhand_quantity": 1688,
+      "committed_quantity": 0,
+      "awaiting_quantity": 0,
+      "internal_transfer_quantity": 0
+    }
+  ]
+}
+```

package/dist/types.d.ts

@@ -589,6 +589,10 @@ export type Order = {
 export type PaymentShipTerm = 'Collect' | 'ThirdParty' | 'Prepaid' | 'MerchantResponsible';
 export type CarrierShipType = 'Parcel' | 'Freight';
 export type PlaceOrderRequest = {
+    /**
+     * Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.
+     */
+    location_id: null | number;
     /**
      * User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used (<= 400 characters)
      */
@@ -678,6 +682,11 @@ export type PlaceOrderRequest = {
      * Enum: "DTC" "DropShip" "B2B" "Transportation"
      */
     type: OrderType;
+    /**
+     * Gift message associated with the order
+     * Maximum string length: 500
+     */
+    gift_message: string | null;
 };
 export type ShippingMethod = {
     /**
@@ -1070,6 +1079,9 @@ export declare enum ReturnAction {
     Dispose = 3
 }
 export type VariantRequestProductExperimental = Omit<VariantRequestProduct2_0, 'barcode'> & {
+    /**
+     * Multiple barcodes support added in 2.0
+     */
     barcodes: {
         value: string;
         sticker_url: Nullable<string>;
@@ -1127,13 +1139,55 @@ export type VariantRequestProduct2_0 = {
         return_to_sender_primary_action_id: Nullable<ReturnAction>;
         return_to_sender_backup_action_id: Nullable<ReturnAction>;
     };
-    lot_information: {
+    lot_information?: {
         /**
          * If the product should use lot date based picking
          */
         is_lot: boolean;
         minimum_shelf_life_days: Nullable<number>;
     };
+    /**
+     * This is not part of Open API spec, but found starting with Product 2.0
+     */
+    fulfillment_settings?: {
+        is_bpm_parcel?: boolean;
+        is_case_pick?: boolean;
+        msds_url?: Nullable<string>;
+        dangerous_goods?: boolean;
+        /**
+         * If the product requires a prop65 label in the box
+         */
+        requires_prop65?: boolean;
+        serial_scan?: {
+            /**
+             * Indicates if a Serial Scan is required during the pack process.
+             * Note: Serial scan requires either a prefix or a suffix to be defined
+             */
+            is_enabled: boolean;
+            /**
+             * The exact number of characters expected in the serial number
+             */
+            exact_character_length?: Nullable<number>;
+        } & ({
+            /**
+             * The prefix expected on the serial number
+             */
+            prefix: string;
+            /**
+             * The suffix expected on the serial number
+             */
+            suffix?: Nullable<string>;
+        } | {
+            /**
+             * The prefix expected on the serial number
+             */
+            prefix?: Nullable<string>;
+            /**
+             * The suffix expected on the serial number
+             */
+            suffix: string;
+        });
+    };
 };
 export type GetProductQueryStrings = Partial<{
     Page: number;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AA8lCA,IAAY,oBAWX;AAXD,WAAY,oBAAoB;IAC9B,wBAAwB;IACxB,qFAAqB,CAAA;IACrB,qEAAW,CAAA;IACX,6EAAiB,CAAA;IACjB,iGAA2B,CAAA;IAC3B,qEAAa,CAAA;IACb,yEAAe,CAAA;IACf,2EAAgB,CAAA;IAChB,uLAAsE,CAAA;IACtE,iGAA2B,CAAA;AAC7B,CAAC,EAXW,oBAAoB,oCAApB,oBAAoB,QAW/B;AAED,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,uDAAS,CAAA;IACT,2EAAmB,CAAA;IACnB,uEAAiB,CAAA;IACjB,cAAc;IACd,uEAAiB,CAAA;IACjB,qEAAgB,CAAA;IAChB,iEAAc,CAAA;IACd,2FAA2B,CAAA;IAC3B,yFAA0B,CAAA;IAC1B,sFAAyB,CAAA;AAC3B,CAAC,EAXW,iBAAiB,iCAAjB,iBAAiB,QAW5B;AAED;;;;GAIG;AACH,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB;;OAEG;IACH,qDAAW,CAAA;IACX;;OAEG;IACH,2DAAc,CAAA;IACd;;OAEG;IACH,qDAAW,CAAA;AACb,CAAC,EAbW,YAAY,4BAAZ,YAAY,QAavB;AAmUD;;;;GAIG;AACH,IAAY,YA8BX;AA9BD,WAAY,YAAY;IACtB;;;;OAIG;IACH,8CAA8B,CAAA;IAC9B;;;OAGG;IACH,wDAAwC,CAAA;IACxC;;;;OAIG;IACH,wDAAwC,CAAA;IACxC;;;;OAIG;IACH,kDAAkC,CAAA;IAClC;;;;OAIG;IACH,wDAAwC,CAAA;AAC1C,CAAC,EA9BW,YAAY,4BAAZ,YAAY,QA8BvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAwmCA,IAAY,oBAWX;AAXD,WAAY,oBAAoB;IAC9B,wBAAwB;IACxB,qFAAqB,CAAA;IACrB,qEAAW,CAAA;IACX,6EAAiB,CAAA;IACjB,iGAA2B,CAAA;IAC3B,qEAAa,CAAA;IACb,yEAAe,CAAA;IACf,2EAAgB,CAAA;IAChB,uLAAsE,CAAA;IACtE,iGAA2B,CAAA;AAC7B,CAAC,EAXW,oBAAoB,oCAApB,oBAAoB,QAW/B;AAED,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,uDAAS,CAAA;IACT,2EAAmB,CAAA;IACnB,uEAAiB,CAAA;IACjB,cAAc;IACd,uEAAiB,CAAA;IACjB,qEAAgB,CAAA;IAChB,iEAAc,CAAA;IACd,2FAA2B,CAAA;IAC3B,yFAA0B,CAAA;IAC1B,sFAAyB,CAAA;AAC3B,CAAC,EAXW,iBAAiB,iCAAjB,iBAAiB,QAW5B;AAED;;;;GAIG;AACH,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB;;OAEG;IACH,qDAAW,CAAA;IACX;;OAEG;IACH,2DAAc,CAAA;IACd;;OAEG;IACH,qDAAW,CAAA;AACb,CAAC,EAbW,YAAY,4BAAZ,YAAY,QAavB;AAmXD;;;;GAIG;AACH,IAAY,YA8BX;AA9BD,WAAY,YAAY;IACtB;;;;OAIG;IACH,8CAA8B,CAAA;IAC9B;;;OAGG;IACH,wDAAwC,CAAA;IACxC;;;;OAIG;IACH,wDAAwC,CAAA;IACxC;;;;OAIG;IACH,kDAAkC,CAAA;IAClC;;;;OAIG;IACH,wDAAwC,CAAA;AAC1C,CAAC,EA9BW,YAAY,4BAAZ,YAAY,QA8BvB"}

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "shipbob-node-sdk",
-  "version": "0.0.13",
-  "description": "ShipBob API node SDK",
-  "types": "dist/index.d.ts",
-  "main": "dist/index.js",
-  "type": "commonjs",
-  "scripts": {
-    "prebuild": "rimraf dist && eslint . --ignore-pattern generated/ && prettier \"**/*.ts\" --check",
-    "build": "tsc",
-    "lint": "eslint . --ignore-pattern generated/",
-    "prettier:write": "prettier \"**/*.ts\" \"*.md\" --write",
-    "generate:client": "openapi-generator-cli generate -i openapi.json -g typescript -o generated/openapi --additional-properties=npmName=restClient,supportsES6=true,withInterfaces=true",
-    "test": "mocha"
-  },
-  "author": "Brian Zinn",
-  "license": "ISC",
-  "devDependencies": {
-    "@eslint/js": "^9.20.0",
-    "@openapitools/openapi-generator-cli": "^2.16.3",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "20",
-    "dotenv": "^16.4.7",
-    "eslint": "^9.20.1",
-    "mocha": "^11.1.0",
-    "prettier": "^3.5.1",
-    "puppeteer": "^24.5.0",
-    "rimraf": "^6.0.1",
-    "tsx": "^4.19.3",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.24.1"
-  },
-  "peerDependencies": {
-    "puppeteer": ">=22"
-  },
-  "peerDependenciesMeta": {
-    "puppeteer": {
-      "optional": true
-    }
-  }
-}
+{
+  "name": "shipbob-node-sdk",
+  "version": "0.0.16",
+  "description": "ShipBob API node SDK",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "type": "commonjs",
+  "scripts": {
+    "prebuild": "rimraf dist && eslint . --ignore-pattern generated/ && prettier \"**/*.ts\" --check",
+    "build": "tsc",
+    "lint": "eslint . --ignore-pattern generated/",
+    "prettier:write": "prettier \"**/*.ts\" \"*.md\" --write",
+    "generate:client": "openapi-generator-cli generate -i openapi.json -g typescript -o generated/openapi --additional-properties=npmName=restClient,supportsES6=true,withInterfaces=true",
+    "test": "mocha"
+  },
+  "author": "Brian Zinn",
+  "license": "ISC",
+  "devDependencies": {
+    "@eslint/js": "^9.20.0",
+    "@openapitools/openapi-generator-cli": "^2.16.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "20",
+    "dotenv": "^16.4.7",
+    "eslint": "^9.20.1",
+    "mocha": "^11.1.0",
+    "prettier": "^3.5.1",
+    "puppeteer": "^24.5.0",
+    "rimraf": "^6.0.1",
+    "tsx": "^4.19.3",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.1"
+  },
+  "peerDependencies": {
+    "puppeteer": ">=22"
+  },
+  "peerDependenciesMeta": {
+    "puppeteer": {
+      "optional": true
+    }
+  }
+}