shipbob-node-sdk 0.0.16 → 0.0.18

package/dist/client/2026-01/sdk.gen.d.ts

@@ -0,0 +1,450 @@
+import type { Client, Options as Options2, TDataShape } from './client';
+import type { Delete202601ProductByProductIdData, Delete202601ProductByProductIdErrors, Delete202601ProductByProductIdResponses, Delete202601WebhookByIdData, Delete202601WebhookByIdErrors, Delete202601WebhookByIdResponses, Get202601ChannelData, Get202601ChannelErrors, Get202601ChannelResponses, Get202601FulfillmentCenterData, Get202601FulfillmentCenterErrors, Get202601FulfillmentCenterResponses, Get202601InventoryByInventoryIdData, Get202601InventoryByInventoryIdErrors, Get202601InventoryByInventoryIdResponses, Get202601InventoryData, Get202601InventoryErrors, Get202601InventoryLevelByInventoryIdData, Get202601InventoryLevelByInventoryIdErrors, Get202601InventoryLevelByInventoryIdLocationsData, Get202601InventoryLevelByInventoryIdLocationsErrors, Get202601InventoryLevelByInventoryIdLocationsResponses, Get202601InventoryLevelByInventoryIdLotsData, Get202601InventoryLevelByInventoryIdLotsErrors, Get202601InventoryLevelByInventoryIdLotsResponses, Get202601InventoryLevelByInventoryIdResponses, Get202601InventoryLevelData, Get202601InventoryLevelErrors, Get202601InventoryLevelLocationsData, Get202601InventoryLevelLocationsErrors, Get202601InventoryLevelLocationsResponses, Get202601InventoryLevelLotsData, Get202601InventoryLevelLotsErrors, Get202601InventoryLevelLotsResponses, Get202601InventoryLevelResponses, Get202601InventoryResponses, Get202601InvoicesByInvoiceIdTransactionsData, Get202601InvoicesByInvoiceIdTransactionsErrors, Get202601InvoicesByInvoiceIdTransactionsResponses, Get202601InvoicesData, Get202601InvoicesErrors, Get202601InvoicesResponses, Get202601LocationData, Get202601LocationErrors, Get202601LocationResponses, Get202601OrderByOrderIdData, Get202601OrderByOrderIdErrors, Get202601OrderByOrderIdResponses, Get202601OrderByOrderIdShipmentByShipmentIdData, Get202601OrderByOrderIdShipmentByShipmentIdErrors, Get202601OrderByOrderIdShipmentByShipmentIdLogsData, Get202601OrderByOrderIdShipmentByShipmentIdLogsErrors, Get202601OrderByOrderIdShipmentByShipmentIdLogsResponses, Get202601OrderByOrderIdShipmentByShipmentIdResponses, Get202601OrderByOrderIdShipmentByShipmentIdTimelineData, Get202601OrderByOrderIdShipmentByShipmentIdTimelineErrors, Get202601OrderByOrderIdShipmentByShipmentIdTimelineResponses, Get202601OrderByOrderIdShipmentData, Get202601OrderByOrderIdShipmentErrors, Get202601OrderByOrderIdShipmentResponses, Get202601OrderByOrderIdStoreOrderJsonData, Get202601OrderByOrderIdStoreOrderJsonErrors, Get202601OrderByOrderIdStoreOrderJsonResponses, Get202601OrderData, Get202601OrderErrors, Get202601OrderResponses, Get202601PackagingRequirementData, Get202601PackagingRequirementResponses, Get202601ProductByProductIdData, Get202601ProductByProductIdErrors, Get202601ProductByProductIdResponses, Get202601ProductByProductIdVariantsData, Get202601ProductByProductIdVariantsErrors, Get202601ProductByProductIdVariantsResponses, Get202601ProductData, Get202601ProductErrors, Get202601ProductResponses, Get202601ReceivingByIdBoxesData, Get202601ReceivingByIdBoxesErrors, Get202601ReceivingByIdBoxesResponses, Get202601ReceivingByIdData, Get202601ReceivingByIdDistributionsData, Get202601ReceivingByIdDistributionsErrors, Get202601ReceivingByIdDistributionsResponses, Get202601ReceivingByIdErrors, Get202601ReceivingByIdLabelsData, Get202601ReceivingByIdLabelsErrors, Get202601ReceivingByIdLabelsResponses, Get202601ReceivingByIdResponses, Get202601ReceivingData, Get202601ReceivingErrors, Get202601ReceivingResponses, Get202601ReturnByIdData, Get202601ReturnByIdErrors, Get202601ReturnByIdResponses, Get202601ReturnData, Get202601ReturnErrors, Get202601ReturnResponses, Get202601ShipmentByShipmentIdData, Get202601ShipmentByShipmentIdErrors, Get202601ShipmentByShipmentIdLogsData, Get202601ShipmentByShipmentIdLogsErrors, Get202601ShipmentByShipmentIdLogsResponses, Get202601ShipmentByShipmentIdResponses, Get202601ShipmentByShipmentIdTimelineData, Get202601ShipmentByShipmentIdTimelineErrors, Get202601ShipmentByShipmentIdTimelineResponses, Get202601ShippingMethodData, Get202601ShippingMethodErrors, Get202601ShippingMethodResponses, Get202601TaxonomyByIdData, Get202601TaxonomyByIdErrors, Get202601TaxonomyByIdParentData, Get202601TaxonomyByIdParentErrors, Get202601TaxonomyByIdParentResponses, Get202601TaxonomyByIdResponses, Get202601TaxonomyData, Get202601TaxonomyErrors, Get202601TaxonomyResponses, Get202601TransactionFeesData, Get202601TransactionFeesErrors, Get202601TransactionFeesResponses, Get202601WebhookData, Get202601WebhookErrors, Get202601WebhookResponses, Patch202601ProductByProductIdData, Patch202601ProductByProductIdResponses, Patch202601ProductByProductIdVariantsData, Patch202601ProductByProductIdVariantsResponses, Post202601InventoryHistoryQueryData, Post202601InventoryHistoryQueryResponses, Post202601OrderByOrderIdCancelData, Post202601OrderByOrderIdCancelErrors, Post202601OrderByOrderIdCancelResponses, Post202601OrderByOrderIdShipmentByShipmentIdCancelData, Post202601OrderByOrderIdShipmentByShipmentIdCancelErrors, Post202601OrderByOrderIdShipmentByShipmentIdCancelResponses, Post202601OrderData, Post202601OrderErrors, Post202601OrderEstimateData, Post202601OrderEstimateErrors, Post202601OrderEstimateResponses, Post202601OrderResponses, Post202601ProductByProductIdMoveVariantsData, Post202601ProductByProductIdMoveVariantsErrors, Post202601ProductByProductIdMoveVariantsResponses, Post202601ProductByProductIdVariantsData, Post202601ProductByProductIdVariantsResponses, Post202601ProductData, Post202601ProductMoveVariantsData, Post202601ProductMoveVariantsErrors, Post202601ProductMoveVariantsResponses, Post202601ProductResponses, Post202601ReceivingByIdCancelData, Post202601ReceivingByIdCancelErrors, Post202601ReceivingByIdCancelResponses, Post202601ReceivingData, Post202601ReceivingErrors, Post202601ReceivingResponses, Post202601ReceivingSetExternalSyncData, Post202601ReceivingSetExternalSyncErrors, Post202601ReceivingSetExternalSyncResponses, Post202601ReturnByIdCancelData, Post202601ReturnByIdCancelErrors, Post202601ReturnByIdCancelResponses, Post202601ReturnData, Post202601ReturnErrors, Post202601ReturnResponses, Post202601ShipmentBatchCancelData, Post202601ShipmentBatchCancelErrors, Post202601ShipmentBatchCancelResponses, Post202601ShipmentBatchUpdateTrackingUploadData, Post202601ShipmentBatchUpdateTrackingUploadErrors, Post202601ShipmentBatchUpdateTrackingUploadResponses, Post202601ShipmentByShipmentIdCancelData, Post202601ShipmentByShipmentIdCancelErrors, Post202601ShipmentByShipmentIdCancelResponses, Post202601TransactionsQueryData, Post202601TransactionsQueryErrors, Post202601TransactionsQueryResponses, Post202601VariantByVariantIdConvertToBundleData, Post202601VariantByVariantIdConvertToBundleResponses, Post202601VariantByVariantIdMergeData, Post202601VariantByVariantIdMergeResponses, Post202601WebhookData, Post202601WebhookErrors, Post202601WebhookResponses, Put202601ReturnByIdData, Put202601ReturnByIdErrors, Put202601ReturnByIdResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Get All Inventory Levels
+ *
+ * Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes.
+ */
+export declare const get202601InventoryLevel: <ThrowOnError extends boolean = false>(options?: Options<Get202601InventoryLevelData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryLevelResponses, Get202601InventoryLevelErrors, ThrowOnError, "fields">;
+/**
+ * Get Inventory Levels
+ *
+ * Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.
+ */
+export declare const get202601InventoryLevelByInventoryId: <ThrowOnError extends boolean = false>(options: Options<Get202601InventoryLevelByInventoryIdData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryLevelByInventoryIdResponses, Get202601InventoryLevelByInventoryIdErrors, ThrowOnError, "fields">;
+/**
+ * Get All Inventory Levels Grouped By Fulfillment Center
+ *
+ * Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes.
+ */
+export declare const get202601InventoryLevelLocations: <ThrowOnError extends boolean = false>(options?: Options<Get202601InventoryLevelLocationsData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryLevelLocationsResponses, Get202601InventoryLevelLocationsErrors, ThrowOnError, "fields">;
+/**
+ * Get Inventory
+ *
+ * Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata.
+ */
+export declare const get202601InventoryByInventoryId: <ThrowOnError extends boolean = false>(options: Options<Get202601InventoryByInventoryIdData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryByInventoryIdResponses, Get202601InventoryByInventoryIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Inventory Levels Grouped By Lot
+ *
+ * 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.
+ */
+export declare const get202601InventoryLevelByInventoryIdLots: <ThrowOnError extends boolean = false>(options: Options<Get202601InventoryLevelByInventoryIdLotsData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryLevelByInventoryIdLotsResponses, Get202601InventoryLevelByInventoryIdLotsErrors, ThrowOnError, "fields">;
+/**
+ * Get All Inventory Levels Grouped By Lot
+ *
+ * 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.
+ */
+export declare const get202601InventoryLevelLots: <ThrowOnError extends boolean = false>(options?: Options<Get202601InventoryLevelLotsData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryLevelLotsResponses, Get202601InventoryLevelLotsErrors, ThrowOnError, "fields">;
+/**
+ * Get Inventory Levels Grouped By Fulfillment Center
+ *
+ * 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.
+ */
+export declare const get202601InventoryLevelByInventoryIdLocations: <ThrowOnError extends boolean = false>(options: Options<Get202601InventoryLevelByInventoryIdLocationsData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryLevelByInventoryIdLocationsResponses, Get202601InventoryLevelByInventoryIdLocationsErrors, ThrowOnError, "fields">;
+/**
+ * Get All Inventories
+ *
+ * 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.
+ */
+export declare const get202601Inventory: <ThrowOnError extends boolean = false>(options?: Options<Get202601InventoryData, ThrowOnError>) => import("./client").RequestResult<Get202601InventoryResponses, Get202601InventoryErrors, ThrowOnError, "fields">;
+/**
+ * Get Return Order
+ *
+ *
+ * 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.
+ *
+ */
+export declare const get202601ReturnById: <ThrowOnError extends boolean = false>(options: Options<Get202601ReturnByIdData, ThrowOnError>) => import("./client").RequestResult<Get202601ReturnByIdResponses, Get202601ReturnByIdErrors, ThrowOnError, "fields">;
+/**
+ * Edit Return Order
+ *
+ *
+ * Updates an existing return using the provided request body and returns the updated return payload.
+ *
+ */
+export declare const put202601ReturnById: <ThrowOnError extends boolean = false>(options: Options<Put202601ReturnByIdData, ThrowOnError>) => import("./client").RequestResult<Put202601ReturnByIdResponses, Put202601ReturnByIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Taxonomy Parent
+ *
+ * Retrieves the parent taxonomy node for a given taxonomy ID.
+ */
+export declare const get202601TaxonomyByIdParent: <ThrowOnError extends boolean = false>(options: Options<Get202601TaxonomyByIdParentData, ThrowOnError>) => import("./client").RequestResult<Get202601TaxonomyByIdParentResponses, Get202601TaxonomyByIdParentErrors, ThrowOnError, "fields">;
+/**
+ * Move Variants Between Products
+ *
+ * Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.
+ */
+export declare const post202601ProductByProductIdMoveVariants: <ThrowOnError extends boolean = false>(options: Options<Post202601ProductByProductIdMoveVariantsData, ThrowOnError>) => import("./client").RequestResult<Post202601ProductByProductIdMoveVariantsResponses, Post202601ProductByProductIdMoveVariantsErrors, ThrowOnError, "fields">;
+/**
+ * Get Taxonomy by ID
+ *
+ * Retrieves a specific taxonomy node and its details by taxonomy ID.
+ */
+export declare const get202601TaxonomyById: <ThrowOnError extends boolean = false>(options: Options<Get202601TaxonomyByIdData, ThrowOnError>) => import("./client").RequestResult<Get202601TaxonomyByIdResponses, Get202601TaxonomyByIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Taxonomies
+ *
+ * Retrieves all available product taxonomies for categorizing products.
+ */
+export declare const get202601Taxonomy: <ThrowOnError extends boolean = false>(options?: Options<Get202601TaxonomyData, ThrowOnError>) => import("./client").RequestResult<Get202601TaxonomyResponses, Get202601TaxonomyErrors, ThrowOnError, "fields">;
+/**
+ * Convert Variant to Bundle
+ *
+ * Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.
+ */
+export declare const post202601VariantByVariantIdConvertToBundle: <ThrowOnError extends boolean = false>(options: Options<Post202601VariantByVariantIdConvertToBundleData, ThrowOnError>) => import("./client").RequestResult<Post202601VariantByVariantIdConvertToBundleResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Delete Product Bundle
+ *
+ * Deletes a bundle product by ID. Delete operation not allowed for non-bundles.
+ */
+export declare const delete202601ProductByProductId: <ThrowOnError extends boolean = false>(options: Options<Delete202601ProductByProductIdData, ThrowOnError>) => import("./client").RequestResult<Delete202601ProductByProductIdResponses, Delete202601ProductByProductIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Product
+ *
+ * Retrieves a product with all its variants and details.
+ */
+export declare const get202601ProductByProductId: <ThrowOnError extends boolean = false>(options: Options<Get202601ProductByProductIdData, ThrowOnError>) => import("./client").RequestResult<Get202601ProductByProductIdResponses, Get202601ProductByProductIdErrors, ThrowOnError, "fields">;
+/**
+ * Update Product
+ *
+ * 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.
+ */
+export declare const patch202601ProductByProductId: <ThrowOnError extends boolean = false>(options: Options<Patch202601ProductByProductIdData, ThrowOnError>) => import("./client").RequestResult<Patch202601ProductByProductIdResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Product Variants
+ *
+ * Retrieves all variants for a specific product.
+ */
+export declare const get202601ProductByProductIdVariants: <ThrowOnError extends boolean = false>(options: Options<Get202601ProductByProductIdVariantsData, ThrowOnError>) => import("./client").RequestResult<Get202601ProductByProductIdVariantsResponses, Get202601ProductByProductIdVariantsErrors, ThrowOnError, "fields">;
+/**
+ * Update Product Variants
+ *
+ * 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.
+ */
+export declare const patch202601ProductByProductIdVariants: <ThrowOnError extends boolean = false>(options: Options<Patch202601ProductByProductIdVariantsData, ThrowOnError>) => import("./client").RequestResult<Patch202601ProductByProductIdVariantsResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Add Product Variants
+ *
+ * Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.
+ */
+export declare const post202601ProductByProductIdVariants: <ThrowOnError extends boolean = false>(options: Options<Post202601ProductByProductIdVariantsData, ThrowOnError>) => import("./client").RequestResult<Post202601ProductByProductIdVariantsResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Packaging Requirement
+ *
+ * Retrieves all available packaging requirements that can be assigned to a product.
+ */
+export declare const get202601PackagingRequirement: <ThrowOnError extends boolean = false>(options?: Options<Get202601PackagingRequirementData, ThrowOnError>) => import("./client").RequestResult<Get202601PackagingRequirementResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Products
+ *
+ * Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.
+ */
+export declare const get202601Product: <ThrowOnError extends boolean = false>(options?: Options<Get202601ProductData, ThrowOnError>) => import("./client").RequestResult<Get202601ProductResponses, Get202601ProductErrors, ThrowOnError, "fields">;
+/**
+ * Create Product
+ *
+ * Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.
+ */
+export declare const post202601Product: <ThrowOnError extends boolean = false>(options?: Options<Post202601ProductData, ThrowOnError>) => import("./client").RequestResult<Post202601ProductResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Move Variants to New Product
+ *
+ * Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.
+ */
+export declare const post202601ProductMoveVariants: <ThrowOnError extends boolean = false>(options?: Options<Post202601ProductMoveVariantsData, ThrowOnError>) => import("./client").RequestResult<Post202601ProductMoveVariantsResponses, Post202601ProductMoveVariantsErrors, ThrowOnError, "fields">;
+/**
+ * Merge Variants
+ *
+ * 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.
+ */
+export declare const post202601VariantByVariantIdMerge: <ThrowOnError extends boolean = false>(options: Options<Post202601VariantByVariantIdMergeData, ThrowOnError>) => import("./client").RequestResult<Post202601VariantByVariantIdMergeResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Channels
+ *
+ * Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.
+ *
+ */
+export declare const get202601Channel: <ThrowOnError extends boolean = false>(options?: Options<Get202601ChannelData, ThrowOnError>) => import("./client").RequestResult<Get202601ChannelResponses, Get202601ChannelErrors, ThrowOnError, "fields">;
+/**
+ * Get Subscriptions
+ *
+ *
+ *   This endpoint returns a list of webhook subscriptions.
+ *
+ */
+export declare const get202601Webhook: <ThrowOnError extends boolean = false>(options?: Options<Get202601WebhookData, ThrowOnError>) => import("./client").RequestResult<Get202601WebhookResponses, Get202601WebhookErrors, ThrowOnError, "fields">;
+/**
+ * Create Subscription
+ *
+ *
+ * This endpoint creates a new webhook subscription.
+ *
+ */
+export declare const post202601Webhook: <ThrowOnError extends boolean = false>(options?: Options<Post202601WebhookData, ThrowOnError>) => import("./client").RequestResult<Post202601WebhookResponses, Post202601WebhookErrors, ThrowOnError, "fields">;
+/**
+ * Delete Subscription
+ *
+ *
+ *   This endpoint deletes a webhook subscription.
+ *
+ */
+export declare const delete202601WebhookById: <ThrowOnError extends boolean = false>(options: Options<Delete202601WebhookByIdData, ThrowOnError>) => import("./client").RequestResult<Delete202601WebhookByIdResponses, Delete202601WebhookByIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Invoices
+ *
+ * Gets a paginated list of invoices, optionally filtered by invoice types and date range
+ */
+export declare const get202601Invoices: <ThrowOnError extends boolean = false>(options?: Options<Get202601InvoicesData, ThrowOnError>) => import("./client").RequestResult<Get202601InvoicesResponses, Get202601InvoicesErrors, ThrowOnError, "fields">;
+/**
+ * Get Transaction Fees
+ *
+ *
+ * This endpoint returns a list of transaction fees
+ *
+ */
+export declare const get202601TransactionFees: <ThrowOnError extends boolean = false>(options?: Options<Get202601TransactionFeesData, ThrowOnError>) => import("./client").RequestResult<Get202601TransactionFeesResponses, Get202601TransactionFeesErrors, ThrowOnError, "fields">;
+/**
+ * Get Transactions by Invoice ID
+ *
+ *
+ * The unique identifier of the invoice whose transactions are to be retrieved
+ */
+export declare const get202601InvoicesByInvoiceIdTransactions: <ThrowOnError extends boolean = false>(options: Options<Get202601InvoicesByInvoiceIdTransactionsData, ThrowOnError>) => import("./client").RequestResult<Get202601InvoicesByInvoiceIdTransactionsResponses, Get202601InvoicesByInvoiceIdTransactionsErrors, ThrowOnError, "fields">;
+/**
+ * Search Transactions
+ *
+ * Search transactions with filters (date, invoice, fee type, etc.)
+ */
+export declare const post202601TransactionsQuery: <ThrowOnError extends boolean = false>(options?: Options<Post202601TransactionsQueryData, ThrowOnError>) => import("./client").RequestResult<Post202601TransactionsQueryResponses, Post202601TransactionsQueryErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Return order
+ *
+ *
+ * Cancels a return order for given return ID.
+ *
+ */
+export declare const post202601ReturnByIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202601ReturnByIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202601ReturnByIdCancelResponses, Post202601ReturnByIdCancelErrors, ThrowOnError, "fields">;
+/**
+ * Get Return Orders
+ *
+ *
+ * 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.
+ *
+ */
+export declare const get202601Return: <ThrowOnError extends boolean = false>(options?: Options<Get202601ReturnData, ThrowOnError>) => import("./client").RequestResult<Get202601ReturnResponses, Get202601ReturnErrors, ThrowOnError, "fields">;
+/**
+ * Create Return Order
+ *
+ *
+ * Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.
+ *
+ */
+export declare const post202601Return: <ThrowOnError extends boolean = false>(options: Options<Post202601ReturnData, ThrowOnError>) => import("./client").RequestResult<Post202601ReturnResponses, Post202601ReturnErrors, ThrowOnError, "fields">;
+/**
+ * Get Locations
+ *
+ * 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.
+ */
+export declare const get202601Location: <ThrowOnError extends boolean = false>(options?: Options<Get202601LocationData, ThrowOnError>) => import("./client").RequestResult<Get202601LocationResponses, Get202601LocationErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipping Methods
+ *
+ * Retrieves all available shipping methods configured for your merchant account.
+ */
+export declare const get202601ShippingMethod: <ThrowOnError extends boolean = false>(options?: Options<Get202601ShippingMethodData, ThrowOnError>) => import("./client").RequestResult<Get202601ShippingMethodResponses, Get202601ShippingMethodErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipment
+ *
+ * Retrieves detailed information about a specific shipment by shipment ID, including shipment status, tracking information, fulfillment center location, and contained products.
+ */
+export declare const get202601ShipmentByShipmentId: <ThrowOnError extends boolean = false>(options: Options<Get202601ShipmentByShipmentIdData, ThrowOnError>) => import("./client").RequestResult<Get202601ShipmentByShipmentIdResponses, Get202601ShipmentByShipmentIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipment Status Timeline by Order ID and Shipment ID
+ *
+ * Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.
+ */
+export declare const get202601OrderByOrderIdShipmentByShipmentIdTimeline: <ThrowOnError extends boolean = false>(options: Options<Get202601OrderByOrderIdShipmentByShipmentIdTimelineData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderByOrderIdShipmentByShipmentIdTimelineResponses, Get202601OrderByOrderIdShipmentByShipmentIdTimelineErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Shipment
+ *
+ * Cancels a specific shipment by shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.
+ */
+export declare const post202601ShipmentByShipmentIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202601ShipmentByShipmentIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202601ShipmentByShipmentIdCancelResponses, Post202601ShipmentByShipmentIdCancelErrors, ThrowOnError, "fields">;
+/**
+ * Get All Shipments for Order
+ *
+ * Retrieves all shipments associated with a specific order, including shipment status, tracking information, and product details.
+ */
+export declare const get202601OrderByOrderIdShipment: <ThrowOnError extends boolean = false>(options: Options<Get202601OrderByOrderIdShipmentData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderByOrderIdShipmentResponses, Get202601OrderByOrderIdShipmentErrors, ThrowOnError, "fields">;
+/**
+ * Batch Cancel Shipments
+ *
+ * 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).
+ */
+export declare const post202601ShipmentBatchCancel: <ThrowOnError extends boolean = false>(options: Options<Post202601ShipmentBatchCancelData, ThrowOnError>) => import("./client").RequestResult<Post202601ShipmentBatchCancelResponses, Post202601ShipmentBatchCancelErrors, ThrowOnError, "fields">;
+/**
+ * Get Orders
+ *
+ * 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.
+ */
+export declare const get202601Order: <ThrowOnError extends boolean = false>(options?: Options<Get202601OrderData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderResponses, Get202601OrderErrors, ThrowOnError, "fields">;
+/**
+ * Create Order
+ *
+ * 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.
+ */
+export declare const post202601Order: <ThrowOnError extends boolean = false>(options: Options<Post202601OrderData, ThrowOnError>) => import("./client").RequestResult<Post202601OrderResponses, Post202601OrderErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Order
+ *
+ * Cancels an order and all associated shipments. The order must be in a cancellable state to proceed with the cancellation.
+ */
+export declare const post202601OrderByOrderIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202601OrderByOrderIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202601OrderByOrderIdCancelResponses, Post202601OrderByOrderIdCancelErrors, ThrowOnError, "fields">;
+/**
+ * Estimate Fulfillment Cost For Order
+ *
+ * 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.
+ */
+export declare const post202601OrderEstimate: <ThrowOnError extends boolean = false>(options: Options<Post202601OrderEstimateData, ThrowOnError>) => import("./client").RequestResult<Post202601OrderEstimateResponses, Post202601OrderEstimateErrors, ThrowOnError, "fields">;
+/**
+ * Get Order Store Data
+ *
+ * Retrieves the original store order data associated with the order in JSON format, preserving custom fields and metadata from the order source.
+ */
+export declare const get202601OrderByOrderIdStoreOrderJson: <ThrowOnError extends boolean = false>(options: Options<Get202601OrderByOrderIdStoreOrderJsonData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderByOrderIdStoreOrderJsonResponses, Get202601OrderByOrderIdStoreOrderJsonErrors, ThrowOnError, "fields">;
+/**
+ * Mark Tracking Uploaded
+ *
+ * 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.
+ *
+ * <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>
+ */
+export declare const post202601ShipmentBatchUpdateTrackingUpload: <ThrowOnError extends boolean = false>(options?: Options<Post202601ShipmentBatchUpdateTrackingUploadData, ThrowOnError>) => import("./client").RequestResult<Post202601ShipmentBatchUpdateTrackingUploadResponses, Post202601ShipmentBatchUpdateTrackingUploadErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipment Logs
+ *
+ * Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.
+ */
+export declare const get202601ShipmentByShipmentIdLogs: <ThrowOnError extends boolean = false>(options: Options<Get202601ShipmentByShipmentIdLogsData, ThrowOnError>) => import("./client").RequestResult<Get202601ShipmentByShipmentIdLogsResponses, Get202601ShipmentByShipmentIdLogsErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipment by Order ID and Shipment ID
+ *
+ * Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.
+ */
+export declare const get202601OrderByOrderIdShipmentByShipmentId: <ThrowOnError extends boolean = false>(options: Options<Get202601OrderByOrderIdShipmentByShipmentIdData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderByOrderIdShipmentByShipmentIdResponses, Get202601OrderByOrderIdShipmentByShipmentIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Order
+ *
+ * Retrieves detailed information about a specific order by its order ID, including order status, shipments, products, and recipient details.
+ */
+export declare const get202601OrderByOrderId: <ThrowOnError extends boolean = false>(options: Options<Get202601OrderByOrderIdData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderByOrderIdResponses, Get202601OrderByOrderIdErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Shipment by Order ID and Shipment ID
+ *
+ * Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.
+ */
+export declare const post202601OrderByOrderIdShipmentByShipmentIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202601OrderByOrderIdShipmentByShipmentIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202601OrderByOrderIdShipmentByShipmentIdCancelResponses, Post202601OrderByOrderIdShipmentByShipmentIdCancelErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipment Timeline
+ *
+ * Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.
+ */
+export declare const get202601ShipmentByShipmentIdTimeline: <ThrowOnError extends boolean = false>(options: Options<Get202601ShipmentByShipmentIdTimelineData, ThrowOnError>) => import("./client").RequestResult<Get202601ShipmentByShipmentIdTimelineResponses, Get202601ShipmentByShipmentIdTimelineErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipment Logs by Order ID and Shipment ID
+ *
+ * Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.
+ */
+export declare const get202601OrderByOrderIdShipmentByShipmentIdLogs: <ThrowOnError extends boolean = false>(options: Options<Get202601OrderByOrderIdShipmentByShipmentIdLogsData, ThrowOnError>) => import("./client").RequestResult<Get202601OrderByOrderIdShipmentByShipmentIdLogsResponses, Get202601OrderByOrderIdShipmentByShipmentIdLogsErrors, ThrowOnError, "fields">;
+/**
+ * Set ExternalSync flag for Wros
+ *
+ *
+ * Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.
+ *
+ */
+export declare const post202601ReceivingSetExternalSync: <ThrowOnError extends boolean = false>(options?: Options<Post202601ReceivingSetExternalSyncData, ThrowOnError>) => import("./client").RequestResult<Post202601ReceivingSetExternalSyncResponses, Post202601ReceivingSetExternalSyncErrors, ThrowOnError, "fields">;
+/**
+ * Get Fulfillment Centers
+ *
+ *
+ * Returns a list of ShipBob fulfillment centers where inventory can be received.
+ *
+ */
+export declare const get202601FulfillmentCenter: <ThrowOnError extends boolean = false>(options?: Options<Get202601FulfillmentCenterData, ThrowOnError>) => import("./client").RequestResult<Get202601FulfillmentCenterResponses, Get202601FulfillmentCenterErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Warehouse Receiving Order
+ *
+ *
+ * Cancels an existing warehouse receiving order. Only orders in certain statuses can be cancelled.
+ *
+ */
+export declare const post202601ReceivingByIdCancel: <ThrowOnError extends boolean = false>(options: Options<Post202601ReceivingByIdCancelData, ThrowOnError>) => import("./client").RequestResult<Post202601ReceivingByIdCancelResponses, Post202601ReceivingByIdCancelErrors, ThrowOnError, "fields">;
+/**
+ * Get Multiple Warehouse Receiving Orders
+ *
+ *
+ * Returns a list of warehouse receiving orders with optional filtering by status, fulfillment center, purchase order number, and date range.
+ *
+ */
+export declare const get202601Receiving: <ThrowOnError extends boolean = false>(options?: Options<Get202601ReceivingData, ThrowOnError>) => import("./client").RequestResult<Get202601ReceivingResponses, Get202601ReceivingErrors, ThrowOnError, "fields">;
+/**
+ * Create Warehouse Receiving Order
+ *
+ *
+ * Creates a new warehouse receiving order with specified fulfillment center, boxes, and inventory items.
+ *
+ */
+export declare const post202601Receiving: <ThrowOnError extends boolean = false>(options?: Options<Post202601ReceivingData, ThrowOnError>) => import("./client").RequestResult<Post202601ReceivingResponses, Post202601ReceivingErrors, ThrowOnError, "fields">;
+/**
+ * Get Warehouse Receiving Order Boxes
+ *
+ *
+ * Returns the boxes and their contents for a specific warehouse receiving order.
+ *
+ */
+export declare const get202601ReceivingByIdBoxes: <ThrowOnError extends boolean = false>(options: Options<Get202601ReceivingByIdBoxesData, ThrowOnError>) => import("./client").RequestResult<Get202601ReceivingByIdBoxesResponses, Get202601ReceivingByIdBoxesErrors, ThrowOnError, "fields">;
+/**
+ * Get Warehouse Receiving Order Box Labels
+ *
+ *
+ * Returns a PDF containing box labels for a specific warehouse receiving order.
+ *
+ */
+export declare const get202601ReceivingByIdLabels: <ThrowOnError extends boolean = false>(options: Options<Get202601ReceivingByIdLabelsData, ThrowOnError>) => import("./client").RequestResult<Get202601ReceivingByIdLabelsResponses, Get202601ReceivingByIdLabelsErrors, ThrowOnError, "fields">;
+/**
+ * Get Warehouse Receiving Order
+ *
+ *
+ * Returns details of a specific warehouse receiving order by ID.
+ *
+ */
+export declare const get202601ReceivingById: <ThrowOnError extends boolean = false>(options: Options<Get202601ReceivingByIdData, ThrowOnError>) => import("./client").RequestResult<Get202601ReceivingByIdResponses, Get202601ReceivingByIdErrors, ThrowOnError, "fields">;
+/**
+ * Query Inventory History Events
+ *
+ * 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.
+ */
+export declare const post202601InventoryHistoryQuery: <ThrowOnError extends boolean = false>(options?: Options<Post202601InventoryHistoryQueryData, ThrowOnError>) => import("./client").RequestResult<Post202601InventoryHistoryQueryResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Inventory Distributions by WRO ID
+ *
+ * Retrieves the distribution details for a specific receiving order within ShipBob's Inventory Placement Program (IPP).
+ * <Warning>This endpoint is available only to accounts enrolled in ShipBob's Inventory Placement Program (IPP).</Warning>
+ */
+export declare const get202601ReceivingByIdDistributions: <ThrowOnError extends boolean = false>(options: Options<Get202601ReceivingByIdDistributionsData, ThrowOnError>) => import("./client").RequestResult<Get202601ReceivingByIdDistributionsResponses, Get202601ReceivingByIdDistributionsErrors, ThrowOnError, "fields">;