Update Inbound Shipment
curl --request PUT \
--url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id} \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"supplier_object": {
"supplier_id": "supplier_id"
},
"purchase_order_number": "po_number_123",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"tracking_number": "tracking_number",
"line_items": [
{
"sku": "sku",
"expected_quantity": 0
}
]
}
'import requests
url = "https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}"
payload = {
"trackstar_tags": ["tag1", "tag2", { "tag3": "value3" }],
"supplier_object": { "supplier_id": "supplier_id" },
"purchase_order_number": "po_number_123",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"tracking_number": "tracking_number",
"line_items": [
{
"sku": "sku",
"expected_quantity": 0
}
]
}
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({
trackstar_tags: ['tag1', 'tag2', {tag3: 'value3'}],
supplier_object: {supplier_id: 'supplier_id'},
purchase_order_number: 'po_number_123',
expected_arrival_date: '2022-10-10T01:02:03Z',
warehouse_id: 'warehouse_id123',
tracking_number: 'tracking_number',
line_items: [{sku: 'sku', expected_quantity: 0}]
})
};
fetch('https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}', 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/inbound-shipments/{inbound_shipment_id}",
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([
'trackstar_tags' => [
'tag1',
'tag2',
[
'tag3' => 'value3'
]
],
'supplier_object' => [
'supplier_id' => 'supplier_id'
],
'purchase_order_number' => 'po_number_123',
'expected_arrival_date' => '2022-10-10T01:02:03Z',
'warehouse_id' => 'warehouse_id123',
'tracking_number' => 'tracking_number',
'line_items' => [
[
'sku' => 'sku',
'expected_quantity' => 0
]
]
]),
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/inbound-shipments/{inbound_shipment_id}"
payload := strings.NewReader("{\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"supplier_object\": {\n \"supplier_id\": \"supplier_id\"\n },\n \"purchase_order_number\": \"po_number_123\",\n \"expected_arrival_date\": \"2022-10-10T01:02:03Z\",\n \"warehouse_id\": \"warehouse_id123\",\n \"tracking_number\": \"tracking_number\",\n \"line_items\": [\n {\n \"sku\": \"sku\",\n \"expected_quantity\": 0\n }\n ]\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/inbound-shipments/{inbound_shipment_id}")
.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 \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"supplier_object\": {\n \"supplier_id\": \"supplier_id\"\n },\n \"purchase_order_number\": \"po_number_123\",\n \"expected_arrival_date\": \"2022-10-10T01:02:03Z\",\n \"warehouse_id\": \"warehouse_id123\",\n \"tracking_number\": \"tracking_number\",\n \"line_items\": [\n {\n \"sku\": \"sku\",\n \"expected_quantity\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}")
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 \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"supplier_object\": {\n \"supplier_id\": \"supplier_id\"\n },\n \"purchase_order_number\": \"po_number_123\",\n \"expected_arrival_date\": \"2022-10-10T01:02:03Z\",\n \"warehouse_id\": \"warehouse_id123\",\n \"tracking_number\": \"tracking_number\",\n \"line_items\": [\n {\n \"sku\": \"sku\",\n \"expected_quantity\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"unused_fields"
],
"data": {
"id": "inbound_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"purchase_order_number": "po_number_123",
"status": "open",
"raw_status": "raw_status",
"supplier_object": {
"supplier_id": "supplier_id",
"supplier_name": "supplier_name"
},
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"expected_quantity": 2,
"received_quantity": 1,
"unit_cost": 1,
"external_id": "external_sku"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"lot_id": "lot_id",
"expiration_date": "2022-10-10T01:02:03Z"
}
]
}
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"tracking_numbers": [
"tracking_number_1",
"tracking_number_2"
],
"notes": [
"note_1",
"note_2"
],
"external_system_url": "https://example.com/inboundshipment/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
},
"trackstar_created_date": "2023-03-15T13:45:30Z",
"trackstar_updated_date": "2023-03-15T13:45:30Z"
}
}{
"error": "<string>",
"id": "<string>"
}{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}Inbound Shipments
Update Inbound Shipment
Get the required, optional, and integration specific fields by calling the integrations endpoint.
PUT
/
wms
/
inbound-shipments
/
{inbound_shipment_id}
Update Inbound Shipment
curl --request PUT \
--url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id} \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"supplier_object": {
"supplier_id": "supplier_id"
},
"purchase_order_number": "po_number_123",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"tracking_number": "tracking_number",
"line_items": [
{
"sku": "sku",
"expected_quantity": 0
}
]
}
'import requests
url = "https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}"
payload = {
"trackstar_tags": ["tag1", "tag2", { "tag3": "value3" }],
"supplier_object": { "supplier_id": "supplier_id" },
"purchase_order_number": "po_number_123",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"tracking_number": "tracking_number",
"line_items": [
{
"sku": "sku",
"expected_quantity": 0
}
]
}
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({
trackstar_tags: ['tag1', 'tag2', {tag3: 'value3'}],
supplier_object: {supplier_id: 'supplier_id'},
purchase_order_number: 'po_number_123',
expected_arrival_date: '2022-10-10T01:02:03Z',
warehouse_id: 'warehouse_id123',
tracking_number: 'tracking_number',
line_items: [{sku: 'sku', expected_quantity: 0}]
})
};
fetch('https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}', 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/inbound-shipments/{inbound_shipment_id}",
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([
'trackstar_tags' => [
'tag1',
'tag2',
[
'tag3' => 'value3'
]
],
'supplier_object' => [
'supplier_id' => 'supplier_id'
],
'purchase_order_number' => 'po_number_123',
'expected_arrival_date' => '2022-10-10T01:02:03Z',
'warehouse_id' => 'warehouse_id123',
'tracking_number' => 'tracking_number',
'line_items' => [
[
'sku' => 'sku',
'expected_quantity' => 0
]
]
]),
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/inbound-shipments/{inbound_shipment_id}"
payload := strings.NewReader("{\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"supplier_object\": {\n \"supplier_id\": \"supplier_id\"\n },\n \"purchase_order_number\": \"po_number_123\",\n \"expected_arrival_date\": \"2022-10-10T01:02:03Z\",\n \"warehouse_id\": \"warehouse_id123\",\n \"tracking_number\": \"tracking_number\",\n \"line_items\": [\n {\n \"sku\": \"sku\",\n \"expected_quantity\": 0\n }\n ]\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/inbound-shipments/{inbound_shipment_id}")
.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 \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"supplier_object\": {\n \"supplier_id\": \"supplier_id\"\n },\n \"purchase_order_number\": \"po_number_123\",\n \"expected_arrival_date\": \"2022-10-10T01:02:03Z\",\n \"warehouse_id\": \"warehouse_id123\",\n \"tracking_number\": \"tracking_number\",\n \"line_items\": [\n {\n \"sku\": \"sku\",\n \"expected_quantity\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}")
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 \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"supplier_object\": {\n \"supplier_id\": \"supplier_id\"\n },\n \"purchase_order_number\": \"po_number_123\",\n \"expected_arrival_date\": \"2022-10-10T01:02:03Z\",\n \"warehouse_id\": \"warehouse_id123\",\n \"tracking_number\": \"tracking_number\",\n \"line_items\": [\n {\n \"sku\": \"sku\",\n \"expected_quantity\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"unused_fields"
],
"data": {
"id": "inbound_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"purchase_order_number": "po_number_123",
"status": "open",
"raw_status": "raw_status",
"supplier_object": {
"supplier_id": "supplier_id",
"supplier_name": "supplier_name"
},
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"expected_quantity": 2,
"received_quantity": 1,
"unit_cost": 1,
"external_id": "external_sku"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"lot_id": "lot_id",
"expiration_date": "2022-10-10T01:02:03Z"
}
]
}
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"tracking_numbers": [
"tracking_number_1",
"tracking_number_2"
],
"notes": [
"note_1",
"note_2"
],
"external_system_url": "https://example.com/inboundshipment/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
},
"trackstar_created_date": "2023-03-15T13:45:30Z",
"trackstar_updated_date": "2023-03-15T13:45:30Z"
}
}{
"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>"
Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.
Required string length:
1 - 255Example:
"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"
Path Parameters
Body
application/json
- Base Schema
- BlueBox (IDrive Fulfillment)
- Clarus
- J&J Global Fulfillment (Control Port)
- Cin7 Core (Dear Systems)
- Deposco
- Extensiv (3PL Central)
- Flexport (Deliverr)
- GoBolt
- Helm WMS
- Hive
- Infoplus
- Cart.com (Jazz Central)
- Logiwa
- Logiwa IO
- Luminous
- MasonHub
- Ongoing WMS
- Packiyo
- WMS Sandbox
- ShipBob
- ShipHero
- ShipMonk
- ShipStream
- Shipwire
- SKUSavvy
- Linnworks Core (SKUVault)
- Sojo
- Unleashed
- Veeqo
- Warehance
- Whiplash (Ryder)
A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
Example:
["tag1", "tag2", { "tag3": "value3" }]
The supplier from which the shipment is being sent.
- SupplierId
- WriteSupplierName
Show child attributes
Show child attributes
The number of the purchase order associated with the inbound shipment.
Example:
"po_number_123"
Date the shipment is expected to reach the warehouse.
Example:
"2022-10-10T01:02:03Z"
Tracking number associated with the inbound shipment.
Example:
"tracking_number"
List of line items included in the shipment.
Show child attributes
Show child attributes
Example:
[{ "sku": "sku", "expected_quantity": 0 }]