# SKULabs API Documentation

## Docs

- [Batch - Get](https://skulabs.mintlify.app/api-docs/batch/get.md): Retrieve batch details by ID, including orders and fulfillment progress.
- [Customer - Add Note](https://skulabs.mintlify.app/api-docs/customer/add-note.md): Add a note to a customer record.
- [Customer - Add Tag](https://skulabs.mintlify.app/api-docs/customer/add-tag.md): Add a tag to one or more customers.
- [Customer - Get Customer](https://skulabs.mintlify.app/api-docs/customer/get-customer.md): Retrieve a single customer by ID with full details including notes and activity log.
- [Customer - Get Customers](https://skulabs.mintlify.app/api-docs/customer/get-customers.md): Retrieve a paginated list of customers with optional filtering.
- [Customer - Remove Tag](https://skulabs.mintlify.app/api-docs/customer/remove-tag.md): Remove a tag from one or more customers.
- [Cycle Count - Get](https://skulabs.mintlify.app/api-docs/cycle-count/get.md): Retrieve a single cycle count by ID with its item details.
- [Cycle Count - Get All](https://skulabs.mintlify.app/api-docs/cycle-count/get-all.md): Retrieve all cycle counts with optional filtering by status and warehouse.
- [Distributor - Add Item](https://skulabs.mintlify.app/api-docs/distributor/add-item.md): Add an item to a distributor's catalog with supplier-specific SKU, cost, and lead time.
- [Distributor - Bulk Remove Item](https://skulabs.mintlify.app/api-docs/distributor/bulk-remove-item.md): Remove multiple items from a distributor's catalog in a single request.
- [Distributor - Create](https://skulabs.mintlify.app/api-docs/distributor/create.md): Create a new distributor with contact details and address.
- [Distributor - Edit Item](https://skulabs.mintlify.app/api-docs/distributor/edit-item.md): Update an item's details in a distributor's catalog.
- [Distributor - Get](https://skulabs.mintlify.app/api-docs/distributor/get.md): Retrieve a paginated list of distributors (suppliers/vendors).
- [Distributor - Remove Item](https://skulabs.mintlify.app/api-docs/distributor/remove-item.md): Remove an item from a distributor's catalog.
- [Distributor - Update](https://skulabs.mintlify.app/api-docs/distributor/update.md): Update an existing distributor's information.
- [Inventory Table - Export Velocity](https://skulabs.mintlify.app/api-docs/inventory-table/export-velocity.md): Export inventory velocity data (sales speed analysis) as a downloadable report.
- [Inventory - Bulk Reconciliation](https://skulabs.mintlify.app/api-docs/inventory/bulk-reconciliation.md): Reconcile inventory quantities in bulk, adjusting on-hand counts to match physical counts.
- [Inventory - Calculate Free Map](https://skulabs.mintlify.app/api-docs/inventory/calculate-free-map.md): Calculate available inventory by subtracting reserved quantities from on-hand stock.
- [Inventory - Decrease On Hand](https://skulabs.mintlify.app/api-docs/inventory/decrease-on-hand.md): Decrease the on-hand inventory quantity for an item at a specific warehouse.
- [Inventory - Deduct Serial Numbers](https://skulabs.mintlify.app/api-docs/inventory/deduct-serial-numbers.md): Deduct serial numbers from inventory, marking them as used or shipped.
- [Inventory - Get](https://skulabs.mintlify.app/api-docs/inventory/get.md): Retrieve inventory records for items and kits across warehouses.
- [Inventory - Get Grouped Locations Map](https://skulabs.mintlify.app/api-docs/inventory/get-grouped-locations-map.md): Retrieve inventory quantities grouped by location across warehouses.
- [Inventory - Get History](https://skulabs.mintlify.app/api-docs/inventory/get-history.md): Retrieve the inventory change history for a specific item at a warehouse.
- [Inventory - Get Inventory History](https://skulabs.mintlify.app/api-docs/inventory/get-inventory-history.md): Retrieve detailed inventory history with change types, quantities, and timestamps.
- [Inventory - Get Item Free](https://skulabs.mintlify.app/api-docs/inventory/get-item-free.md): Retrieve the available (free) inventory quantity for an item, excluding reserved stock.
- [Inventory - Get Items](https://skulabs.mintlify.app/api-docs/inventory/get-items.md): Retrieve inventory records for a specific list of item IDs.
- [Inventory - Get Items And Kits Map](https://skulabs.mintlify.app/api-docs/inventory/get-items-and-kits-map.md): Retrieve a combined map of both item and kit inventory quantities.
- [Inventory - Get Items Incoming](https://skulabs.mintlify.app/api-docs/inventory/get-items-incoming.md): Retrieve incoming inventory quantities from open purchase orders.
- [Inventory - Get Items Map](https://skulabs.mintlify.app/api-docs/inventory/get-items-map.md): Retrieve a map of item inventory quantities keyed by item ID and warehouse.
- [Inventory - Get Kits Map](https://skulabs.mintlify.app/api-docs/inventory/get-kits-map.md): Retrieve a map of kit inventory quantities keyed by kit ID and warehouse.
- [Inventory - Get On Hand Location Map](https://skulabs.mintlify.app/api-docs/inventory/get-on-hand-location-map.md): Retrieve on-hand inventory quantities broken down by warehouse location.
- [Inventory - Get Received History](https://skulabs.mintlify.app/api-docs/inventory/get-received-history.md): Retrieve the history of inventory received through purchase orders.
- [Inventory - Get Reserved Map](https://skulabs.mintlify.app/api-docs/inventory/get-reserved-map.md): Retrieve a map of reserved inventory quantities per item across warehouses.
- [Inventory - Get Via Post Reserved Map](https://skulabs.mintlify.app/api-docs/inventory/get-via-post-reserved-map.md): Retrieve reserved inventory map via POST for large item ID lists that exceed GET URL limits.
- [Inventory - Increase On Hand](https://skulabs.mintlify.app/api-docs/inventory/increase-on-hand.md): Increase the on-hand inventory quantity for an item at a specific warehouse.
- [Inventory - Upsert](https://skulabs.mintlify.app/api-docs/inventory/upsert.md): Create or update an inventory record for an item at a specific warehouse.
- [Item - Add Barcode](https://skulabs.mintlify.app/api-docs/item/add-barcode.md): Add a barcode to an existing item.
- [Item - Add Custom Field](https://skulabs.mintlify.app/api-docs/item/add-custom-field.md): Add a custom field key-value pair to an item.
- [Item - Add Serial Numbers](https://skulabs.mintlify.app/api-docs/item/add-serial-numbers.md): Add serial numbers to an item's inventory at a specific warehouse.
- [Item - Add Tag](https://skulabs.mintlify.app/api-docs/item/add-tag.md): Add a tag to one or more items by tag ID.
- [Item - Bulk Assign](https://skulabs.mintlify.app/api-docs/item/bulk-assign.md): Assign items to a warehouse location in bulk. If the location does not exist, it will be created.
- [Item - Bulk Remove](https://skulabs.mintlify.app/api-docs/item/bulk-remove.md): Remove multiple items in a single bulk operation.
- [Item - Bulk Upsert](https://skulabs.mintlify.app/api-docs/item/bulk-upsert.md): Create or update multiple items in a single request.
- [Item - Create](https://skulabs.mintlify.app/api-docs/item/create.md): Create a new item with SKU, name, and optional details like barcodes and dimensions.
- [Item - Create Upsert](https://skulabs.mintlify.app/api-docs/item/create-upsert.md): Create a new item or update an existing one if the SKU already exists.
- [Item - Find By Barcode](https://skulabs.mintlify.app/api-docs/item/find-by-barcode.md): Look up an item by its barcode (UPC, EAN, ISBN, or custom barcode).
- [Item - Get](https://skulabs.mintlify.app/api-docs/item/get.md): Retrieve a paginated list of items with optional filtering.
- [Item - Get Locations](https://skulabs.mintlify.app/api-docs/item/get-locations.md): Retrieve warehouse locations assigned to an item.
- [Item - New Remove Serial Number](https://skulabs.mintlify.app/api-docs/item/new-remove-serial-number.md): Remove a serial number from an item using the updated removal method.
- [Item - Remove](https://skulabs.mintlify.app/api-docs/item/remove.md): Permanently delete an item and its associated inventory records.
- [Item - Remove Barcode](https://skulabs.mintlify.app/api-docs/item/remove-barcode.md): Remove a barcode from an item.
- [Item - Remove Custom Field](https://skulabs.mintlify.app/api-docs/item/remove-custom-field.md): Remove a custom field from an item.
- [Item - Remove Serial Number](https://skulabs.mintlify.app/api-docs/item/remove-serial-number.md): Remove a serial number from an item's inventory.
- [Item - Remove Tag](https://skulabs.mintlify.app/api-docs/item/remove-tag.md): Remove a tag from one or more items.
- [Item - Set Tags](https://skulabs.mintlify.app/api-docs/item/set-tags.md): Replace all tags on one or more items with a new set of tags.
- [Item - Update](https://skulabs.mintlify.app/api-docs/item/update.md): Update an existing item's properties such as name, weight, dimensions, or cost.
- [Item - Update Alias Locations](https://skulabs.mintlify.app/api-docs/item/update-alias-locations.md): Update the alias location mappings for an item across warehouses.
- [Item - Upsert](https://skulabs.mintlify.app/api-docs/item/upsert.md): Create a new item or update an existing one based on the provided identifier.
- [Kit - Add Barcode](https://skulabs.mintlify.app/api-docs/kit/add-barcode.md): Add a barcode to an existing kit.
- [Kit - Add Custom Field](https://skulabs.mintlify.app/api-docs/kit/add-custom-field.md): Add a custom field key-value pair to a kit.
- [Kit - Add Item](https://skulabs.mintlify.app/api-docs/kit/add-item.md): Add a component item to an existing kit.
- [Kit - Add Tag](https://skulabs.mintlify.app/api-docs/kit/add-tag.md): Add a tag to one or more kits by tag ID.
- [Kit - Bulk Update](https://skulabs.mintlify.app/api-docs/kit/bulk-update.md): Update multiple kits in a single request.
- [Kit - Create](https://skulabs.mintlify.app/api-docs/kit/create.md): Create a new kit with component items, SKU, and optional details.
- [Kit - Edit Item](https://skulabs.mintlify.app/api-docs/kit/edit-item.md): Edit a component item's quantity or properties within a kit.
- [Kit - Get](https://skulabs.mintlify.app/api-docs/kit/get.md): Retrieve a paginated list of kits with optional filtering.
- [Kit - Remove](https://skulabs.mintlify.app/api-docs/kit/remove.md): Permanently delete a kit.
- [Kit - Remove Barcode](https://skulabs.mintlify.app/api-docs/kit/remove-barcode.md): Remove a barcode from a kit.
- [Kit - Remove Custom Field](https://skulabs.mintlify.app/api-docs/kit/remove-custom-field.md): Remove a custom field from a kit.
- [Kit - Remove Item](https://skulabs.mintlify.app/api-docs/kit/remove-item.md): Remove a component item from a kit.
- [Kit - Remove Tag](https://skulabs.mintlify.app/api-docs/kit/remove-tag.md): Remove a tag from one or more kits.
- [Kit - Set Tags](https://skulabs.mintlify.app/api-docs/kit/set-tags.md): Replace all tags on one or more kits with a new set of tags.
- [Kit - Update](https://skulabs.mintlify.app/api-docs/kit/update.md): Update an existing kit's properties such as name, weight, or component items.
- [Listing - Get](https://skulabs.mintlify.app/api-docs/listing/get.md): Retrieve product listings with optional filtering by store and linked item status.
- [Listing - Listing Links Csv Import](https://skulabs.mintlify.app/api-docs/listing/listing-links-csv-import.md): Import listing-to-item links from a CSV file.
- [Listing - Rules Csv Import](https://skulabs.mintlify.app/api-docs/listing/rules-csv-import.md): Import listing rules from a CSV file.
- [Location - Add Item](https://skulabs.mintlify.app/api-docs/location/add-item.md): Assign an item to a warehouse location.
- [Location - Create](https://skulabs.mintlify.app/api-docs/location/create.md): Create a new location within a warehouse (e.g. bin, shelf, or zone).
- [Location - Get](https://skulabs.mintlify.app/api-docs/location/get.md): Retrieve a single warehouse location by ID.
- [Location - Get All](https://skulabs.mintlify.app/api-docs/location/get-all.md): Retrieve all locations for a specific warehouse.
- [Location - Get Items](https://skulabs.mintlify.app/api-docs/location/get-items.md): Retrieve all items assigned to a specific warehouse location.
- [Location - Get List](https://skulabs.mintlify.app/api-docs/location/get-list.md): Retrieve a paginated list of locations with optional filtering.
- [Location - Remove Item](https://skulabs.mintlify.app/api-docs/location/remove-item.md): Remove an item from a warehouse location assignment.
- [Order - Add](https://skulabs.mintlify.app/api-docs/order/add.md): Create a new manual order with specified items, shipping address, and order details.
- [Order - Add Manual Shipment](https://skulabs.mintlify.app/api-docs/order/add-manual-shipment.md): Add a manual shipment with tracking information to an order.
- [Order - Add Note](https://skulabs.mintlify.app/api-docs/order/add-note.md): Add an internal or customer-facing note to an order.
- [Order - Add Tag](https://skulabs.mintlify.app/api-docs/order/add-tag.md): Add a tag to one or more orders by tag ID.
- [Order - Add Tag By Name](https://skulabs.mintlify.app/api-docs/order/add-tag-by-name.md): Add a tag to one or more orders by tag name, creating the tag if it doesn't exist.
- [Order - Bulk Add Manual Shipments](https://skulabs.mintlify.app/api-docs/order/bulk-add-manual-shipments.md): Add manual shipments with tracking information to multiple orders in a single request.
- [Order - Get](https://skulabs.mintlify.app/api-docs/order/get.md): Retrieve a paginated list of orders with optional filtering by status, store, tags, and date ranges. Maximum page size: 100 (Standard), 250 (Pro), 500 (Enterprise).
- [Order - Get All](https://skulabs.mintlify.app/api-docs/order/get-all.md): Retrieve all orders without pagination. Use with caution on large datasets.
- [Order - Get Archived](https://skulabs.mintlify.app/api-docs/order/get-archived.md): Retrieve archived orders with optional filtering.
- [Order - Get By Base Order Number](https://skulabs.mintlify.app/api-docs/order/get-by-base-order-number.md): Look up orders by their base order number, which groups split and combined orders.
- [Order - Get Customs Information](https://skulabs.mintlify.app/api-docs/order/get-customs-information.md): Retrieve customs declaration information for an order's items.
- [Order - Get Scanned Serial Numbers](https://skulabs.mintlify.app/api-docs/order/get-scanned-serial-numbers.md): Retrieve serial numbers that have been scanned during order fulfillment.
- [Order - Get Shipped](https://skulabs.mintlify.app/api-docs/order/get-shipped.md): Retrieve shipped orders with optional filtering by date range and store.
- [Order - Get Single](https://skulabs.mintlify.app/api-docs/order/get-single.md): Retrieve a single order by its order number and store ID.
- [Order - Get Single Bulk](https://skulabs.mintlify.app/api-docs/order/get-single-bulk.md): Retrieve multiple orders by their order number and store ID pairs in a single request.
- [Order - Get Skipped Scans](https://skulabs.mintlify.app/api-docs/order/get-skipped-scans.md): Retrieve items that were skipped during barcode scanning in order fulfillment.
- [Order - Get Unscanned Items](https://skulabs.mintlify.app/api-docs/order/get-unscanned-items.md): Retrieve items that have not been scanned during order fulfillment.
- [Order - Modify Financial Status](https://skulabs.mintlify.app/api-docs/order/modify-financial-status.md): Update the financial/payment status of one or more orders.
- [Order - Modify Status](https://skulabs.mintlify.app/api-docs/order/modify-status.md): Update the fulfillment status of one or more orders.
- [Order - Override](https://skulabs.mintlify.app/api-docs/order/override.md): Override order fields with custom values.
- [Order - Remove Tag](https://skulabs.mintlify.app/api-docs/order/remove-tag.md): Remove a tag from one or more orders.
- [Order - Revert](https://skulabs.mintlify.app/api-docs/order/revert.md): Revert an order back to its previous status, undoing the last status change.
- [Order - Set Tags](https://skulabs.mintlify.app/api-docs/order/set-tags.md): Replace all tags on one or more orders with a new set of tags.
- [Order - Status](https://skulabs.mintlify.app/api-docs/order/status.md): Retrieve the current status of an order.
- [Order - Undershipped Item Report](https://skulabs.mintlify.app/api-docs/order/undershipped-item-report.md): Retrieve a report of items that were shipped in quantities less than ordered.
- [Order - Unscanned Order List](https://skulabs.mintlify.app/api-docs/order/unscanned-order-list.md): Retrieve a list of orders with items that have not been scanned during fulfillment.
- [Purchase Order - Add Tag](https://skulabs.mintlify.app/api-docs/purchase-order/add-tag.md): Add a tag to one or more purchase orders.
- [Purchase Order - Bulk Accept](https://skulabs.mintlify.app/api-docs/purchase-order/bulk-accept.md): Accept items on multiple purchase orders in bulk, updating received quantities.
- [Purchase Order - Create](https://skulabs.mintlify.app/api-docs/purchase-order/create.md): August 2023: Now supports item_id, kit_id, sku (SKULabs Kit or Item), mpn (Supplier MPN), or barcode (SKULabs Kit or Item barcode) as lookup fields in the item array.
- [Purchase Order - Create V2](https://skulabs.mintlify.app/api-docs/purchase-order/create-v2.md): Create a purchase order using names instead of IDs for store, distributor, and warehouse. Supports item lookup by SKU, MPN, or barcode.
- [Purchase Order - Get](https://skulabs.mintlify.app/api-docs/purchase-order/get.md): Retrieve a paginated list of purchase orders with optional filtering.
- [Purchase Order - Get By Status](https://skulabs.mintlify.app/api-docs/purchase-order/get-by-status.md): Retrieve purchase orders filtered by their current status.
- [Purchase Order - Get Closed](https://skulabs.mintlify.app/api-docs/purchase-order/get-closed.md): Retrieve all closed (completed) purchase orders.
- [Purchase Order - Get Closed With Items](https://skulabs.mintlify.app/api-docs/purchase-order/get-closed-with-items.md): Retrieve closed purchase orders with their full item details included.
- [Purchase Order - Get Processing](https://skulabs.mintlify.app/api-docs/purchase-order/get-processing.md): Retrieve purchase orders currently being processed (not yet closed).
- [Purchase Order - Get Processing With Item Id](https://skulabs.mintlify.app/api-docs/purchase-order/get-processing-with-item-id.md): Retrieve processing purchase orders that contain a specific item.
- [Purchase Order - Get Processing With Items](https://skulabs.mintlify.app/api-docs/purchase-order/get-processing-with-items.md): Retrieve processing purchase orders with their full item details included.
- [Purchase Order - Get Single](https://skulabs.mintlify.app/api-docs/purchase-order/get-single.md): Retrieve a single purchase order by its ID.
- [Purchase Order - Get Single Bulk](https://skulabs.mintlify.app/api-docs/purchase-order/get-single-bulk.md): Retrieve multiple purchase orders by their IDs in a single request.
- [Purchase Order - Get Single By Number](https://skulabs.mintlify.app/api-docs/purchase-order/get-single-by-number.md): Retrieve a single purchase order by its PO number.
- [Purchase Order - New Create](https://skulabs.mintlify.app/api-docs/purchase-order/new-create.md): Create a purchase order using the latest creation endpoint with enhanced validation.
- [Purchase Order - Remove Tag](https://skulabs.mintlify.app/api-docs/purchase-order/remove-tag.md): Remove a tag from one or more purchase orders.
- [Purchase Order - Set Tags](https://skulabs.mintlify.app/api-docs/purchase-order/set-tags.md): Replace all tags on one or more purchase orders with a new set of tags.
- [Run - Debug Request](https://skulabs.mintlify.app/api-docs/run/debug-request.md): /run/debug_request
- [Run - Shopify Returns Cleanup](https://skulabs.mintlify.app/api-docs/run/shopify-returns-cleanup.md): /run/shopify_returns_cleanup
- [Run - Shopify Returns Simulation](https://skulabs.mintlify.app/api-docs/run/shopify-returns-simulation.md): /run/shopify_returns_simulation
- [Shipments - Csv Export](https://skulabs.mintlify.app/api-docs/shipments/csv-export.md): Export shipments data as a CSV file within a specified date range.
- [Shipments - Get](https://skulabs.mintlify.app/api-docs/shipments/get.md): Retrieve shipments for a specific order.
- [Shipments - Get By Range](https://skulabs.mintlify.app/api-docs/shipments/get-by-range.md): Retrieve shipments within a date range with optional warehouse filtering.
- [Shipping - Restore Inventory](https://skulabs.mintlify.app/api-docs/shipping/restore-inventory.md): Restore inventory that was previously deducted when a shipment was created.
- [Shipping - Set Manifested](https://skulabs.mintlify.app/api-docs/shipping/set-manifested.md): Mark shipments as manifested, indicating they have been handed off to the carrier.
- [Shipping - Void](https://skulabs.mintlify.app/api-docs/shipping/void.md): Void a shipment, cancelling the shipping label and optionally restoring inventory.
- [Store - Get](https://skulabs.mintlify.app/api-docs/store/get.md): Retrieve all connected store integrations for the current account.
- [Add Tag](https://skulabs.mintlify.app/api-docs/tag/add-tag.md): Creates a new tag
- [Tag - Get](https://skulabs.mintlify.app/api-docs/tag/get.md): Retrieve all tags with optional filtering by type.
- [Tag - Remove](https://skulabs.mintlify.app/api-docs/tag/remove.md): Permanently delete a tag.
- [Tag - Update](https://skulabs.mintlify.app/api-docs/tag/update.md): Update an existing tag's name or color.
- [Transfer Order - Create](https://skulabs.mintlify.app/api-docs/transfer-order/create.md): Create a new transfer order to move inventory between warehouses.
- [Transfer Order - Get](https://skulabs.mintlify.app/api-docs/transfer-order/get.md): Retrieve a single transfer order by ID.
- [Transfer Order - Get All](https://skulabs.mintlify.app/api-docs/transfer-order/get-all.md): Retrieve all transfer orders with optional filtering by status and warehouse.
- [Warehouse - Create](https://skulabs.mintlify.app/api-docs/warehouse/create.md): Create a new warehouse with name and address details.
- [Warehouse - Create V2](https://skulabs.mintlify.app/api-docs/warehouse/create-v2.md): Create a new warehouse using the latest creation endpoint with enhanced options.
- [Warehouse - Get](https://skulabs.mintlify.app/api-docs/warehouse/get.md): Retrieve all warehouses for the current account.
- [Warehouse - Stats](https://skulabs.mintlify.app/api-docs/warehouse/stats.md): Retrieve warehouse statistics including item counts and inventory totals.
- [Add Handler](https://skulabs.mintlify.app/api-docs/webhook/add-handler.md): Creates a new webhook handler
- [Remove Handler](https://skulabs.mintlify.app/api-docs/webhook/remove-handler.md): Removes a webhook handler
- [Handling Status Codes](https://skulabs.mintlify.app/best-practices/handling-status-codes.md): How to treat status codes from SKULabs API calls
- [Querying Data](https://skulabs.mintlify.app/best-practices/querying.md): How to query data with the SKULabs API
- [Rules](https://skulabs.mintlify.app/best-practices/rules.md): When your API key will be invalidated, who you can share your API key with
- [Authentication](https://skulabs.mintlify.app/getting-started/authentication.md): Authenticating with your SKULabs API Key
- [Generating an API Key](https://skulabs.mintlify.app/getting-started/getting-an-api-key.md): How to get your SKULabs API Key
- [Rate Limits](https://skulabs.mintlify.app/getting-started/rate-limits.md): Making use of your rate limits
- [Your First API Call](https://skulabs.mintlify.app/getting-started/your-first-api-call.md): Making your first API call

## OpenAPI Specs

- [openapi](https://skulabs.mintlify.app/openapi.json)

## Optional

- [Blog](https://blog.skulabs.com/)