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,380 @@
|
|
|
1
|
+
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
+
import type { Delete202507ProductByProductIdData, Delete202507ProductByProductIdErrors, Delete202507ProductByProductIdResponses, Delete202507WebhookByIdData, Delete202507WebhookByIdErrors, Delete202507WebhookByIdResponses, Get202507ChannelData, Get202507ChannelErrors, Get202507ChannelResponses, Get202507FulfillmentCenterData, Get202507FulfillmentCenterErrors, Get202507FulfillmentCenterResponses, Get202507InventoryByInventoryIdData, Get202507InventoryByInventoryIdErrors, Get202507InventoryByInventoryIdResponses, Get202507InventoryData, Get202507InventoryErrors, Get202507InventoryLevelByInventoryIdData, Get202507InventoryLevelByInventoryIdErrors, Get202507InventoryLevelByInventoryIdLocationsData, Get202507InventoryLevelByInventoryIdLocationsErrors, Get202507InventoryLevelByInventoryIdLocationsResponses, Get202507InventoryLevelByInventoryIdLotsData, Get202507InventoryLevelByInventoryIdLotsErrors, Get202507InventoryLevelByInventoryIdLotsResponses, Get202507InventoryLevelByInventoryIdResponses, Get202507InventoryLevelData, Get202507InventoryLevelErrors, Get202507InventoryLevelLocationsData, Get202507InventoryLevelLocationsErrors, Get202507InventoryLevelLocationsResponses, Get202507InventoryLevelLotsData, Get202507InventoryLevelLotsErrors, Get202507InventoryLevelLotsResponses, Get202507InventoryLevelResponses, Get202507InventoryResponses, Get202507InvoicesByInvoiceIdTransactionsData, Get202507InvoicesByInvoiceIdTransactionsErrors, Get202507InvoicesByInvoiceIdTransactionsResponses, Get202507InvoicesData, Get202507InvoicesErrors, Get202507InvoicesResponses, Get202507LocationData, Get202507LocationErrors, Get202507LocationResponses, Get202507OrderByOrderIdData, Get202507OrderByOrderIdErrors, Get202507OrderByOrderIdResponses, Get202507OrderByOrderIdShipmentByShipmentIdData, Get202507OrderByOrderIdShipmentByShipmentIdErrors, Get202507OrderByOrderIdShipmentByShipmentIdLogsData, Get202507OrderByOrderIdShipmentByShipmentIdLogsErrors, Get202507OrderByOrderIdShipmentByShipmentIdLogsResponses, Get202507OrderByOrderIdShipmentByShipmentIdResponses, Get202507OrderByOrderIdShipmentByShipmentIdTimelineData, Get202507OrderByOrderIdShipmentByShipmentIdTimelineErrors, Get202507OrderByOrderIdShipmentByShipmentIdTimelineResponses, Get202507OrderByOrderIdShipmentData, Get202507OrderByOrderIdShipmentErrors, Get202507OrderByOrderIdShipmentResponses, Get202507OrderByOrderIdStoreOrderJsonData, Get202507OrderByOrderIdStoreOrderJsonErrors, Get202507OrderByOrderIdStoreOrderJsonResponses, Get202507OrderData, Get202507OrderErrors, Get202507OrderResponses, Get202507PackagingRequirementData, Get202507PackagingRequirementResponses, Get202507ProductByProductIdData, Get202507ProductByProductIdErrors, Get202507ProductByProductIdResponses, Get202507ProductByProductIdVariantsData, Get202507ProductByProductIdVariantsErrors, Get202507ProductByProductIdVariantsResponses, Get202507ProductData, Get202507ProductErrors, Get202507ProductResponses, Get202507ReceivingByIdBoxesData, Get202507ReceivingByIdBoxesErrors, Get202507ReceivingByIdBoxesResponses, Get202507ReceivingByIdData, Get202507ReceivingByIdDistributionsData, Get202507ReceivingByIdDistributionsErrors, Get202507ReceivingByIdDistributionsResponses, Get202507ReceivingByIdErrors, Get202507ReceivingByIdLabelsData, Get202507ReceivingByIdLabelsErrors, Get202507ReceivingByIdLabelsResponses, Get202507ReceivingByIdResponses, Get202507ReceivingData, Get202507ReceivingErrors, Get202507ReceivingResponses, Get202507ReturnByIdData, Get202507ReturnByIdErrors, Get202507ReturnByIdResponses, Get202507ReturnData, Get202507ReturnErrors, Get202507ReturnResponses, Get202507ShipmentByShipmentIdData, Get202507ShipmentByShipmentIdErrors, Get202507ShipmentByShipmentIdLogsData, Get202507ShipmentByShipmentIdLogsErrors, Get202507ShipmentByShipmentIdLogsResponses, Get202507ShipmentByShipmentIdResponses, Get202507ShipmentByShipmentIdTimelineData, Get202507ShipmentByShipmentIdTimelineErrors, Get202507ShipmentByShipmentIdTimelineResponses, Get202507ShippingMethodData, Get202507ShippingMethodErrors, Get202507ShippingMethodResponses, Get202507TaxonomyByIdData, Get202507TaxonomyByIdErrors, Get202507TaxonomyByIdParentData, Get202507TaxonomyByIdParentErrors, Get202507TaxonomyByIdParentResponses, Get202507TaxonomyByIdResponses, Get202507TaxonomyData, Get202507TaxonomyErrors, Get202507TaxonomyResponses, Get202507TransactionFeesData, Get202507TransactionFeesErrors, Get202507TransactionFeesResponses, Get202507WebhookData, Get202507WebhookErrors, Get202507WebhookResponses, Patch202507ProductByProductIdData, Patch202507ProductByProductIdResponses, Patch202507ProductByProductIdVariantsData, Patch202507ProductByProductIdVariantsResponses, Post202507OrderByOrderIdCancelData, Post202507OrderByOrderIdCancelErrors, Post202507OrderByOrderIdCancelResponses, Post202507OrderByOrderIdShipmentByShipmentIdCancelData, Post202507OrderByOrderIdShipmentByShipmentIdCancelErrors, Post202507OrderByOrderIdShipmentByShipmentIdCancelResponses, Post202507OrderByOrderIdStoreOrderJsonData, Post202507OrderByOrderIdStoreOrderJsonErrors, Post202507OrderByOrderIdStoreOrderJsonResponses, Post202507OrderData, Post202507OrderErrors, Post202507OrderEstimateData, Post202507OrderEstimateErrors, Post202507OrderEstimateResponses, Post202507OrderResponses, Post202507ProductByProductIdMoveVariantsData, Post202507ProductByProductIdMoveVariantsErrors, Post202507ProductByProductIdMoveVariantsResponses, Post202507ProductByProductIdVariantsData, Post202507ProductByProductIdVariantsResponses, Post202507ProductData, Post202507ProductMoveVariantsData, Post202507ProductMoveVariantsErrors, Post202507ProductMoveVariantsResponses, Post202507ProductResponses, Post202507ReceivingByIdCancelData, Post202507ReceivingByIdCancelErrors, Post202507ReceivingByIdCancelResponses, Post202507ReceivingData, Post202507ReceivingErrors, Post202507ReceivingResponses, Post202507ReceivingSetExternalSyncData, Post202507ReceivingSetExternalSyncErrors, Post202507ReceivingSetExternalSyncResponses, Post202507ReturnByIdCancelData, Post202507ReturnByIdCancelErrors, Post202507ReturnByIdCancelResponses, Post202507ReturnData, Post202507ReturnErrors, Post202507ReturnResponses, Post202507ShipmentBatchCancelData, Post202507ShipmentBatchCancelErrors, Post202507ShipmentBatchCancelResponses, Post202507ShipmentBatchUpdateTrackingUploadData, Post202507ShipmentBatchUpdateTrackingUploadErrors, Post202507ShipmentBatchUpdateTrackingUploadResponses, Post202507ShipmentByShipmentIdCancelData, Post202507ShipmentByShipmentIdCancelErrors, Post202507ShipmentByShipmentIdCancelResponses, Post202507TransactionsQueryData, Post202507TransactionsQueryErrors, Post202507TransactionsQueryResponses, Post202507VariantByVariantIdConvertToBundleData, Post202507VariantByVariantIdConvertToBundleResponses, Post202507VariantByVariantIdMergeData, Post202507VariantByVariantIdMergeResponses, Post202507WebhookData, Post202507WebhookErrors, Post202507WebhookResponses, Put202507ReturnByIdData, Put202507ReturnByIdErrors, Put202507ReturnByIdResponses } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Get channels
|
|
18
|
+
*
|
|
19
|
+
* Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.
|
|
20
|
+
*
|
|
21
|
+
*/
|
|
22
|
+
export declare const get202507Channel: <ThrowOnError extends boolean = false>(options?: Options<Get202507ChannelData, ThrowOnError>) => import("./client").RequestResult<Get202507ChannelResponses, Get202507ChannelErrors, ThrowOnError, "fields">;
|
|
23
|
+
/**
|
|
24
|
+
* Get Subscriptions
|
|
25
|
+
*
|
|
26
|
+
*
|
|
27
|
+
* This endpoint returns a list of webhook subscriptions.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
export declare const get202507Webhook: <ThrowOnError extends boolean = false>(options?: Options<Get202507WebhookData, ThrowOnError>) => import("./client").RequestResult<Get202507WebhookResponses, Get202507WebhookErrors, ThrowOnError, "fields">;
|
|
31
|
+
/**
|
|
32
|
+
* Create Subscription
|
|
33
|
+
*
|
|
34
|
+
*
|
|
35
|
+
* This endpoint creates a new webhook subscription.
|
|
36
|
+
*
|
|
37
|
+
*/
|
|
38
|
+
export declare const post202507Webhook: <ThrowOnError extends boolean = false>(options?: Options<Post202507WebhookData, ThrowOnError>) => import("./client").RequestResult<Post202507WebhookResponses, Post202507WebhookErrors, ThrowOnError, "fields">;
|
|
39
|
+
/**
|
|
40
|
+
* Delete Subscription
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
* This endpoint deletes a webhook subscription.
|
|
44
|
+
*
|
|
45
|
+
*/
|
|
46
|
+
export declare const delete202507WebhookById: <ThrowOnError extends boolean = false>(options: Options<Delete202507WebhookByIdData, ThrowOnError>) => import("./client").RequestResult<Delete202507WebhookByIdResponses, Delete202507WebhookByIdErrors, ThrowOnError, "fields">;
|
|
47
|
+
/**
|
|
48
|
+
* Get Fulfillment Centers
|
|
49
|
+
*
|
|
50
|
+
*/
|
|
51
|
+
export declare const get202507FulfillmentCenter: <ThrowOnError extends boolean = false>(options?: Options<Get202507FulfillmentCenterData, ThrowOnError>) => import("./client").RequestResult<Get202507FulfillmentCenterResponses, Get202507FulfillmentCenterErrors, ThrowOnError, "fields">;
|
|
52
|
+
/**
|
|
53
|
+
* Get Warehouse Receiving Order
|
|
54
|
+
*
|
|
55
|
+
*/
|
|
56
|
+
export declare const get202507ReceivingById: <ThrowOnError extends boolean = false>(options: Options<Get202507ReceivingByIdData, ThrowOnError>) => import("./client").RequestResult<Get202507ReceivingByIdResponses, Get202507ReceivingByIdErrors, ThrowOnError, "fields">;
|
|
57
|
+
/**
|
|
58
|
+
* Get Multiple Warehouse Receiving Orders
|
|
59
|
+
*
|
|
60
|
+
*/
|
|
61
|
+
export declare const get202507Receiving: <ThrowOnError extends boolean = false>(options?: Options<Get202507ReceivingData, ThrowOnError>) => import("./client").RequestResult<Get202507ReceivingResponses, Get202507ReceivingErrors, ThrowOnError, "fields">;
|
|
62
|
+
/**
|
|
63
|
+
* Create Warehouse Receiving Order
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
66
|
+
export declare const post202507Receiving: <ThrowOnError extends boolean = false>(options?: Options<Post202507ReceivingData, ThrowOnError>) => import("./client").RequestResult<Post202507ReceivingResponses, Post202507ReceivingErrors, ThrowOnError, "fields">;
|
|
67
|
+
/**
|
|
68
|
+
* Get Warehouse Receiving Order Box Labels
|
|
69
|
+
*
|
|
70
|
+
*/
|
|
71
|
+
export declare const get202507ReceivingByIdLabels: <ThrowOnError extends boolean = false>(options: Options<Get202507ReceivingByIdLabelsData, ThrowOnError>) => import("./client").RequestResult<Get202507ReceivingByIdLabelsResponses, Get202507ReceivingByIdLabelsErrors, ThrowOnError, "fields">;
|
|
72
|
+
/**
|
|
73
|
+
* Cancel Warehouse Receiving Order
|
|
74
|
+
*
|
|
75
|
+
*/
|
|
76
|
+
export declare const post202507ReceivingByIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202507ReceivingByIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202507ReceivingByIdCancelResponses, Post202507ReceivingByIdCancelErrors, ThrowOnError, "fields">;
|
|
77
|
+
/**
|
|
78
|
+
* Set ExternalSync flag for Wros
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
export declare const post202507ReceivingSetExternalSync: <ThrowOnError extends boolean = false>(options?: Options<Post202507ReceivingSetExternalSyncData, ThrowOnError>) => import("./client").RequestResult<Post202507ReceivingSetExternalSyncResponses, Post202507ReceivingSetExternalSyncErrors, ThrowOnError, "fields">;
|
|
82
|
+
/**
|
|
83
|
+
* Get Warehouse Receiving Order Boxes
|
|
84
|
+
*
|
|
85
|
+
*/
|
|
86
|
+
export declare const get202507ReceivingByIdBoxes: <ThrowOnError extends boolean = false>(options: Options<Get202507ReceivingByIdBoxesData, ThrowOnError>) => import("./client").RequestResult<Get202507ReceivingByIdBoxesResponses, Get202507ReceivingByIdBoxesErrors, ThrowOnError, "fields">;
|
|
87
|
+
/**
|
|
88
|
+
* Get logs for one Shipment by Shipment Id
|
|
89
|
+
*/
|
|
90
|
+
export declare const get202507ShipmentByShipmentIdLogs: <ThrowOnError extends boolean = false>(options: Options<Get202507ShipmentByShipmentIdLogsData, ThrowOnError>) => import("./client").RequestResult<Get202507ShipmentByShipmentIdLogsResponses, Get202507ShipmentByShipmentIdLogsErrors, ThrowOnError, "fields">;
|
|
91
|
+
/**
|
|
92
|
+
* Get logs for one Shipment by Order Id and Shipment Id
|
|
93
|
+
*/
|
|
94
|
+
export declare const get202507OrderByOrderIdShipmentByShipmentIdLogs: <ThrowOnError extends boolean = false>(options: Options<Get202507OrderByOrderIdShipmentByShipmentIdLogsData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderByOrderIdShipmentByShipmentIdLogsResponses, Get202507OrderByOrderIdShipmentByShipmentIdLogsErrors, ThrowOnError, "fields">;
|
|
95
|
+
/**
|
|
96
|
+
* Get Orders
|
|
97
|
+
*
|
|
98
|
+
* All parameters are AND filters
|
|
99
|
+
*/
|
|
100
|
+
export declare const get202507Order: <ThrowOnError extends boolean = false>(options?: Options<Get202507OrderData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderResponses, Get202507OrderErrors, ThrowOnError, "fields">;
|
|
101
|
+
/**
|
|
102
|
+
* Create Order
|
|
103
|
+
*/
|
|
104
|
+
export declare const post202507Order: <ThrowOnError extends boolean = false>(options: Options<Post202507OrderData, ThrowOnError>) => import("./client").RequestResult<Post202507OrderResponses, Post202507OrderErrors, ThrowOnError, "fields">;
|
|
105
|
+
/**
|
|
106
|
+
* Get one Shipment by Order Id and Shipment Id
|
|
107
|
+
*/
|
|
108
|
+
export declare const get202507OrderByOrderIdShipmentByShipmentId: <ThrowOnError extends boolean = false>(options: Options<Get202507OrderByOrderIdShipmentByShipmentIdData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderByOrderIdShipmentByShipmentIdResponses, Get202507OrderByOrderIdShipmentByShipmentIdErrors, ThrowOnError, "fields">;
|
|
109
|
+
/**
|
|
110
|
+
* Get one Shipment's status timeline by Order Id and Shipment Id
|
|
111
|
+
*/
|
|
112
|
+
export declare const get202507OrderByOrderIdShipmentByShipmentIdTimeline: <ThrowOnError extends boolean = false>(options: Options<Get202507OrderByOrderIdShipmentByShipmentIdTimelineData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderByOrderIdShipmentByShipmentIdTimelineResponses, Get202507OrderByOrderIdShipmentByShipmentIdTimelineErrors, ThrowOnError, "fields">;
|
|
113
|
+
/**
|
|
114
|
+
* Get one Shipment by Shipment Id
|
|
115
|
+
*/
|
|
116
|
+
export declare const get202507ShipmentByShipmentId: <ThrowOnError extends boolean = false>(options: Options<Get202507ShipmentByShipmentIdData, ThrowOnError>) => import("./client").RequestResult<Get202507ShipmentByShipmentIdResponses, Get202507ShipmentByShipmentIdErrors, ThrowOnError, "fields">;
|
|
117
|
+
/**
|
|
118
|
+
* Get one Shipment's status timeline by Shipment Id
|
|
119
|
+
*/
|
|
120
|
+
export declare const get202507ShipmentByShipmentIdTimeline: <ThrowOnError extends boolean = false>(options: Options<Get202507ShipmentByShipmentIdTimelineData, ThrowOnError>) => import("./client").RequestResult<Get202507ShipmentByShipmentIdTimelineResponses, Get202507ShipmentByShipmentIdTimelineErrors, ThrowOnError, "fields">;
|
|
121
|
+
/**
|
|
122
|
+
* Get all Shipments for Order
|
|
123
|
+
*/
|
|
124
|
+
export declare const get202507OrderByOrderIdShipment: <ThrowOnError extends boolean = false>(options: Options<Get202507OrderByOrderIdShipmentData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderByOrderIdShipmentResponses, Get202507OrderByOrderIdShipmentErrors, ThrowOnError, "fields">;
|
|
125
|
+
/**
|
|
126
|
+
* Get Order
|
|
127
|
+
*/
|
|
128
|
+
export declare const get202507OrderByOrderId: <ThrowOnError extends boolean = false>(options: Options<Get202507OrderByOrderIdData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderByOrderIdResponses, Get202507OrderByOrderIdErrors, ThrowOnError, "fields">;
|
|
129
|
+
/**
|
|
130
|
+
* Get Return Order
|
|
131
|
+
*
|
|
132
|
+
*
|
|
133
|
+
* 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.
|
|
134
|
+
*
|
|
135
|
+
*/
|
|
136
|
+
export declare const get202507ReturnById: <ThrowOnError extends boolean = false>(options: Options<Get202507ReturnByIdData, ThrowOnError>) => import("./client").RequestResult<Get202507ReturnByIdResponses, Get202507ReturnByIdErrors, ThrowOnError, "fields">;
|
|
137
|
+
/**
|
|
138
|
+
* Modify Return Order
|
|
139
|
+
*
|
|
140
|
+
*/
|
|
141
|
+
export declare const put202507ReturnById: <ThrowOnError extends boolean = false>(options: Options<Put202507ReturnByIdData, ThrowOnError>) => import("./client").RequestResult<Put202507ReturnByIdResponses, Put202507ReturnByIdErrors, ThrowOnError, "fields">;
|
|
142
|
+
/**
|
|
143
|
+
* Get locations
|
|
144
|
+
*
|
|
145
|
+
*/
|
|
146
|
+
export declare const get202507Location: <ThrowOnError extends boolean = false>(options?: Options<Get202507LocationData, ThrowOnError>) => import("./client").RequestResult<Get202507LocationResponses, Get202507LocationErrors, ThrowOnError, "fields">;
|
|
147
|
+
/**
|
|
148
|
+
* Get Packaging Requirement
|
|
149
|
+
*
|
|
150
|
+
* Retrieves all available packaging requirements that can be assigned to a product.
|
|
151
|
+
*/
|
|
152
|
+
export declare const get202507PackagingRequirement: <ThrowOnError extends boolean = false>(options?: Options<Get202507PackagingRequirementData, ThrowOnError>) => import("./client").RequestResult<Get202507PackagingRequirementResponses, unknown, ThrowOnError, "fields">;
|
|
153
|
+
/**
|
|
154
|
+
* Merge Variants
|
|
155
|
+
*
|
|
156
|
+
* 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.
|
|
157
|
+
*/
|
|
158
|
+
export declare const post202507VariantByVariantIdMerge: <ThrowOnError extends boolean = false>(options: Options<Post202507VariantByVariantIdMergeData, ThrowOnError>) => import("./client").RequestResult<Post202507VariantByVariantIdMergeResponses, unknown, ThrowOnError, "fields">;
|
|
159
|
+
/**
|
|
160
|
+
* Get Taxonomy Parent
|
|
161
|
+
*
|
|
162
|
+
* Retrieves the parent taxonomy node for a given taxonomy ID.
|
|
163
|
+
*/
|
|
164
|
+
export declare const get202507TaxonomyByIdParent: <ThrowOnError extends boolean = false>(options: Options<Get202507TaxonomyByIdParentData, ThrowOnError>) => import("./client").RequestResult<Get202507TaxonomyByIdParentResponses, Get202507TaxonomyByIdParentErrors, ThrowOnError, "fields">;
|
|
165
|
+
/**
|
|
166
|
+
* Delete Product Bundle
|
|
167
|
+
*
|
|
168
|
+
* Deletes a bundle product by ID. Delete operation not allowed for non-bundles.
|
|
169
|
+
*/
|
|
170
|
+
export declare const delete202507ProductByProductId: <ThrowOnError extends boolean = false>(options: Options<Delete202507ProductByProductIdData, ThrowOnError>) => import("./client").RequestResult<Delete202507ProductByProductIdResponses, Delete202507ProductByProductIdErrors, ThrowOnError, "fields">;
|
|
171
|
+
/**
|
|
172
|
+
* Get Product
|
|
173
|
+
*
|
|
174
|
+
* Retrieves a product with all its variants and details.
|
|
175
|
+
*/
|
|
176
|
+
export declare const get202507ProductByProductId: <ThrowOnError extends boolean = false>(options: Options<Get202507ProductByProductIdData, ThrowOnError>) => import("./client").RequestResult<Get202507ProductByProductIdResponses, Get202507ProductByProductIdErrors, ThrowOnError, "fields">;
|
|
177
|
+
/**
|
|
178
|
+
* Update Product
|
|
179
|
+
*
|
|
180
|
+
* 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.
|
|
181
|
+
*/
|
|
182
|
+
export declare const patch202507ProductByProductId: <ThrowOnError extends boolean = false>(options: Options<Patch202507ProductByProductIdData, ThrowOnError>) => import("./client").RequestResult<Patch202507ProductByProductIdResponses, unknown, ThrowOnError, "fields">;
|
|
183
|
+
/**
|
|
184
|
+
* Move Variants Between Products
|
|
185
|
+
*
|
|
186
|
+
* Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.
|
|
187
|
+
*/
|
|
188
|
+
export declare const post202507ProductByProductIdMoveVariants: <ThrowOnError extends boolean = false>(options: Options<Post202507ProductByProductIdMoveVariantsData, ThrowOnError>) => import("./client").RequestResult<Post202507ProductByProductIdMoveVariantsResponses, Post202507ProductByProductIdMoveVariantsErrors, ThrowOnError, "fields">;
|
|
189
|
+
/**
|
|
190
|
+
* Convert Variant to Bundle
|
|
191
|
+
*
|
|
192
|
+
* Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.
|
|
193
|
+
*/
|
|
194
|
+
export declare const post202507VariantByVariantIdConvertToBundle: <ThrowOnError extends boolean = false>(options: Options<Post202507VariantByVariantIdConvertToBundleData, ThrowOnError>) => import("./client").RequestResult<Post202507VariantByVariantIdConvertToBundleResponses, unknown, ThrowOnError, "fields">;
|
|
195
|
+
/**
|
|
196
|
+
* Get Taxonomy by ID
|
|
197
|
+
*
|
|
198
|
+
* Retrieves a specific taxonomy node and its details by taxonomy ID.
|
|
199
|
+
*/
|
|
200
|
+
export declare const get202507TaxonomyById: <ThrowOnError extends boolean = false>(options: Options<Get202507TaxonomyByIdData, ThrowOnError>) => import("./client").RequestResult<Get202507TaxonomyByIdResponses, Get202507TaxonomyByIdErrors, ThrowOnError, "fields">;
|
|
201
|
+
/**
|
|
202
|
+
* Move Variants to New Product
|
|
203
|
+
*
|
|
204
|
+
* Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.
|
|
205
|
+
*/
|
|
206
|
+
export declare const post202507ProductMoveVariants: <ThrowOnError extends boolean = false>(options?: Options<Post202507ProductMoveVariantsData, ThrowOnError>) => import("./client").RequestResult<Post202507ProductMoveVariantsResponses, Post202507ProductMoveVariantsErrors, ThrowOnError, "fields">;
|
|
207
|
+
/**
|
|
208
|
+
* Get Product Variants
|
|
209
|
+
*
|
|
210
|
+
* Retrieves all variants for a specific product.
|
|
211
|
+
*/
|
|
212
|
+
export declare const get202507ProductByProductIdVariants: <ThrowOnError extends boolean = false>(options: Options<Get202507ProductByProductIdVariantsData, ThrowOnError>) => import("./client").RequestResult<Get202507ProductByProductIdVariantsResponses, Get202507ProductByProductIdVariantsErrors, ThrowOnError, "fields">;
|
|
213
|
+
/**
|
|
214
|
+
* Update Product Variants
|
|
215
|
+
*
|
|
216
|
+
* 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.
|
|
217
|
+
*/
|
|
218
|
+
export declare const patch202507ProductByProductIdVariants: <ThrowOnError extends boolean = false>(options: Options<Patch202507ProductByProductIdVariantsData, ThrowOnError>) => import("./client").RequestResult<Patch202507ProductByProductIdVariantsResponses, unknown, ThrowOnError, "fields">;
|
|
219
|
+
/**
|
|
220
|
+
* Add Product Variants
|
|
221
|
+
*
|
|
222
|
+
* Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.
|
|
223
|
+
*/
|
|
224
|
+
export declare const post202507ProductByProductIdVariants: <ThrowOnError extends boolean = false>(options: Options<Post202507ProductByProductIdVariantsData, ThrowOnError>) => import("./client").RequestResult<Post202507ProductByProductIdVariantsResponses, unknown, ThrowOnError, "fields">;
|
|
225
|
+
/**
|
|
226
|
+
* Get Products
|
|
227
|
+
*
|
|
228
|
+
* Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.
|
|
229
|
+
*/
|
|
230
|
+
export declare const get202507Product: <ThrowOnError extends boolean = false>(options?: Options<Get202507ProductData, ThrowOnError>) => import("./client").RequestResult<Get202507ProductResponses, Get202507ProductErrors, ThrowOnError, "fields">;
|
|
231
|
+
/**
|
|
232
|
+
* Create Product
|
|
233
|
+
*
|
|
234
|
+
* Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.
|
|
235
|
+
*/
|
|
236
|
+
export declare const post202507Product: <ThrowOnError extends boolean = false>(options?: Options<Post202507ProductData, ThrowOnError>) => import("./client").RequestResult<Post202507ProductResponses, unknown, ThrowOnError, "fields">;
|
|
237
|
+
/**
|
|
238
|
+
* Get Taxonomies
|
|
239
|
+
*
|
|
240
|
+
* Retrieves all available product taxonomies for categorizing products.
|
|
241
|
+
*/
|
|
242
|
+
export declare const get202507Taxonomy: <ThrowOnError extends boolean = false>(options?: Options<Get202507TaxonomyData, ThrowOnError>) => import("./client").RequestResult<Get202507TaxonomyResponses, Get202507TaxonomyErrors, ThrowOnError, "fields">;
|
|
243
|
+
/**
|
|
244
|
+
* Get All Inventories
|
|
245
|
+
*
|
|
246
|
+
*/
|
|
247
|
+
export declare const get202507Inventory: <ThrowOnError extends boolean = false>(options?: Options<Get202507InventoryData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryResponses, Get202507InventoryErrors, ThrowOnError, "fields">;
|
|
248
|
+
/**
|
|
249
|
+
* Get Inventory
|
|
250
|
+
*
|
|
251
|
+
*/
|
|
252
|
+
export declare const get202507InventoryByInventoryId: <ThrowOnError extends boolean = false>(options: Options<Get202507InventoryByInventoryIdData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryByInventoryIdResponses, Get202507InventoryByInventoryIdErrors, ThrowOnError, "fields">;
|
|
253
|
+
/**
|
|
254
|
+
* Get Inventory Levels
|
|
255
|
+
*
|
|
256
|
+
*/
|
|
257
|
+
export declare const get202507InventoryLevelByInventoryId: <ThrowOnError extends boolean = false>(options: Options<Get202507InventoryLevelByInventoryIdData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryLevelByInventoryIdResponses, Get202507InventoryLevelByInventoryIdErrors, ThrowOnError, "fields">;
|
|
258
|
+
/**
|
|
259
|
+
* Get All Inventory Levels
|
|
260
|
+
*
|
|
261
|
+
*/
|
|
262
|
+
export declare const get202507InventoryLevel: <ThrowOnError extends boolean = false>(options?: Options<Get202507InventoryLevelData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryLevelResponses, Get202507InventoryLevelErrors, ThrowOnError, "fields">;
|
|
263
|
+
/**
|
|
264
|
+
* Get All Inventory Levels Grouped By Fulfillment Center
|
|
265
|
+
*
|
|
266
|
+
*/
|
|
267
|
+
export declare const get202507InventoryLevelLocations: <ThrowOnError extends boolean = false>(options?: Options<Get202507InventoryLevelLocationsData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryLevelLocationsResponses, Get202507InventoryLevelLocationsErrors, ThrowOnError, "fields">;
|
|
268
|
+
/**
|
|
269
|
+
* Get All Inventory Levels Grouped By Lot
|
|
270
|
+
*
|
|
271
|
+
*/
|
|
272
|
+
export declare const get202507InventoryLevelLots: <ThrowOnError extends boolean = false>(options?: Options<Get202507InventoryLevelLotsData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryLevelLotsResponses, Get202507InventoryLevelLotsErrors, ThrowOnError, "fields">;
|
|
273
|
+
/**
|
|
274
|
+
* Get Inventory Levels Grouped By Lot
|
|
275
|
+
*
|
|
276
|
+
*/
|
|
277
|
+
export declare const get202507InventoryLevelByInventoryIdLots: <ThrowOnError extends boolean = false>(options: Options<Get202507InventoryLevelByInventoryIdLotsData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryLevelByInventoryIdLotsResponses, Get202507InventoryLevelByInventoryIdLotsErrors, ThrowOnError, "fields">;
|
|
278
|
+
/**
|
|
279
|
+
* Get Inventory Levels Grouped By Fulfillment Center
|
|
280
|
+
*
|
|
281
|
+
*/
|
|
282
|
+
export declare const get202507InventoryLevelByInventoryIdLocations: <ThrowOnError extends boolean = false>(options: Options<Get202507InventoryLevelByInventoryIdLocationsData, ThrowOnError>) => import("./client").RequestResult<Get202507InventoryLevelByInventoryIdLocationsResponses, Get202507InventoryLevelByInventoryIdLocationsErrors, ThrowOnError, "fields">;
|
|
283
|
+
/**
|
|
284
|
+
* Get Invoices
|
|
285
|
+
*
|
|
286
|
+
* Gets a paginated list of invoices, optionally filtered by invoice types and date range
|
|
287
|
+
*/
|
|
288
|
+
export declare const get202507Invoices: <ThrowOnError extends boolean = false>(options?: Options<Get202507InvoicesData, ThrowOnError>) => import("./client").RequestResult<Get202507InvoicesResponses, Get202507InvoicesErrors, ThrowOnError, "fields">;
|
|
289
|
+
/**
|
|
290
|
+
* Get transaction fees
|
|
291
|
+
*
|
|
292
|
+
*
|
|
293
|
+
* This endpoint returns a list of transaction fees
|
|
294
|
+
*
|
|
295
|
+
*/
|
|
296
|
+
export declare const get202507TransactionFees: <ThrowOnError extends boolean = false>(options?: Options<Get202507TransactionFeesData, ThrowOnError>) => import("./client").RequestResult<Get202507TransactionFeesResponses, Get202507TransactionFeesErrors, ThrowOnError, "fields">;
|
|
297
|
+
/**
|
|
298
|
+
* Search transactions
|
|
299
|
+
*
|
|
300
|
+
* Search transactions with filters (date, invoice, fee type, etc.)
|
|
301
|
+
*/
|
|
302
|
+
export declare const post202507TransactionsQuery: <ThrowOnError extends boolean = false>(options?: Options<Post202507TransactionsQueryData, ThrowOnError>) => import("./client").RequestResult<Post202507TransactionsQueryResponses, Post202507TransactionsQueryErrors, ThrowOnError, "fields">;
|
|
303
|
+
/**
|
|
304
|
+
* Get transactions by invoiceid
|
|
305
|
+
*
|
|
306
|
+
*
|
|
307
|
+
* The unique identifier of the invoice whose transactions are to be retrieved
|
|
308
|
+
*/
|
|
309
|
+
export declare const get202507InvoicesByInvoiceIdTransactions: <ThrowOnError extends boolean = false>(options: Options<Get202507InvoicesByInvoiceIdTransactionsData, ThrowOnError>) => import("./client").RequestResult<Get202507InvoicesByInvoiceIdTransactionsResponses, Get202507InvoicesByInvoiceIdTransactionsErrors, ThrowOnError, "fields">;
|
|
310
|
+
/**
|
|
311
|
+
* Cancel multiple Shipments by Shipment Id
|
|
312
|
+
*/
|
|
313
|
+
export declare const post202507ShipmentBatchCancel: <ThrowOnError extends boolean = false>(options: Options<Post202507ShipmentBatchCancelData, ThrowOnError>) => import("./client").RequestResult<Post202507ShipmentBatchCancelResponses, Post202507ShipmentBatchCancelErrors, ThrowOnError, "fields">;
|
|
314
|
+
/**
|
|
315
|
+
* Update Tracking Uploaded Status for Multiple Shipments by Shipment Id
|
|
316
|
+
*/
|
|
317
|
+
export declare const post202507ShipmentBatchUpdateTrackingUpload: <ThrowOnError extends boolean = false>(options?: Options<Post202507ShipmentBatchUpdateTrackingUploadData, ThrowOnError>) => import("./client").RequestResult<Post202507ShipmentBatchUpdateTrackingUploadResponses, Post202507ShipmentBatchUpdateTrackingUploadErrors, ThrowOnError, "fields">;
|
|
318
|
+
/**
|
|
319
|
+
* Get Order Store Json
|
|
320
|
+
*/
|
|
321
|
+
export declare const get202507OrderByOrderIdStoreOrderJson: <ThrowOnError extends boolean = false>(options: Options<Get202507OrderByOrderIdStoreOrderJsonData, ThrowOnError>) => import("./client").RequestResult<Get202507OrderByOrderIdStoreOrderJsonResponses, Get202507OrderByOrderIdStoreOrderJsonErrors, ThrowOnError, "fields">;
|
|
322
|
+
/**
|
|
323
|
+
* Save the Store Order Json
|
|
324
|
+
*/
|
|
325
|
+
export declare const post202507OrderByOrderIdStoreOrderJson: <ThrowOnError extends boolean = false>(options: Options<Post202507OrderByOrderIdStoreOrderJsonData, ThrowOnError>) => import("./client").RequestResult<Post202507OrderByOrderIdStoreOrderJsonResponses, Post202507OrderByOrderIdStoreOrderJsonErrors, ThrowOnError, "fields">;
|
|
326
|
+
/**
|
|
327
|
+
* Cancel single Order by Order ID
|
|
328
|
+
*/
|
|
329
|
+
export declare const post202507OrderByOrderIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202507OrderByOrderIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202507OrderByOrderIdCancelResponses, Post202507OrderByOrderIdCancelErrors, ThrowOnError, "fields">;
|
|
330
|
+
/**
|
|
331
|
+
* Estimate Fulfillment Cost For Order
|
|
332
|
+
*
|
|
333
|
+
* 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.
|
|
334
|
+
*/
|
|
335
|
+
export declare const post202507OrderEstimate: <ThrowOnError extends boolean = false>(options: Options<Post202507OrderEstimateData, ThrowOnError>) => import("./client").RequestResult<Post202507OrderEstimateResponses, Post202507OrderEstimateErrors, ThrowOnError, "fields">;
|
|
336
|
+
/**
|
|
337
|
+
* Cancel one Shipment by Order Id and Shipment Id
|
|
338
|
+
*/
|
|
339
|
+
export declare const post202507OrderByOrderIdShipmentByShipmentIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202507OrderByOrderIdShipmentByShipmentIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202507OrderByOrderIdShipmentByShipmentIdCancelResponses, Post202507OrderByOrderIdShipmentByShipmentIdCancelErrors, ThrowOnError, "fields">;
|
|
340
|
+
/**
|
|
341
|
+
* Get shipping methods
|
|
342
|
+
*
|
|
343
|
+
* Get all merchants shipping methods
|
|
344
|
+
*/
|
|
345
|
+
export declare const get202507ShippingMethod: <ThrowOnError extends boolean = false>(options?: Options<Get202507ShippingMethodData, ThrowOnError>) => import("./client").RequestResult<Get202507ShippingMethodResponses, Get202507ShippingMethodErrors, ThrowOnError, "fields">;
|
|
346
|
+
/**
|
|
347
|
+
* Cancel one Shipment by Shipment Id
|
|
348
|
+
*/
|
|
349
|
+
export declare const post202507ShipmentByShipmentIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202507ShipmentByShipmentIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202507ShipmentByShipmentIdCancelResponses, Post202507ShipmentByShipmentIdCancelErrors, ThrowOnError, "fields">;
|
|
350
|
+
/**
|
|
351
|
+
* Get Return Orders
|
|
352
|
+
*
|
|
353
|
+
*
|
|
354
|
+
* 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.
|
|
355
|
+
*
|
|
356
|
+
*/
|
|
357
|
+
export declare const get202507Return: <ThrowOnError extends boolean = false>(options?: Options<Get202507ReturnData, ThrowOnError>) => import("./client").RequestResult<Get202507ReturnResponses, Get202507ReturnErrors, ThrowOnError, "fields">;
|
|
358
|
+
/**
|
|
359
|
+
* Create Return Order
|
|
360
|
+
*
|
|
361
|
+
*
|
|
362
|
+
* Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.
|
|
363
|
+
*
|
|
364
|
+
*/
|
|
365
|
+
export declare const post202507Return: <ThrowOnError extends boolean = false>(options: Options<Post202507ReturnData, ThrowOnError>) => import("./client").RequestResult<Post202507ReturnResponses, Post202507ReturnErrors, ThrowOnError, "fields">;
|
|
366
|
+
/**
|
|
367
|
+
* Get Inventory Distributions by WRO ID
|
|
368
|
+
*
|
|
369
|
+
* Retrieves the distribution details for a specific receiving order within ShipBob's Inventory Placement Program (IPP).
|
|
370
|
+
* <Warning>This endpoint is available only to accounts enrolled in ShipBob's Inventory Placement Program (IPP).</Warning>
|
|
371
|
+
*/
|
|
372
|
+
export declare const get202507ReceivingByIdDistributions: <ThrowOnError extends boolean = false>(options: Options<Get202507ReceivingByIdDistributionsData, ThrowOnError>) => import("./client").RequestResult<Get202507ReceivingByIdDistributionsResponses, Get202507ReceivingByIdDistributionsErrors, ThrowOnError, "fields">;
|
|
373
|
+
/**
|
|
374
|
+
* Cancel Return order
|
|
375
|
+
*
|
|
376
|
+
*
|
|
377
|
+
* Cancels a return order for given return ID.
|
|
378
|
+
*
|
|
379
|
+
*/
|
|
380
|
+
export declare const post202507ReturnByIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202507ReturnByIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202507ReturnByIdCancelResponses, Post202507ReturnByIdCancelErrors, ThrowOnError, "fields">;
|