shipbob-node-sdk 0.0.16 → 0.0.18
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 +78 -175
- package/dist/WebScraper.js +7 -5
- package/dist/WebScraper.js.map +1 -1
- package/dist/client/2025-07/client/client.gen.d.ts +2 -0
- package/dist/client/2025-07/client/client.gen.js +240 -0
- package/dist/client/2025-07/client/client.gen.js.map +1 -0
- package/dist/client/2025-07/client/index.d.ts +8 -0
- package/dist/client/2025-07/client/index.js +18 -0
- package/dist/client/2025-07/client/index.js.map +1 -0
- package/dist/client/2025-07/client/types.gen.d.ts +117 -0
- package/dist/client/2025-07/client/types.gen.js +4 -0
- package/dist/client/2025-07/client/types.gen.js.map +1 -0
- package/dist/client/2025-07/client/utils.gen.d.ts +33 -0
- package/dist/client/2025-07/client/utils.gen.js +242 -0
- package/dist/client/2025-07/client/utils.gen.js.map +1 -0
- package/dist/client/2025-07/client.gen.d.ts +12 -0
- package/dist/client/2025-07/client.gen.js +7 -0
- package/dist/client/2025-07/client.gen.js.map +1 -0
- package/dist/client/2025-07/core/auth.gen.d.ts +18 -0
- package/dist/client/2025-07/core/auth.gen.js +19 -0
- package/dist/client/2025-07/core/auth.gen.js.map +1 -0
- package/dist/client/2025-07/core/bodySerializer.gen.d.ts +25 -0
- package/dist/client/2025-07/core/bodySerializer.gen.js +61 -0
- package/dist/client/2025-07/core/bodySerializer.gen.js.map +1 -0
- package/dist/client/2025-07/core/params.gen.d.ts +43 -0
- package/dist/client/2025-07/core/params.gen.js +105 -0
- package/dist/client/2025-07/core/params.gen.js.map +1 -0
- package/dist/client/2025-07/core/pathSerializer.gen.d.ts +33 -0
- package/dist/client/2025-07/core/pathSerializer.gen.js +116 -0
- package/dist/client/2025-07/core/pathSerializer.gen.js.map +1 -0
- package/dist/client/2025-07/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/client/2025-07/core/queryKeySerializer.gen.js +99 -0
- package/dist/client/2025-07/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/client/2025-07/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/client/2025-07/core/serverSentEvents.gen.js +138 -0
- package/dist/client/2025-07/core/serverSentEvents.gen.js.map +1 -0
- package/dist/client/2025-07/core/types.gen.d.ts +78 -0
- package/dist/client/2025-07/core/types.gen.js +4 -0
- package/dist/client/2025-07/core/types.gen.js.map +1 -0
- package/dist/client/2025-07/core/utils.gen.d.ts +19 -0
- package/dist/client/2025-07/core/utils.gen.js +94 -0
- package/dist/client/2025-07/core/utils.gen.js.map +1 -0
- package/dist/client/2025-07/index.d.ts +2 -0
- package/dist/client/2025-07/index.js +73 -0
- package/dist/client/2025-07/index.js.map +1 -0
- package/dist/client/2025-07/sdk.gen.d.ts +380 -0
- package/dist/client/2025-07/sdk.gen.js +778 -0
- package/dist/client/2025-07/sdk.gen.js.map +1 -0
- package/dist/client/2025-07/types.gen.d.ts +7191 -0
- package/dist/client/2025-07/types.gen.js +4 -0
- package/dist/client/2025-07/types.gen.js.map +1 -0
- package/dist/client/2026-01/client/client.gen.d.ts +2 -0
- package/dist/client/2026-01/client/client.gen.js +240 -0
- package/dist/client/2026-01/client/client.gen.js.map +1 -0
- package/dist/client/2026-01/client/index.d.ts +8 -0
- package/dist/client/2026-01/client/index.js +18 -0
- package/dist/client/2026-01/client/index.js.map +1 -0
- package/dist/client/2026-01/client/types.gen.d.ts +117 -0
- package/dist/client/2026-01/client/types.gen.js +4 -0
- package/dist/client/2026-01/client/types.gen.js.map +1 -0
- package/dist/client/2026-01/client/utils.gen.d.ts +33 -0
- package/dist/client/2026-01/client/utils.gen.js +242 -0
- package/dist/client/2026-01/client/utils.gen.js.map +1 -0
- package/dist/client/2026-01/client.gen.d.ts +12 -0
- package/dist/client/2026-01/client.gen.js +7 -0
- package/dist/client/2026-01/client.gen.js.map +1 -0
- package/dist/client/2026-01/core/auth.gen.d.ts +18 -0
- package/dist/client/2026-01/core/auth.gen.js +19 -0
- package/dist/client/2026-01/core/auth.gen.js.map +1 -0
- package/dist/client/2026-01/core/bodySerializer.gen.d.ts +25 -0
- package/dist/client/2026-01/core/bodySerializer.gen.js +61 -0
- package/dist/client/2026-01/core/bodySerializer.gen.js.map +1 -0
- package/dist/client/2026-01/core/params.gen.d.ts +43 -0
- package/dist/client/2026-01/core/params.gen.js +105 -0
- package/dist/client/2026-01/core/params.gen.js.map +1 -0
- package/dist/client/2026-01/core/pathSerializer.gen.d.ts +33 -0
- package/dist/client/2026-01/core/pathSerializer.gen.js +116 -0
- package/dist/client/2026-01/core/pathSerializer.gen.js.map +1 -0
- package/dist/client/2026-01/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/client/2026-01/core/queryKeySerializer.gen.js +99 -0
- package/dist/client/2026-01/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/client/2026-01/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/client/2026-01/core/serverSentEvents.gen.js +138 -0
- package/dist/client/2026-01/core/serverSentEvents.gen.js.map +1 -0
- package/dist/client/2026-01/core/types.gen.d.ts +78 -0
- package/dist/client/2026-01/core/types.gen.js +4 -0
- package/dist/client/2026-01/core/types.gen.js.map +1 -0
- package/dist/client/2026-01/core/utils.gen.d.ts +19 -0
- package/dist/client/2026-01/core/utils.gen.js +94 -0
- package/dist/client/2026-01/core/utils.gen.js.map +1 -0
- package/dist/client/2026-01/index.d.ts +2 -0
- package/dist/client/2026-01/index.js +73 -0
- package/dist/client/2026-01/index.js.map +1 -0
- package/dist/client/2026-01/sdk.gen.d.ts +450 -0
- package/dist/client/2026-01/sdk.gen.js +848 -0
- package/dist/client/2026-01/sdk.gen.js.map +1 -0
- package/dist/client/2026-01/types.gen.d.ts +7282 -0
- package/dist/client/2026-01/types.gen.js +4 -0
- package/dist/client/2026-01/types.gen.js.map +1 -0
- package/dist/index.d.ts +20 -178
- package/dist/index.js +116 -386
- package/dist/index.js.map +1 -1
- package/dist/types.d.ts +61 -1435
- package/dist/types.js +1 -38
- package/dist/types.js.map +1 -1
- package/openapi-1.0.json +8422 -0
- package/openapi-2025-07.json +1 -0
- package/openapi-2026-01.json +1 -0
- package/package.json +6 -9
|
@@ -0,0 +1,848 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.post202601ShipmentBatchUpdateTrackingUpload = exports.get202601OrderByOrderIdStoreOrderJson = exports.post202601OrderEstimate = exports.post202601OrderByOrderIdCancel = exports.post202601Order = exports.get202601Order = exports.post202601ShipmentBatchCancel = exports.get202601OrderByOrderIdShipment = exports.post202601ShipmentByShipmentIdCancel = exports.get202601OrderByOrderIdShipmentByShipmentIdTimeline = exports.get202601ShipmentByShipmentId = exports.get202601ShippingMethod = exports.get202601Location = exports.post202601Return = exports.get202601Return = exports.post202601ReturnByIdCancel = exports.post202601TransactionsQuery = exports.get202601InvoicesByInvoiceIdTransactions = exports.get202601TransactionFees = exports.get202601Invoices = exports.delete202601WebhookById = exports.post202601Webhook = exports.get202601Webhook = exports.get202601Channel = exports.post202601VariantByVariantIdMerge = exports.post202601ProductMoveVariants = exports.post202601Product = exports.get202601Product = exports.get202601PackagingRequirement = exports.post202601ProductByProductIdVariants = exports.patch202601ProductByProductIdVariants = exports.get202601ProductByProductIdVariants = exports.patch202601ProductByProductId = exports.get202601ProductByProductId = exports.delete202601ProductByProductId = exports.post202601VariantByVariantIdConvertToBundle = exports.get202601Taxonomy = exports.get202601TaxonomyById = exports.post202601ProductByProductIdMoveVariants = exports.get202601TaxonomyByIdParent = exports.put202601ReturnById = exports.get202601ReturnById = exports.get202601Inventory = exports.get202601InventoryLevelByInventoryIdLocations = exports.get202601InventoryLevelLots = exports.get202601InventoryLevelByInventoryIdLots = exports.get202601InventoryByInventoryId = exports.get202601InventoryLevelLocations = exports.get202601InventoryLevelByInventoryId = exports.get202601InventoryLevel = void 0;
|
|
5
|
+
exports.get202601ReceivingByIdDistributions = exports.post202601InventoryHistoryQuery = exports.get202601ReceivingById = exports.get202601ReceivingByIdLabels = exports.get202601ReceivingByIdBoxes = exports.post202601Receiving = exports.get202601Receiving = exports.post202601ReceivingByIdCancel = exports.get202601FulfillmentCenter = exports.post202601ReceivingSetExternalSync = exports.get202601OrderByOrderIdShipmentByShipmentIdLogs = exports.get202601ShipmentByShipmentIdTimeline = exports.post202601OrderByOrderIdShipmentByShipmentIdCancel = exports.get202601OrderByOrderId = exports.get202601OrderByOrderIdShipmentByShipmentId = exports.get202601ShipmentByShipmentIdLogs = void 0;
|
|
6
|
+
const client_gen_1 = require("./client.gen");
|
|
7
|
+
/**
|
|
8
|
+
* Get All Inventory Levels
|
|
9
|
+
*
|
|
10
|
+
* Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes.
|
|
11
|
+
*/
|
|
12
|
+
const get202601InventoryLevel = (options) => (options?.client ?? client_gen_1.client).get({
|
|
13
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
14
|
+
url: '/2026-01/inventory-level',
|
|
15
|
+
...options
|
|
16
|
+
});
|
|
17
|
+
exports.get202601InventoryLevel = get202601InventoryLevel;
|
|
18
|
+
/**
|
|
19
|
+
* Get Inventory Levels
|
|
20
|
+
*
|
|
21
|
+
* Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.
|
|
22
|
+
*/
|
|
23
|
+
const get202601InventoryLevelByInventoryId = (options) => (options.client ?? client_gen_1.client).get({
|
|
24
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
25
|
+
url: '/2026-01/inventory-level/{inventoryId}',
|
|
26
|
+
...options
|
|
27
|
+
});
|
|
28
|
+
exports.get202601InventoryLevelByInventoryId = get202601InventoryLevelByInventoryId;
|
|
29
|
+
/**
|
|
30
|
+
* Get All Inventory Levels Grouped By Fulfillment Center
|
|
31
|
+
*
|
|
32
|
+
* Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes.
|
|
33
|
+
*/
|
|
34
|
+
const get202601InventoryLevelLocations = (options) => (options?.client ?? client_gen_1.client).get({
|
|
35
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
36
|
+
url: '/2026-01/inventory-level/locations',
|
|
37
|
+
...options
|
|
38
|
+
});
|
|
39
|
+
exports.get202601InventoryLevelLocations = get202601InventoryLevelLocations;
|
|
40
|
+
/**
|
|
41
|
+
* Get Inventory
|
|
42
|
+
*
|
|
43
|
+
* Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata.
|
|
44
|
+
*/
|
|
45
|
+
const get202601InventoryByInventoryId = (options) => (options.client ?? client_gen_1.client).get({
|
|
46
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
47
|
+
url: '/2026-01/inventory/{inventoryId}',
|
|
48
|
+
...options
|
|
49
|
+
});
|
|
50
|
+
exports.get202601InventoryByInventoryId = get202601InventoryByInventoryId;
|
|
51
|
+
/**
|
|
52
|
+
* Get Inventory Levels Grouped By Lot
|
|
53
|
+
*
|
|
54
|
+
* Retrieves inventory levels for a specific inventory item broken down by lot number. Useful for tracking inventory by manufacturing lot, expiration date, or batch information.
|
|
55
|
+
*/
|
|
56
|
+
const get202601InventoryLevelByInventoryIdLots = (options) => (options.client ?? client_gen_1.client).get({
|
|
57
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
58
|
+
url: '/2026-01/inventory-level/{inventoryId}/lots',
|
|
59
|
+
...options
|
|
60
|
+
});
|
|
61
|
+
exports.get202601InventoryLevelByInventoryIdLots = get202601InventoryLevelByInventoryIdLots;
|
|
62
|
+
/**
|
|
63
|
+
* Get All Inventory Levels Grouped By Lot
|
|
64
|
+
*
|
|
65
|
+
* Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.
|
|
66
|
+
*/
|
|
67
|
+
const get202601InventoryLevelLots = (options) => (options?.client ?? client_gen_1.client).get({
|
|
68
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
69
|
+
url: '/2026-01/inventory-level/lots',
|
|
70
|
+
...options
|
|
71
|
+
});
|
|
72
|
+
exports.get202601InventoryLevelLots = get202601InventoryLevelLots;
|
|
73
|
+
/**
|
|
74
|
+
* Get Inventory Levels Grouped By Fulfillment Center
|
|
75
|
+
*
|
|
76
|
+
* Retrieves inventory levels for a specific inventory item broken down by fulfillment center location. Shows quantity breakdowns for each location where the inventory is stored.
|
|
77
|
+
*/
|
|
78
|
+
const get202601InventoryLevelByInventoryIdLocations = (options) => (options.client ?? client_gen_1.client).get({
|
|
79
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
80
|
+
url: '/2026-01/inventory-level/{inventoryId}/locations',
|
|
81
|
+
...options
|
|
82
|
+
});
|
|
83
|
+
exports.get202601InventoryLevelByInventoryIdLocations = get202601InventoryLevelByInventoryIdLocations;
|
|
84
|
+
/**
|
|
85
|
+
* Get All Inventories
|
|
86
|
+
*
|
|
87
|
+
* Retrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results.
|
|
88
|
+
*/
|
|
89
|
+
const get202601Inventory = (options) => (options?.client ?? client_gen_1.client).get({
|
|
90
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
91
|
+
url: '/2026-01/inventory',
|
|
92
|
+
...options
|
|
93
|
+
});
|
|
94
|
+
exports.get202601Inventory = get202601Inventory;
|
|
95
|
+
/**
|
|
96
|
+
* Get Return Order
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* Retrieves the complete details of a specific return order by its unique ID. Use this to view return status, inventory items, transactions, and processing history.
|
|
100
|
+
*
|
|
101
|
+
*/
|
|
102
|
+
const get202601ReturnById = (options) => (options.client ?? client_gen_1.client).get({
|
|
103
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
104
|
+
url: '/2026-01/return/{id}',
|
|
105
|
+
...options
|
|
106
|
+
});
|
|
107
|
+
exports.get202601ReturnById = get202601ReturnById;
|
|
108
|
+
/**
|
|
109
|
+
* Edit Return Order
|
|
110
|
+
*
|
|
111
|
+
*
|
|
112
|
+
* Updates an existing return using the provided request body and returns the updated return payload.
|
|
113
|
+
*
|
|
114
|
+
*/
|
|
115
|
+
const put202601ReturnById = (options) => (options.client ?? client_gen_1.client).put({
|
|
116
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
117
|
+
url: '/2026-01/return/{id}',
|
|
118
|
+
...options,
|
|
119
|
+
headers: {
|
|
120
|
+
'Content-Type': 'application/json',
|
|
121
|
+
...options.headers
|
|
122
|
+
}
|
|
123
|
+
});
|
|
124
|
+
exports.put202601ReturnById = put202601ReturnById;
|
|
125
|
+
/**
|
|
126
|
+
* Get Taxonomy Parent
|
|
127
|
+
*
|
|
128
|
+
* Retrieves the parent taxonomy node for a given taxonomy ID.
|
|
129
|
+
*/
|
|
130
|
+
const get202601TaxonomyByIdParent = (options) => (options.client ?? client_gen_1.client).get({
|
|
131
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
132
|
+
url: '/2026-01/taxonomy/{id}/parent',
|
|
133
|
+
...options
|
|
134
|
+
});
|
|
135
|
+
exports.get202601TaxonomyByIdParent = get202601TaxonomyByIdParent;
|
|
136
|
+
/**
|
|
137
|
+
* Move Variants Between Products
|
|
138
|
+
*
|
|
139
|
+
* Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.
|
|
140
|
+
*/
|
|
141
|
+
const post202601ProductByProductIdMoveVariants = (options) => (options.client ?? client_gen_1.client).post({
|
|
142
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
143
|
+
url: '/2026-01/product/{productId}:moveVariants',
|
|
144
|
+
...options,
|
|
145
|
+
headers: {
|
|
146
|
+
'Content-Type': 'application/json',
|
|
147
|
+
...options.headers
|
|
148
|
+
}
|
|
149
|
+
});
|
|
150
|
+
exports.post202601ProductByProductIdMoveVariants = post202601ProductByProductIdMoveVariants;
|
|
151
|
+
/**
|
|
152
|
+
* Get Taxonomy by ID
|
|
153
|
+
*
|
|
154
|
+
* Retrieves a specific taxonomy node and its details by taxonomy ID.
|
|
155
|
+
*/
|
|
156
|
+
const get202601TaxonomyById = (options) => (options.client ?? client_gen_1.client).get({
|
|
157
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
158
|
+
url: '/2026-01/taxonomy/{id}',
|
|
159
|
+
...options
|
|
160
|
+
});
|
|
161
|
+
exports.get202601TaxonomyById = get202601TaxonomyById;
|
|
162
|
+
/**
|
|
163
|
+
* Get Taxonomies
|
|
164
|
+
*
|
|
165
|
+
* Retrieves all available product taxonomies for categorizing products.
|
|
166
|
+
*/
|
|
167
|
+
const get202601Taxonomy = (options) => (options?.client ?? client_gen_1.client).get({
|
|
168
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
169
|
+
url: '/2026-01/taxonomy',
|
|
170
|
+
...options
|
|
171
|
+
});
|
|
172
|
+
exports.get202601Taxonomy = get202601Taxonomy;
|
|
173
|
+
/**
|
|
174
|
+
* Convert Variant to Bundle
|
|
175
|
+
*
|
|
176
|
+
* Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.
|
|
177
|
+
*/
|
|
178
|
+
const post202601VariantByVariantIdConvertToBundle = (options) => (options.client ?? client_gen_1.client).post({
|
|
179
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
180
|
+
url: '/2026-01/variant/{variantId}:convertToBundle',
|
|
181
|
+
...options,
|
|
182
|
+
headers: {
|
|
183
|
+
'Content-Type': 'application/json',
|
|
184
|
+
...options.headers
|
|
185
|
+
}
|
|
186
|
+
});
|
|
187
|
+
exports.post202601VariantByVariantIdConvertToBundle = post202601VariantByVariantIdConvertToBundle;
|
|
188
|
+
/**
|
|
189
|
+
* Delete Product Bundle
|
|
190
|
+
*
|
|
191
|
+
* Deletes a bundle product by ID. Delete operation not allowed for non-bundles.
|
|
192
|
+
*/
|
|
193
|
+
const delete202601ProductByProductId = (options) => (options.client ?? client_gen_1.client).delete({
|
|
194
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
195
|
+
url: '/2026-01/product/{productId}',
|
|
196
|
+
...options
|
|
197
|
+
});
|
|
198
|
+
exports.delete202601ProductByProductId = delete202601ProductByProductId;
|
|
199
|
+
/**
|
|
200
|
+
* Get Product
|
|
201
|
+
*
|
|
202
|
+
* Retrieves a product with all its variants and details.
|
|
203
|
+
*/
|
|
204
|
+
const get202601ProductByProductId = (options) => (options.client ?? client_gen_1.client).get({
|
|
205
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
206
|
+
url: '/2026-01/product/{productId}',
|
|
207
|
+
...options
|
|
208
|
+
});
|
|
209
|
+
exports.get202601ProductByProductId = get202601ProductByProductId;
|
|
210
|
+
/**
|
|
211
|
+
* Update Product
|
|
212
|
+
*
|
|
213
|
+
* Updates a product. Supports partial updates - only the fields provided will be updated. When updating variants through this endpoint, you must include the variant ID.
|
|
214
|
+
*/
|
|
215
|
+
const patch202601ProductByProductId = (options) => (options.client ?? client_gen_1.client).patch({
|
|
216
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
217
|
+
url: '/2026-01/product/{productId}',
|
|
218
|
+
...options,
|
|
219
|
+
headers: {
|
|
220
|
+
'Content-Type': 'application/json',
|
|
221
|
+
...options.headers
|
|
222
|
+
}
|
|
223
|
+
});
|
|
224
|
+
exports.patch202601ProductByProductId = patch202601ProductByProductId;
|
|
225
|
+
/**
|
|
226
|
+
* Get Product Variants
|
|
227
|
+
*
|
|
228
|
+
* Retrieves all variants for a specific product.
|
|
229
|
+
*/
|
|
230
|
+
const get202601ProductByProductIdVariants = (options) => (options.client ?? client_gen_1.client).get({
|
|
231
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
232
|
+
url: '/2026-01/product/{productId}/variants',
|
|
233
|
+
...options
|
|
234
|
+
});
|
|
235
|
+
exports.get202601ProductByProductIdVariants = get202601ProductByProductIdVariants;
|
|
236
|
+
/**
|
|
237
|
+
* Update Product Variants
|
|
238
|
+
*
|
|
239
|
+
* Updates one or more product variants. The request body must be an array of variant objects. Each variant must include the variant ID, and only the fields provided will be updated.
|
|
240
|
+
*/
|
|
241
|
+
const patch202601ProductByProductIdVariants = (options) => (options.client ?? client_gen_1.client).patch({
|
|
242
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
243
|
+
url: '/2026-01/product/{productId}/variants',
|
|
244
|
+
...options,
|
|
245
|
+
headers: {
|
|
246
|
+
'Content-Type': 'application/json',
|
|
247
|
+
...options.headers
|
|
248
|
+
}
|
|
249
|
+
});
|
|
250
|
+
exports.patch202601ProductByProductIdVariants = patch202601ProductByProductIdVariants;
|
|
251
|
+
/**
|
|
252
|
+
* Add Product Variants
|
|
253
|
+
*
|
|
254
|
+
* Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.
|
|
255
|
+
*/
|
|
256
|
+
const post202601ProductByProductIdVariants = (options) => (options.client ?? client_gen_1.client).post({
|
|
257
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
258
|
+
url: '/2026-01/product/{productId}/variants',
|
|
259
|
+
...options,
|
|
260
|
+
headers: {
|
|
261
|
+
'Content-Type': 'application/json',
|
|
262
|
+
...options.headers
|
|
263
|
+
}
|
|
264
|
+
});
|
|
265
|
+
exports.post202601ProductByProductIdVariants = post202601ProductByProductIdVariants;
|
|
266
|
+
/**
|
|
267
|
+
* Get Packaging Requirement
|
|
268
|
+
*
|
|
269
|
+
* Retrieves all available packaging requirements that can be assigned to a product.
|
|
270
|
+
*/
|
|
271
|
+
const get202601PackagingRequirement = (options) => (options?.client ?? client_gen_1.client).get({
|
|
272
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
273
|
+
url: '/2026-01/packaging-requirement',
|
|
274
|
+
...options
|
|
275
|
+
});
|
|
276
|
+
exports.get202601PackagingRequirement = get202601PackagingRequirement;
|
|
277
|
+
/**
|
|
278
|
+
* Get Products
|
|
279
|
+
*
|
|
280
|
+
* Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.
|
|
281
|
+
*/
|
|
282
|
+
const get202601Product = (options) => (options?.client ?? client_gen_1.client).get({
|
|
283
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
284
|
+
url: '/2026-01/product',
|
|
285
|
+
...options
|
|
286
|
+
});
|
|
287
|
+
exports.get202601Product = get202601Product;
|
|
288
|
+
/**
|
|
289
|
+
* Create Product
|
|
290
|
+
*
|
|
291
|
+
* Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.
|
|
292
|
+
*/
|
|
293
|
+
const post202601Product = (options) => (options?.client ?? client_gen_1.client).post({
|
|
294
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
295
|
+
url: '/2026-01/product',
|
|
296
|
+
...options,
|
|
297
|
+
headers: {
|
|
298
|
+
'Content-Type': 'application/json',
|
|
299
|
+
...options?.headers
|
|
300
|
+
}
|
|
301
|
+
});
|
|
302
|
+
exports.post202601Product = post202601Product;
|
|
303
|
+
/**
|
|
304
|
+
* Move Variants to New Product
|
|
305
|
+
*
|
|
306
|
+
* Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.
|
|
307
|
+
*/
|
|
308
|
+
const post202601ProductMoveVariants = (options) => (options?.client ?? client_gen_1.client).post({
|
|
309
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
310
|
+
url: '/2026-01/product:moveVariants',
|
|
311
|
+
...options,
|
|
312
|
+
headers: {
|
|
313
|
+
'Content-Type': 'application/json',
|
|
314
|
+
...options?.headers
|
|
315
|
+
}
|
|
316
|
+
});
|
|
317
|
+
exports.post202601ProductMoveVariants = post202601ProductMoveVariants;
|
|
318
|
+
/**
|
|
319
|
+
* Merge Variants
|
|
320
|
+
*
|
|
321
|
+
* Merges multiple product variants into a target variant. Provide an array of variant IDs to merge into the target variant specified in the path. Inventory from the merged variants will be consolidated into the target variant.
|
|
322
|
+
*/
|
|
323
|
+
const post202601VariantByVariantIdMerge = (options) => (options.client ?? client_gen_1.client).post({
|
|
324
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
325
|
+
url: '/2026-01/variant/{variantId}:merge',
|
|
326
|
+
...options,
|
|
327
|
+
headers: {
|
|
328
|
+
'Content-Type': 'application/json',
|
|
329
|
+
...options.headers
|
|
330
|
+
}
|
|
331
|
+
});
|
|
332
|
+
exports.post202601VariantByVariantIdMerge = post202601VariantByVariantIdMerge;
|
|
333
|
+
/**
|
|
334
|
+
* Get Channels
|
|
335
|
+
*
|
|
336
|
+
* Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.
|
|
337
|
+
*
|
|
338
|
+
*/
|
|
339
|
+
const get202601Channel = (options) => (options?.client ?? client_gen_1.client).get({
|
|
340
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
341
|
+
url: '/2026-01/channel',
|
|
342
|
+
...options
|
|
343
|
+
});
|
|
344
|
+
exports.get202601Channel = get202601Channel;
|
|
345
|
+
/**
|
|
346
|
+
* Get Subscriptions
|
|
347
|
+
*
|
|
348
|
+
*
|
|
349
|
+
* This endpoint returns a list of webhook subscriptions.
|
|
350
|
+
*
|
|
351
|
+
*/
|
|
352
|
+
const get202601Webhook = (options) => (options?.client ?? client_gen_1.client).get({
|
|
353
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
354
|
+
url: '/2026-01/webhook',
|
|
355
|
+
...options
|
|
356
|
+
});
|
|
357
|
+
exports.get202601Webhook = get202601Webhook;
|
|
358
|
+
/**
|
|
359
|
+
* Create Subscription
|
|
360
|
+
*
|
|
361
|
+
*
|
|
362
|
+
* This endpoint creates a new webhook subscription.
|
|
363
|
+
*
|
|
364
|
+
*/
|
|
365
|
+
const post202601Webhook = (options) => (options?.client ?? client_gen_1.client).post({
|
|
366
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
367
|
+
url: '/2026-01/webhook',
|
|
368
|
+
...options,
|
|
369
|
+
headers: {
|
|
370
|
+
'Content-Type': 'application/json',
|
|
371
|
+
...options?.headers
|
|
372
|
+
}
|
|
373
|
+
});
|
|
374
|
+
exports.post202601Webhook = post202601Webhook;
|
|
375
|
+
/**
|
|
376
|
+
* Delete Subscription
|
|
377
|
+
*
|
|
378
|
+
*
|
|
379
|
+
* This endpoint deletes a webhook subscription.
|
|
380
|
+
*
|
|
381
|
+
*/
|
|
382
|
+
const delete202601WebhookById = (options) => (options.client ?? client_gen_1.client).delete({
|
|
383
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
384
|
+
url: '/2026-01/webhook/{id}',
|
|
385
|
+
...options
|
|
386
|
+
});
|
|
387
|
+
exports.delete202601WebhookById = delete202601WebhookById;
|
|
388
|
+
/**
|
|
389
|
+
* Get Invoices
|
|
390
|
+
*
|
|
391
|
+
* Gets a paginated list of invoices, optionally filtered by invoice types and date range
|
|
392
|
+
*/
|
|
393
|
+
const get202601Invoices = (options) => (options?.client ?? client_gen_1.client).get({
|
|
394
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
395
|
+
url: '/2026-01/invoices',
|
|
396
|
+
...options
|
|
397
|
+
});
|
|
398
|
+
exports.get202601Invoices = get202601Invoices;
|
|
399
|
+
/**
|
|
400
|
+
* Get Transaction Fees
|
|
401
|
+
*
|
|
402
|
+
*
|
|
403
|
+
* This endpoint returns a list of transaction fees
|
|
404
|
+
*
|
|
405
|
+
*/
|
|
406
|
+
const get202601TransactionFees = (options) => (options?.client ?? client_gen_1.client).get({
|
|
407
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
408
|
+
url: '/2026-01/transaction-fees',
|
|
409
|
+
...options
|
|
410
|
+
});
|
|
411
|
+
exports.get202601TransactionFees = get202601TransactionFees;
|
|
412
|
+
/**
|
|
413
|
+
* Get Transactions by Invoice ID
|
|
414
|
+
*
|
|
415
|
+
*
|
|
416
|
+
* The unique identifier of the invoice whose transactions are to be retrieved
|
|
417
|
+
*/
|
|
418
|
+
const get202601InvoicesByInvoiceIdTransactions = (options) => (options.client ?? client_gen_1.client).get({
|
|
419
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
420
|
+
url: '/2026-01/invoices/{invoiceId}/transactions',
|
|
421
|
+
...options
|
|
422
|
+
});
|
|
423
|
+
exports.get202601InvoicesByInvoiceIdTransactions = get202601InvoicesByInvoiceIdTransactions;
|
|
424
|
+
/**
|
|
425
|
+
* Search Transactions
|
|
426
|
+
*
|
|
427
|
+
* Search transactions with filters (date, invoice, fee type, etc.)
|
|
428
|
+
*/
|
|
429
|
+
const post202601TransactionsQuery = (options) => (options?.client ?? client_gen_1.client).post({
|
|
430
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
431
|
+
url: '/2026-01/transactions:query',
|
|
432
|
+
...options,
|
|
433
|
+
headers: {
|
|
434
|
+
'Content-Type': 'application/json',
|
|
435
|
+
...options?.headers
|
|
436
|
+
}
|
|
437
|
+
});
|
|
438
|
+
exports.post202601TransactionsQuery = post202601TransactionsQuery;
|
|
439
|
+
/**
|
|
440
|
+
* Cancel Return order
|
|
441
|
+
*
|
|
442
|
+
*
|
|
443
|
+
* Cancels a return order for given return ID.
|
|
444
|
+
*
|
|
445
|
+
*/
|
|
446
|
+
const post202601ReturnByIdCancel = (options) => (options.client ?? client_gen_1.client).post({
|
|
447
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
448
|
+
url: '/2026-01/return/{id}:cancel',
|
|
449
|
+
...options
|
|
450
|
+
});
|
|
451
|
+
exports.post202601ReturnByIdCancel = post202601ReturnByIdCancel;
|
|
452
|
+
/**
|
|
453
|
+
* Get Return Orders
|
|
454
|
+
*
|
|
455
|
+
*
|
|
456
|
+
* Retrieves a paginated list of return orders with optional filters for IDs, statuses, dates, and other criteria. Use this to track all returns across your ShipBob account.
|
|
457
|
+
*
|
|
458
|
+
*/
|
|
459
|
+
const get202601Return = (options) => (options?.client ?? client_gen_1.client).get({
|
|
460
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
461
|
+
url: '/2026-01/return',
|
|
462
|
+
...options
|
|
463
|
+
});
|
|
464
|
+
exports.get202601Return = get202601Return;
|
|
465
|
+
/**
|
|
466
|
+
* Create Return Order
|
|
467
|
+
*
|
|
468
|
+
*
|
|
469
|
+
* Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.
|
|
470
|
+
*
|
|
471
|
+
*/
|
|
472
|
+
const post202601Return = (options) => (options.client ?? client_gen_1.client).post({
|
|
473
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
474
|
+
url: '/2026-01/return',
|
|
475
|
+
...options,
|
|
476
|
+
headers: {
|
|
477
|
+
'Content-Type': 'application/json',
|
|
478
|
+
...options.headers
|
|
479
|
+
}
|
|
480
|
+
});
|
|
481
|
+
exports.post202601Return = post202601Return;
|
|
482
|
+
/**
|
|
483
|
+
* Get Locations
|
|
484
|
+
*
|
|
485
|
+
* Retrieves physical locations across ShipBob's fulfillment network. An active location (`is_active=true`) is operational for fulfillment processes, including receiving inventory and processing returns. Access to locations varies: some are available to all merchants by default, while others require special approval. Use the `access_granted` parameter to determine if a location is available to the authenticated user, and `receiving_enabled` to confirm if the location accepts inventory.
|
|
486
|
+
*/
|
|
487
|
+
const get202601Location = (options) => (options?.client ?? client_gen_1.client).get({
|
|
488
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
489
|
+
url: '/2026-01/location',
|
|
490
|
+
...options
|
|
491
|
+
});
|
|
492
|
+
exports.get202601Location = get202601Location;
|
|
493
|
+
/**
|
|
494
|
+
* Get Shipping Methods
|
|
495
|
+
*
|
|
496
|
+
* Retrieves all available shipping methods configured for your merchant account.
|
|
497
|
+
*/
|
|
498
|
+
const get202601ShippingMethod = (options) => (options?.client ?? client_gen_1.client).get({
|
|
499
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
500
|
+
url: '/2026-01/shipping-method',
|
|
501
|
+
...options
|
|
502
|
+
});
|
|
503
|
+
exports.get202601ShippingMethod = get202601ShippingMethod;
|
|
504
|
+
/**
|
|
505
|
+
* Get Shipment
|
|
506
|
+
*
|
|
507
|
+
* Retrieves detailed information about a specific shipment by shipment ID, including shipment status, tracking information, fulfillment center location, and contained products.
|
|
508
|
+
*/
|
|
509
|
+
const get202601ShipmentByShipmentId = (options) => (options.client ?? client_gen_1.client).get({
|
|
510
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
511
|
+
url: '/2026-01/shipment/{shipmentId}',
|
|
512
|
+
...options
|
|
513
|
+
});
|
|
514
|
+
exports.get202601ShipmentByShipmentId = get202601ShipmentByShipmentId;
|
|
515
|
+
/**
|
|
516
|
+
* Get Shipment Status Timeline by Order ID and Shipment ID
|
|
517
|
+
*
|
|
518
|
+
* Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.
|
|
519
|
+
*/
|
|
520
|
+
const get202601OrderByOrderIdShipmentByShipmentIdTimeline = (options) => (options.client ?? client_gen_1.client).get({
|
|
521
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
522
|
+
url: '/2026-01/order/{orderId}/shipment/{shipmentId}/timeline',
|
|
523
|
+
...options
|
|
524
|
+
});
|
|
525
|
+
exports.get202601OrderByOrderIdShipmentByShipmentIdTimeline = get202601OrderByOrderIdShipmentByShipmentIdTimeline;
|
|
526
|
+
/**
|
|
527
|
+
* Cancel Shipment
|
|
528
|
+
*
|
|
529
|
+
* Cancels a specific shipment by shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.
|
|
530
|
+
*/
|
|
531
|
+
const post202601ShipmentByShipmentIdCancel = (options) => (options.client ?? client_gen_1.client).post({
|
|
532
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
533
|
+
url: '/2026-01/shipment/{shipmentId}:cancel',
|
|
534
|
+
...options
|
|
535
|
+
});
|
|
536
|
+
exports.post202601ShipmentByShipmentIdCancel = post202601ShipmentByShipmentIdCancel;
|
|
537
|
+
/**
|
|
538
|
+
* Get All Shipments for Order
|
|
539
|
+
*
|
|
540
|
+
* Retrieves all shipments associated with a specific order, including shipment status, tracking information, and product details.
|
|
541
|
+
*/
|
|
542
|
+
const get202601OrderByOrderIdShipment = (options) => (options.client ?? client_gen_1.client).get({
|
|
543
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
544
|
+
url: '/2026-01/order/{orderId}/shipment',
|
|
545
|
+
...options
|
|
546
|
+
});
|
|
547
|
+
exports.get202601OrderByOrderIdShipment = get202601OrderByOrderIdShipment;
|
|
548
|
+
/**
|
|
549
|
+
* Batch Cancel Shipments
|
|
550
|
+
*
|
|
551
|
+
* Cancels multiple shipments in a single request. Shipments can only be cancelled if they are in a cancellable state (i.e. not picked, packed, or shipped yet).
|
|
552
|
+
*/
|
|
553
|
+
const post202601ShipmentBatchCancel = (options) => (options.client ?? client_gen_1.client).post({
|
|
554
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
555
|
+
url: '/2026-01/shipment:batchCancel',
|
|
556
|
+
...options,
|
|
557
|
+
headers: {
|
|
558
|
+
'Content-Type': 'application/json',
|
|
559
|
+
...options.headers
|
|
560
|
+
}
|
|
561
|
+
});
|
|
562
|
+
exports.post202601ShipmentBatchCancel = post202601ShipmentBatchCancel;
|
|
563
|
+
/**
|
|
564
|
+
* Get Orders
|
|
565
|
+
*
|
|
566
|
+
* Retrieves a paginated list of orders from your ShipBob account with optional filters. All filter parameters use AND logic, meaning orders must match all provided criteria to be returned.
|
|
567
|
+
*/
|
|
568
|
+
const get202601Order = (options) => (options?.client ?? client_gen_1.client).get({
|
|
569
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
570
|
+
url: '/2026-01/order',
|
|
571
|
+
...options
|
|
572
|
+
});
|
|
573
|
+
exports.get202601Order = get202601Order;
|
|
574
|
+
/**
|
|
575
|
+
* Create Order
|
|
576
|
+
*
|
|
577
|
+
* Creates a new order in ShipBob’s system that will be queued for fulfillment. Orders can be created using either product reference IDs (SKUs) or ShipBob product IDs, with reference IDs being the recommended approach.
|
|
578
|
+
*/
|
|
579
|
+
const post202601Order = (options) => (options.client ?? client_gen_1.client).post({
|
|
580
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
581
|
+
url: '/2026-01/order',
|
|
582
|
+
...options,
|
|
583
|
+
headers: {
|
|
584
|
+
'Content-Type': 'application/json',
|
|
585
|
+
...options.headers
|
|
586
|
+
}
|
|
587
|
+
});
|
|
588
|
+
exports.post202601Order = post202601Order;
|
|
589
|
+
/**
|
|
590
|
+
* Cancel Order
|
|
591
|
+
*
|
|
592
|
+
* Cancels an order and all associated shipments. The order must be in a cancellable state to proceed with the cancellation.
|
|
593
|
+
*/
|
|
594
|
+
const post202601OrderByOrderIdCancel = (options) => (options.client ?? client_gen_1.client).post({
|
|
595
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
596
|
+
url: '/2026-01/order/{orderId}:cancel',
|
|
597
|
+
...options
|
|
598
|
+
});
|
|
599
|
+
exports.post202601OrderByOrderIdCancel = post202601OrderByOrderIdCancel;
|
|
600
|
+
/**
|
|
601
|
+
* Estimate Fulfillment Cost For Order
|
|
602
|
+
*
|
|
603
|
+
* This endpoint will provide, where possible, an estimate of pricing and fulfillment center assignment of a potential standard (direct to consumer) order. Keep in mind that there are ways for the merchant to change FC assignment or product configuration after order creation that could invalidate this estimate. Estimates cannot be returned for items that are unknown, out of stock, or too large for fulfillment using standard box sizes. Additional services such as high-pick fees, shipping insurance, auto-splitting or auto-adding items to orders, and signature required are not included in this estimate.
|
|
604
|
+
*/
|
|
605
|
+
const post202601OrderEstimate = (options) => (options.client ?? client_gen_1.client).post({
|
|
606
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
607
|
+
url: '/2026-01/order:estimate',
|
|
608
|
+
...options,
|
|
609
|
+
headers: {
|
|
610
|
+
'Content-Type': 'application/json',
|
|
611
|
+
...options.headers
|
|
612
|
+
}
|
|
613
|
+
});
|
|
614
|
+
exports.post202601OrderEstimate = post202601OrderEstimate;
|
|
615
|
+
/**
|
|
616
|
+
* Get Order Store Data
|
|
617
|
+
*
|
|
618
|
+
* Retrieves the original store order data associated with the order in JSON format, preserving custom fields and metadata from the order source.
|
|
619
|
+
*/
|
|
620
|
+
const get202601OrderByOrderIdStoreOrderJson = (options) => (options.client ?? client_gen_1.client).get({
|
|
621
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
622
|
+
url: '/2026-01/order/{orderId}/store-order-json',
|
|
623
|
+
...options
|
|
624
|
+
});
|
|
625
|
+
exports.get202601OrderByOrderIdStoreOrderJson = get202601OrderByOrderIdStoreOrderJson;
|
|
626
|
+
/**
|
|
627
|
+
* Mark Tracking Uploaded
|
|
628
|
+
*
|
|
629
|
+
* Mark tracking information as synced to your external system for multiple shipments. Use this endpoint after syncing tracking data to update the IsTrackingUploaded flag, preventing these shipments from appearing in future GET /order queries with IsTrackingUploaded=false.
|
|
630
|
+
*
|
|
631
|
+
* <Tip>Use this endpoint if you're filtering orders by is_tracking_uploaded. This allows integrations to acknowledge that shipments have been successfully synced to their system.</Tip>
|
|
632
|
+
*/
|
|
633
|
+
const post202601ShipmentBatchUpdateTrackingUpload = (options) => (options?.client ?? client_gen_1.client).post({
|
|
634
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
635
|
+
url: '/2026-01/shipment:batchUpdateTrackingUpload',
|
|
636
|
+
...options,
|
|
637
|
+
headers: {
|
|
638
|
+
'Content-Type': 'application/json',
|
|
639
|
+
...options?.headers
|
|
640
|
+
}
|
|
641
|
+
});
|
|
642
|
+
exports.post202601ShipmentBatchUpdateTrackingUpload = post202601ShipmentBatchUpdateTrackingUpload;
|
|
643
|
+
/**
|
|
644
|
+
* Get Shipment Logs
|
|
645
|
+
*
|
|
646
|
+
* Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.
|
|
647
|
+
*/
|
|
648
|
+
const get202601ShipmentByShipmentIdLogs = (options) => (options.client ?? client_gen_1.client).get({
|
|
649
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
650
|
+
url: '/2026-01/shipment/{shipmentId}/logs',
|
|
651
|
+
...options
|
|
652
|
+
});
|
|
653
|
+
exports.get202601ShipmentByShipmentIdLogs = get202601ShipmentByShipmentIdLogs;
|
|
654
|
+
/**
|
|
655
|
+
* Get Shipment by Order ID and Shipment ID
|
|
656
|
+
*
|
|
657
|
+
* Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.
|
|
658
|
+
*/
|
|
659
|
+
const get202601OrderByOrderIdShipmentByShipmentId = (options) => (options.client ?? client_gen_1.client).get({
|
|
660
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
661
|
+
url: '/2026-01/order/{orderId}/shipment/{shipmentId}',
|
|
662
|
+
...options
|
|
663
|
+
});
|
|
664
|
+
exports.get202601OrderByOrderIdShipmentByShipmentId = get202601OrderByOrderIdShipmentByShipmentId;
|
|
665
|
+
/**
|
|
666
|
+
* Get Order
|
|
667
|
+
*
|
|
668
|
+
* Retrieves detailed information about a specific order by its order ID, including order status, shipments, products, and recipient details.
|
|
669
|
+
*/
|
|
670
|
+
const get202601OrderByOrderId = (options) => (options.client ?? client_gen_1.client).get({
|
|
671
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
672
|
+
url: '/2026-01/order/{orderId}',
|
|
673
|
+
...options
|
|
674
|
+
});
|
|
675
|
+
exports.get202601OrderByOrderId = get202601OrderByOrderId;
|
|
676
|
+
/**
|
|
677
|
+
* Cancel Shipment by Order ID and Shipment ID
|
|
678
|
+
*
|
|
679
|
+
* Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.
|
|
680
|
+
*/
|
|
681
|
+
const post202601OrderByOrderIdShipmentByShipmentIdCancel = (options) => (options.client ?? client_gen_1.client).post({
|
|
682
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
683
|
+
url: '/2026-01/order/{orderId}/shipment/{shipmentId}:cancel',
|
|
684
|
+
...options
|
|
685
|
+
});
|
|
686
|
+
exports.post202601OrderByOrderIdShipmentByShipmentIdCancel = post202601OrderByOrderIdShipmentByShipmentIdCancel;
|
|
687
|
+
/**
|
|
688
|
+
* Get Shipment Timeline
|
|
689
|
+
*
|
|
690
|
+
* Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.
|
|
691
|
+
*/
|
|
692
|
+
const get202601ShipmentByShipmentIdTimeline = (options) => (options.client ?? client_gen_1.client).get({
|
|
693
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
694
|
+
url: '/2026-01/shipment/{shipmentId}/timeline',
|
|
695
|
+
...options
|
|
696
|
+
});
|
|
697
|
+
exports.get202601ShipmentByShipmentIdTimeline = get202601ShipmentByShipmentIdTimeline;
|
|
698
|
+
/**
|
|
699
|
+
* Get Shipment Logs by Order ID and Shipment ID
|
|
700
|
+
*
|
|
701
|
+
* Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.
|
|
702
|
+
*/
|
|
703
|
+
const get202601OrderByOrderIdShipmentByShipmentIdLogs = (options) => (options.client ?? client_gen_1.client).get({
|
|
704
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
705
|
+
url: '/2026-01/order/{orderId}/shipment/{shipmentId}/logs',
|
|
706
|
+
...options
|
|
707
|
+
});
|
|
708
|
+
exports.get202601OrderByOrderIdShipmentByShipmentIdLogs = get202601OrderByOrderIdShipmentByShipmentIdLogs;
|
|
709
|
+
/**
|
|
710
|
+
* Set ExternalSync flag for Wros
|
|
711
|
+
*
|
|
712
|
+
*
|
|
713
|
+
* Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.
|
|
714
|
+
*
|
|
715
|
+
*/
|
|
716
|
+
const post202601ReceivingSetExternalSync = (options) => (options?.client ?? client_gen_1.client).post({
|
|
717
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
718
|
+
url: '/2026-01/receiving:setExternalSync',
|
|
719
|
+
...options,
|
|
720
|
+
headers: {
|
|
721
|
+
'Content-Type': 'application/json',
|
|
722
|
+
...options?.headers
|
|
723
|
+
}
|
|
724
|
+
});
|
|
725
|
+
exports.post202601ReceivingSetExternalSync = post202601ReceivingSetExternalSync;
|
|
726
|
+
/**
|
|
727
|
+
* Get Fulfillment Centers
|
|
728
|
+
*
|
|
729
|
+
*
|
|
730
|
+
* Returns a list of ShipBob fulfillment centers where inventory can be received.
|
|
731
|
+
*
|
|
732
|
+
*/
|
|
733
|
+
const get202601FulfillmentCenter = (options) => (options?.client ?? client_gen_1.client).get({
|
|
734
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
735
|
+
url: '/2026-01/fulfillment-center',
|
|
736
|
+
...options
|
|
737
|
+
});
|
|
738
|
+
exports.get202601FulfillmentCenter = get202601FulfillmentCenter;
|
|
739
|
+
/**
|
|
740
|
+
* Cancel Warehouse Receiving Order
|
|
741
|
+
*
|
|
742
|
+
*
|
|
743
|
+
* Cancels an existing warehouse receiving order. Only orders in certain statuses can be cancelled.
|
|
744
|
+
*
|
|
745
|
+
*/
|
|
746
|
+
const post202601ReceivingByIdCancel = (options) => (options.client ?? client_gen_1.client).post({
|
|
747
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
748
|
+
url: '/2026-01/receiving/{id}:cancel',
|
|
749
|
+
...options
|
|
750
|
+
});
|
|
751
|
+
exports.post202601ReceivingByIdCancel = post202601ReceivingByIdCancel;
|
|
752
|
+
/**
|
|
753
|
+
* Get Multiple Warehouse Receiving Orders
|
|
754
|
+
*
|
|
755
|
+
*
|
|
756
|
+
* Returns a list of warehouse receiving orders with optional filtering by status, fulfillment center, purchase order number, and date range.
|
|
757
|
+
*
|
|
758
|
+
*/
|
|
759
|
+
const get202601Receiving = (options) => (options?.client ?? client_gen_1.client).get({
|
|
760
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
761
|
+
url: '/2026-01/receiving',
|
|
762
|
+
...options
|
|
763
|
+
});
|
|
764
|
+
exports.get202601Receiving = get202601Receiving;
|
|
765
|
+
/**
|
|
766
|
+
* Create Warehouse Receiving Order
|
|
767
|
+
*
|
|
768
|
+
*
|
|
769
|
+
* Creates a new warehouse receiving order with specified fulfillment center, boxes, and inventory items.
|
|
770
|
+
*
|
|
771
|
+
*/
|
|
772
|
+
const post202601Receiving = (options) => (options?.client ?? client_gen_1.client).post({
|
|
773
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
774
|
+
url: '/2026-01/receiving',
|
|
775
|
+
...options,
|
|
776
|
+
headers: {
|
|
777
|
+
'Content-Type': 'application/json',
|
|
778
|
+
...options?.headers
|
|
779
|
+
}
|
|
780
|
+
});
|
|
781
|
+
exports.post202601Receiving = post202601Receiving;
|
|
782
|
+
/**
|
|
783
|
+
* Get Warehouse Receiving Order Boxes
|
|
784
|
+
*
|
|
785
|
+
*
|
|
786
|
+
* Returns the boxes and their contents for a specific warehouse receiving order.
|
|
787
|
+
*
|
|
788
|
+
*/
|
|
789
|
+
const get202601ReceivingByIdBoxes = (options) => (options.client ?? client_gen_1.client).get({
|
|
790
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
791
|
+
url: '/2026-01/receiving/{id}/boxes',
|
|
792
|
+
...options
|
|
793
|
+
});
|
|
794
|
+
exports.get202601ReceivingByIdBoxes = get202601ReceivingByIdBoxes;
|
|
795
|
+
/**
|
|
796
|
+
* Get Warehouse Receiving Order Box Labels
|
|
797
|
+
*
|
|
798
|
+
*
|
|
799
|
+
* Returns a PDF containing box labels for a specific warehouse receiving order.
|
|
800
|
+
*
|
|
801
|
+
*/
|
|
802
|
+
const get202601ReceivingByIdLabels = (options) => (options.client ?? client_gen_1.client).get({
|
|
803
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
804
|
+
url: '/2026-01/receiving/{id}/labels',
|
|
805
|
+
...options
|
|
806
|
+
});
|
|
807
|
+
exports.get202601ReceivingByIdLabels = get202601ReceivingByIdLabels;
|
|
808
|
+
/**
|
|
809
|
+
* Get Warehouse Receiving Order
|
|
810
|
+
*
|
|
811
|
+
*
|
|
812
|
+
* Returns details of a specific warehouse receiving order by ID.
|
|
813
|
+
*
|
|
814
|
+
*/
|
|
815
|
+
const get202601ReceivingById = (options) => (options.client ?? client_gen_1.client).get({
|
|
816
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
817
|
+
url: '/2026-01/receiving/{id}',
|
|
818
|
+
...options
|
|
819
|
+
});
|
|
820
|
+
exports.get202601ReceivingById = get202601ReceivingById;
|
|
821
|
+
/**
|
|
822
|
+
* Query Inventory History Events
|
|
823
|
+
*
|
|
824
|
+
* Fetches inventory movement events that change on-hand quantities within the ShipBob network. Returns events such as receiving/stow, order picks, adjustments, restocks, and attribute updates. Filter by inventory IDs, event category, date range, and facility. Supports cursor-based pagination for large result sets.
|
|
825
|
+
*/
|
|
826
|
+
const post202601InventoryHistoryQuery = (options) => (options?.client ?? client_gen_1.client).post({
|
|
827
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
828
|
+
url: '/2026-01/inventory/history:query',
|
|
829
|
+
...options,
|
|
830
|
+
headers: {
|
|
831
|
+
'Content-Type': 'application/json',
|
|
832
|
+
...options?.headers
|
|
833
|
+
}
|
|
834
|
+
});
|
|
835
|
+
exports.post202601InventoryHistoryQuery = post202601InventoryHistoryQuery;
|
|
836
|
+
/**
|
|
837
|
+
* Get Inventory Distributions by WRO ID
|
|
838
|
+
*
|
|
839
|
+
* Retrieves the distribution details for a specific receiving order within ShipBob's Inventory Placement Program (IPP).
|
|
840
|
+
* <Warning>This endpoint is available only to accounts enrolled in ShipBob's Inventory Placement Program (IPP).</Warning>
|
|
841
|
+
*/
|
|
842
|
+
const get202601ReceivingByIdDistributions = (options) => (options.client ?? client_gen_1.client).get({
|
|
843
|
+
security: [{ scheme: 'bearer', type: 'http' }, { scheme: 'bearer', type: 'http' }],
|
|
844
|
+
url: '/2026-01/receiving/{id}/distributions',
|
|
845
|
+
...options
|
|
846
|
+
});
|
|
847
|
+
exports.get202601ReceivingByIdDistributions = get202601ReceivingByIdDistributions;
|
|
848
|
+
//# sourceMappingURL=sdk.gen.js.map
|