Getting Started
Your First API Call
Best Practices
Item
- POSTItem - Add Barcode
- POSTItem - Add Custom Field
- POSTItem - Add Serial Numbers
- POSTItem - Add Tag
- POSTItem - Bulk Assign
- DELItem - Bulk Remove
- PUTItem - Bulk Upsert
- POSTItem - Create Upsert
- POSTItem - Create
- GETItem - Find By Barcode
- GETItem - Get Locations
- GETItem - Get
- DELItem - New Remove Serial Number
- DELItem - Remove Barcode
- DELItem - Remove Custom Field
- DELItem - Remove Serial Number
- DELItem - Remove Tag
- DELItem - Remove
- PUTItem - Set Tags
- PUTItem - Update Alias Locations
- PUTItem - Update
- PUTItem - Upsert
Kit
Location
Purchase Order
- POSTPurchase Order - Add Tag
- POSTPurchase Order - Bulk Accept
- POSTPurchase Order - Create V 2
- POSTPurchase Order - Create
- GETPurchase Order - Get By Status
- GETPurchase Order - Get Closed With Items
- GETPurchase Order - Get Closed
- GETPurchase Order - Get Processing With Item Id
- GETPurchase Order - Get Processing With Items
- GETPurchase Order - Get Processing
- GETPurchase Order - Get Single By Number
- GETPurchase Order - Get Single
- GETPurchase Order - Get
- POSTPurchase Order - New Create
- POSTPurchase Order - Remove Tag
- PUTPurchase Order - Set Tags
Order
- POSTOrder - Add Manual Shipment
- POSTOrder - Add Note
- POSTOrder - Add Tag By Name
- POSTOrder - Add Tag
- POSTOrder - Add
- POSTOrder - Bulk Add Manual Shipments
- GETOrder - Get All
- GETOrder - Get Archived
- GETOrder - Get By Base Order Number
- GETOrder - Get Customs Information
- GETOrder - Get Scanned Serial Numbers
- GETOrder - Get Shipped
- GETOrder - Get Single Bulk
- GETOrder - Get Single
- GETOrder - Get Skipped Scans
- GETOrder - Get Unscanned Items
- GETOrder - Get
- PUTOrder - Modify Financial Status
- PUTOrder - Modify Status
- PUTOrder - Override
- DELOrder - Remove Tag
- PUTOrder - Revert
- PUTOrder - Set Tags
- GETOrder - Status
- GETOrder - Undershipped Item Report
- GETOrder - Unscanned Order List
Customer
Cycle Count
Distributor
Inventory
- POSTInventory - Bulk Reconciliation
- PUTInventory - Decrease On Hand
- POSTInventory - Deduct Serial Numbers
- POSTInventory - Get Grouped Locations Map
- GETInventory - Get History
- GETInventory - Get Inventory History
- GETInventory - Get Item Free
- POSTInventory - Get Items And Kits Map
- POSTInventory - Get Items Incoming
- POSTInventory - Get Items Map
- POSTInventory - Get Items
- POSTInventory - Get Kits Map
- POSTInventory - Get On Hand Location Map
- GETInventory - Get Received History
- POSTInventory - Get Reserved Map
- GETInventory - Get Reserved Map
- GETInventory - Get
- PUTInventory - Increase On Hand
- PUTInventory - Upsert
Store
Getting Started
Your First API Call
Making your first API call
This example is for a Node.js environment. If you’d like to see examples in your programming language, you can visit the page for the endpoint you wish to call.
Prerequisites
Ensure you have Axios or a similar library installed in your Node.js 18+ project.
npm install axios
Sample Code
The code below creates a location and then retrieves a list of locations where warehouse_id = ‘1234’.
const axios = require('axios');
// Replace 'your_access_token_here' with your actual access token
const accessToken = 'your_access_token_here';
const config = {
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${accessToken}`
}
};
// Lets create a new location
const create_location_url = new URL('https://api.skulabs.com/location/create');
const postData = {
warehouse_id: '1234',
name: 'My New Location'
};
axios.post(create_location_url.toString(), postData, config)
.then(function (response) {
console.log('Response:', response.data);
}).catch(function (error) {
console.error('Error:', error);
});
// Now, let's get the list of locations.
const get_list_url = new URL('https://api.skulabs.com/location/get_list');
const selector = { warehouse_id: '1234' };
// Append the selector to the URL
get_list_url.searchParams.append('selector', JSON.stringify(selector));
axios.get(get_list_url.toString(), config)
.then(function (response) {
console.log('Response:', response.data);
}).catch(function (error) {
console.error('Error:', error);
});
Notes
- Replace your_access_token_here with your actual access token for authentication.
- This script handles both successful and error responses from the API.
You did it! Now that you’ve succesfully connected to our API, feel free to explore all of our endpoints.
On this page