Adjust Inventory Item
curl --request PUT \
--url https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"quantity": 1,
"adjustment_type": "increase",
"warehouse_id": "<string>",
"location_id": "<string>"
}
'import requests
url = "https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust"
payload = {
"quantity": 1,
"adjustment_type": "increase",
"warehouse_id": "<string>",
"location_id": "<string>"
}
headers = {
"x-trackstar-api-key": "<x-trackstar-api-key>",
"x-trackstar-access-token": "<x-trackstar-access-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'x-trackstar-access-token': '<x-trackstar-access-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
quantity: 1,
adjustment_type: 'increase',
warehouse_id: '<string>',
location_id: '<string>'
})
};
fetch('https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'quantity' => 1,
'adjustment_type' => 'increase',
'warehouse_id' => '<string>',
'location_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-trackstar-access-token: <x-trackstar-access-token>",
"x-trackstar-api-key: <x-trackstar-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust"
payload := strings.NewReader("{\n \"quantity\": 1,\n \"adjustment_type\": \"increase\",\n \"warehouse_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")
req.Header.Add("x-trackstar-access-token", "<x-trackstar-access-token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.header("x-trackstar-access-token", "<x-trackstar-access-token>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": 1,\n \"adjustment_type\": \"increase\",\n \"warehouse_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'
request["x-trackstar-access-token"] = '<x-trackstar-access-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quantity\": 1,\n \"adjustment_type\": \"increase\",\n \"warehouse_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"<string>"
],
"data": {
"id": "inv_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"name": "name",
"sku": "sku",
"unit_cost": 1,
"active": true,
"awaiting": 0,
"onhand": 5,
"committed": 1,
"unfulfillable": 0,
"fulfillable": 4,
"sellable": 2,
"substitute_skus": [
"sub_sku_1",
"sub_sku_2"
],
"inventory_by_warehouse_id": {
"warehouse_id_1": {
"onhand": 4,
"committed": 1,
"unfulfillable": 0,
"fulfillable": 3,
"sellable": 2,
"awaiting": 0
},
"warehouse_id_2": {
"onhand": 1,
"committed": 0,
"unfulfillable": 0,
"fulfillable": 1,
"sellable": 1,
"awaiting": 0
}
},
"lots": [
{
"lot_id": "lot_id_1",
"onhand": 2,
"expiration_date": "2022-01-01T00:00:00Z",
"warehouse_id": "warehouse_id1"
},
{
"lot_id": "lot_id_2",
"onhand": 1,
"expiration_date": "2022-01-03T00:00:00Z",
"warehouse_id": "warehouse_id2"
}
],
"measurements": {
"length": 1.5,
"width": 1.5,
"height": 1.5,
"unit": "in",
"weight": 2.5,
"weight_unit": "lb"
},
"locations": [
{
"location_id": "location_id_1",
"quantity": 2,
"warehouse_id": "warehouse_id1"
},
{
"location_id": "location_id_2",
"quantity": 1,
"warehouse_id": "warehouse_id2"
}
],
"external_system_url": "https://example.com/inventoryitem/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
},
"trackstar_created_date": "2023-11-07T05:31:56Z",
"trackstar_updated_date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"id": "<string>"
}{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}Inventory
Adjust Inventory Item
Adjust the inventory for the specified inventory item.
PUT
/
wms
/
inventory
/
{inventory_id}
/
adjust
Adjust Inventory Item
curl --request PUT \
--url https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"quantity": 1,
"adjustment_type": "increase",
"warehouse_id": "<string>",
"location_id": "<string>"
}
'import requests
url = "https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust"
payload = {
"quantity": 1,
"adjustment_type": "increase",
"warehouse_id": "<string>",
"location_id": "<string>"
}
headers = {
"x-trackstar-api-key": "<x-trackstar-api-key>",
"x-trackstar-access-token": "<x-trackstar-access-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'x-trackstar-access-token': '<x-trackstar-access-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
quantity: 1,
adjustment_type: 'increase',
warehouse_id: '<string>',
location_id: '<string>'
})
};
fetch('https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'quantity' => 1,
'adjustment_type' => 'increase',
'warehouse_id' => '<string>',
'location_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-trackstar-access-token: <x-trackstar-access-token>",
"x-trackstar-api-key: <x-trackstar-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust"
payload := strings.NewReader("{\n \"quantity\": 1,\n \"adjustment_type\": \"increase\",\n \"warehouse_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")
req.Header.Add("x-trackstar-access-token", "<x-trackstar-access-token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.header("x-trackstar-access-token", "<x-trackstar-access-token>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": 1,\n \"adjustment_type\": \"increase\",\n \"warehouse_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'
request["x-trackstar-access-token"] = '<x-trackstar-access-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quantity\": 1,\n \"adjustment_type\": \"increase\",\n \"warehouse_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"<string>"
],
"data": {
"id": "inv_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"name": "name",
"sku": "sku",
"unit_cost": 1,
"active": true,
"awaiting": 0,
"onhand": 5,
"committed": 1,
"unfulfillable": 0,
"fulfillable": 4,
"sellable": 2,
"substitute_skus": [
"sub_sku_1",
"sub_sku_2"
],
"inventory_by_warehouse_id": {
"warehouse_id_1": {
"onhand": 4,
"committed": 1,
"unfulfillable": 0,
"fulfillable": 3,
"sellable": 2,
"awaiting": 0
},
"warehouse_id_2": {
"onhand": 1,
"committed": 0,
"unfulfillable": 0,
"fulfillable": 1,
"sellable": 1,
"awaiting": 0
}
},
"lots": [
{
"lot_id": "lot_id_1",
"onhand": 2,
"expiration_date": "2022-01-01T00:00:00Z",
"warehouse_id": "warehouse_id1"
},
{
"lot_id": "lot_id_2",
"onhand": 1,
"expiration_date": "2022-01-03T00:00:00Z",
"warehouse_id": "warehouse_id2"
}
],
"measurements": {
"length": 1.5,
"width": 1.5,
"height": 1.5,
"unit": "in",
"weight": 2.5,
"weight_unit": "lb"
},
"locations": [
{
"location_id": "location_id_1",
"quantity": 2,
"warehouse_id": "warehouse_id1"
},
{
"location_id": "location_id_2",
"quantity": 1,
"warehouse_id": "warehouse_id2"
}
],
"external_system_url": "https://example.com/inventoryitem/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
},
"trackstar_created_date": "2023-11-07T05:31:56Z",
"trackstar_updated_date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"id": "<string>"
}{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}Headers
Your organization-level Trackstar API key.
Example:
"<x-trackstar-api-key>"
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Example:
"<x-trackstar-access-token>"
Path Parameters
Body
application/json
- Base Schema
- Amazon
- Linnworks
- Logiwa
- WMS Sandbox
- ShipHero
The quantity to adjust the inventory by.
Example:
1
The type of adjustment to make to the inventory.
Available options:
increase, decrease Example:
"increase"
ID of the location to adjust inventory in. Can be passed into the Warehouse Location endpoint for more details.
⌘I