shipbob-node-sdk 0.0.13 → 0.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/types.d.ts +46 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,6 +11,9 @@ This SDK exposes some endpoints not available in the OpenAPI including:
|
|
|
11
11
|
- `/experimental/product` :skull:
|
|
12
12
|
- `/experimental/receiving` :skull:
|
|
13
13
|
|
|
14
|
+
As of Nov 2025 the OpenAPI specs (including 2025-07) are available for additional versions:
|
|
15
|
+
[Open API specs](https://developer.shipbob.com/faq#how-can-i-find-openapi-specs-for-each-api-version)
|
|
16
|
+
|
|
14
17
|
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:
|
|
15
18
|
|
|
16
19
|
```bash
|
package/dist/types.d.ts
CHANGED
|
@@ -1070,6 +1070,9 @@ export declare enum ReturnAction {
|
|
|
1070
1070
|
Dispose = 3
|
|
1071
1071
|
}
|
|
1072
1072
|
export type VariantRequestProductExperimental = Omit<VariantRequestProduct2_0, 'barcode'> & {
|
|
1073
|
+
/**
|
|
1074
|
+
* Multiple barcodes support added in 2.0
|
|
1075
|
+
*/
|
|
1073
1076
|
barcodes: {
|
|
1074
1077
|
value: string;
|
|
1075
1078
|
sticker_url: Nullable<string>;
|
|
@@ -1127,13 +1130,55 @@ export type VariantRequestProduct2_0 = {
|
|
|
1127
1130
|
return_to_sender_primary_action_id: Nullable<ReturnAction>;
|
|
1128
1131
|
return_to_sender_backup_action_id: Nullable<ReturnAction>;
|
|
1129
1132
|
};
|
|
1130
|
-
lot_information
|
|
1133
|
+
lot_information?: {
|
|
1131
1134
|
/**
|
|
1132
1135
|
* If the product should use lot date based picking
|
|
1133
1136
|
*/
|
|
1134
1137
|
is_lot: boolean;
|
|
1135
1138
|
minimum_shelf_life_days: Nullable<number>;
|
|
1136
1139
|
};
|
|
1140
|
+
/**
|
|
1141
|
+
* This is not part of Open API spec, but found starting with Product 2.0
|
|
1142
|
+
*/
|
|
1143
|
+
fulfillment_settings?: {
|
|
1144
|
+
is_bpm_parcel?: boolean;
|
|
1145
|
+
is_case_pick?: boolean;
|
|
1146
|
+
msds_url?: Nullable<string>;
|
|
1147
|
+
dangerous_goods?: boolean;
|
|
1148
|
+
/**
|
|
1149
|
+
* If the product requires a prop65 label in the box
|
|
1150
|
+
*/
|
|
1151
|
+
requires_prop65?: boolean;
|
|
1152
|
+
serial_scan?: {
|
|
1153
|
+
/**
|
|
1154
|
+
* Indicates if a Serial Scan is required during the pack process.
|
|
1155
|
+
* Note: Serial scan requires either a prefix or a suffix to be defined
|
|
1156
|
+
*/
|
|
1157
|
+
is_enabled: boolean;
|
|
1158
|
+
/**
|
|
1159
|
+
* The exact number of characters expected in the serial number
|
|
1160
|
+
*/
|
|
1161
|
+
exact_character_length?: Nullable<number>;
|
|
1162
|
+
} & ({
|
|
1163
|
+
/**
|
|
1164
|
+
* The prefix expected on the serial number
|
|
1165
|
+
*/
|
|
1166
|
+
prefix: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* The suffix expected on the serial number
|
|
1169
|
+
*/
|
|
1170
|
+
suffix?: Nullable<string>;
|
|
1171
|
+
} | {
|
|
1172
|
+
/**
|
|
1173
|
+
* The prefix expected on the serial number
|
|
1174
|
+
*/
|
|
1175
|
+
prefix?: Nullable<string>;
|
|
1176
|
+
/**
|
|
1177
|
+
* The suffix expected on the serial number
|
|
1178
|
+
*/
|
|
1179
|
+
suffix: string;
|
|
1180
|
+
});
|
|
1181
|
+
};
|
|
1137
1182
|
};
|
|
1138
1183
|
export type GetProductQueryStrings = Partial<{
|
|
1139
1184
|
Page: number;
|
package/dist/types.js.map
CHANGED
|
@@ -1 +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;
|
|
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;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"}
|