Update Order
curl --request PUT \
--url https://production.trackstarhq.com/wms/orders/{order_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 '
{
"warehouse_customer_id": "warehouse_customer_id",
"reference_id": "order_reference_id",
"order_number": "order_number",
"channel_object": {
"channel_id": "channel_id"
},
"trading_partner": "Target",
"shipping_method_id": "fedex_ground",
"service_level": "Standard",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "United States"
},
"status": "open",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
]
}
'import requests
url = "https://production.trackstarhq.com/wms/orders/{order_id}"
payload = {
"warehouse_customer_id": "warehouse_customer_id",
"reference_id": "order_reference_id",
"order_number": "order_number",
"channel_object": { "channel_id": "channel_id" },
"trading_partner": "Target",
"shipping_method_id": "fedex_ground",
"service_level": "Standard",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "United States"
},
"status": "open",
"trackstar_tags": ["tag1", "tag2", { "tag3": "value3" }],
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
]
}
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({
warehouse_customer_id: 'warehouse_customer_id',
reference_id: 'order_reference_id',
order_number: 'order_number',
channel_object: {channel_id: 'channel_id'},
trading_partner: 'Target',
shipping_method_id: 'fedex_ground',
service_level: 'Standard',
invoice_currency_code: 'USD',
total_price: 13.49,
total_tax: 1.5,
total_discount: 2.5,
total_shipping: 3.5,
ship_to_address: {
full_name: 'John Doe',
company: 'Company',
address1: '123 Main St',
address2: 'Apt 2',
city: 'San Francisco',
state: 'CA',
postal_code: '94105',
country: 'United States'
},
status: 'open',
trackstar_tags: ['tag1', 'tag2', {tag3: 'value3'}],
line_items: [
{
product_id: 'product_id',
sku: 'sku',
quantity: 1,
unit_price: 10.99,
discount_amount: 1.5
}
]
})
};
fetch('https://production.trackstarhq.com/wms/orders/{order_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/orders/{order_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([
'warehouse_customer_id' => 'warehouse_customer_id',
'reference_id' => 'order_reference_id',
'order_number' => 'order_number',
'channel_object' => [
'channel_id' => 'channel_id'
],
'trading_partner' => 'Target',
'shipping_method_id' => 'fedex_ground',
'service_level' => 'Standard',
'invoice_currency_code' => 'USD',
'total_price' => 13.49,
'total_tax' => 1.5,
'total_discount' => 2.5,
'total_shipping' => 3.5,
'ship_to_address' => [
'full_name' => 'John Doe',
'company' => 'Company',
'address1' => '123 Main St',
'address2' => 'Apt 2',
'city' => 'San Francisco',
'state' => 'CA',
'postal_code' => '94105',
'country' => 'United States'
],
'status' => 'open',
'trackstar_tags' => [
'tag1',
'tag2',
[
'tag3' => 'value3'
]
],
'line_items' => [
[
'product_id' => 'product_id',
'sku' => 'sku',
'quantity' => 1,
'unit_price' => 10.99,
'discount_amount' => 1.5
]
]
]),
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/orders/{order_id}"
payload := strings.NewReader("{\n \"warehouse_customer_id\": \"warehouse_customer_id\",\n \"reference_id\": \"order_reference_id\",\n \"order_number\": \"order_number\",\n \"channel_object\": {\n \"channel_id\": \"channel_id\"\n },\n \"trading_partner\": \"Target\",\n \"shipping_method_id\": \"fedex_ground\",\n \"service_level\": \"Standard\",\n \"invoice_currency_code\": \"USD\",\n \"total_price\": 13.49,\n \"total_tax\": 1.5,\n \"total_discount\": 2.5,\n \"total_shipping\": 3.5,\n \"ship_to_address\": {\n \"full_name\": \"John Doe\",\n \"company\": \"Company\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 2\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"United States\"\n },\n \"status\": \"open\",\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"line_items\": [\n {\n \"product_id\": \"product_id\",\n \"sku\": \"sku\",\n \"quantity\": 1,\n \"unit_price\": 10.99,\n \"discount_amount\": 1.5\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/orders/{order_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 \"warehouse_customer_id\": \"warehouse_customer_id\",\n \"reference_id\": \"order_reference_id\",\n \"order_number\": \"order_number\",\n \"channel_object\": {\n \"channel_id\": \"channel_id\"\n },\n \"trading_partner\": \"Target\",\n \"shipping_method_id\": \"fedex_ground\",\n \"service_level\": \"Standard\",\n \"invoice_currency_code\": \"USD\",\n \"total_price\": 13.49,\n \"total_tax\": 1.5,\n \"total_discount\": 2.5,\n \"total_shipping\": 3.5,\n \"ship_to_address\": {\n \"full_name\": \"John Doe\",\n \"company\": \"Company\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 2\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"United States\"\n },\n \"status\": \"open\",\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"line_items\": [\n {\n \"product_id\": \"product_id\",\n \"sku\": \"sku\",\n \"quantity\": 1,\n \"unit_price\": 10.99,\n \"discount_amount\": 1.5\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/wms/orders/{order_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 \"warehouse_customer_id\": \"warehouse_customer_id\",\n \"reference_id\": \"order_reference_id\",\n \"order_number\": \"order_number\",\n \"channel_object\": {\n \"channel_id\": \"channel_id\"\n },\n \"trading_partner\": \"Target\",\n \"shipping_method_id\": \"fedex_ground\",\n \"service_level\": \"Standard\",\n \"invoice_currency_code\": \"USD\",\n \"total_price\": 13.49,\n \"total_tax\": 1.5,\n \"total_discount\": 2.5,\n \"total_shipping\": 3.5,\n \"ship_to_address\": {\n \"full_name\": \"John Doe\",\n \"company\": \"Company\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 2\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"United States\"\n },\n \"status\": \"open\",\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"line_items\": [\n {\n \"product_id\": \"product_id\",\n \"sku\": \"sku\",\n \"quantity\": 1,\n \"unit_price\": 10.99,\n \"discount_amount\": 1.5\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"<string>"
],
"data": {
"id": "order_id",
"warehouse_customer_id": "warehouse_customer_id",
"warehouse_id": "warehouse_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"reference_id": "order_reference_id",
"order_number": "order_number",
"status": "open",
"raw_status": "raw_status",
"channel_object": {
"channel_id": "channel_id",
"channel_name": "channel_name"
},
"type": "d2c",
"trading_partner": "Target",
"service_level": "Standard",
"shipping_method_id": "fedex_ground",
"shipping_method_name": "FedEx Ground",
"carrier_id": "fedex",
"carrier_name": "FedEx",
"scac": "<string>",
"is_third_party_freight": false,
"third_party_freight_account_number": "123456",
"first_party_freight_account_number": "123456",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States",
"phone_number": "123-456-7890",
"email_address": "johndoe@example.com"
},
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
],
"tags": [
"tag_0"
],
"required_ship_date": "2021-01-01T12:00:00Z",
"saturday_delivery": false,
"signature_required": false,
"international_duty_paid_by": "sender",
"shipments": [
{
"shipment_id": "shipment_id",
"warehouse_id": "wh_id",
"shipped_date": "2022-05-06T01:02:03Z",
"raw_status": "raw_status",
"status": "shipped",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"parent_product_id": null
}
],
"ship_to_address": {
"full_name": "John Doe",
"company": "company",
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"state": "state",
"postal_code": "postal_code",
"country": "country"
},
"ship_from_address": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"state": "state",
"postal_code": "postal_code",
"country": "country"
},
"packages": [
{
"package_id": "package_id",
"package_name": "package_name",
"tracking_number": "tracking_number",
"tracking_url": "tracking_url",
"shipping_method_id": "shipping_method_id",
"shipping_method_name": "shipping_method_name",
"carrier_id": "carrier_id",
"carrier_name": "carrier_name",
"scac": "scac",
"bill_of_lading": "bill_of_lading",
"sscc": "sscc",
"pro_number": "pro_number",
"shipping_cost": 1,
"measurements": {
"length": 1,
"width": 1,
"height": 1,
"unit": "in",
"weight": 1,
"weight_unit": "lb"
},
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"lot_id": "lot_id",
"expiration_date": "2022-06-06T01:02:03Z",
"parent_product_id": null
}
]
}
]
}
],
"external_system_url": "https://example.com/order/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>"
]
}
}
}Orders
Update Order
Get the required, optional, and integration specific fields by calling the integrations endpoint.
PUT
/
wms
/
orders
/
{order_id}
Update Order
curl --request PUT \
--url https://production.trackstarhq.com/wms/orders/{order_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 '
{
"warehouse_customer_id": "warehouse_customer_id",
"reference_id": "order_reference_id",
"order_number": "order_number",
"channel_object": {
"channel_id": "channel_id"
},
"trading_partner": "Target",
"shipping_method_id": "fedex_ground",
"service_level": "Standard",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "United States"
},
"status": "open",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
]
}
'import requests
url = "https://production.trackstarhq.com/wms/orders/{order_id}"
payload = {
"warehouse_customer_id": "warehouse_customer_id",
"reference_id": "order_reference_id",
"order_number": "order_number",
"channel_object": { "channel_id": "channel_id" },
"trading_partner": "Target",
"shipping_method_id": "fedex_ground",
"service_level": "Standard",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "United States"
},
"status": "open",
"trackstar_tags": ["tag1", "tag2", { "tag3": "value3" }],
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
]
}
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({
warehouse_customer_id: 'warehouse_customer_id',
reference_id: 'order_reference_id',
order_number: 'order_number',
channel_object: {channel_id: 'channel_id'},
trading_partner: 'Target',
shipping_method_id: 'fedex_ground',
service_level: 'Standard',
invoice_currency_code: 'USD',
total_price: 13.49,
total_tax: 1.5,
total_discount: 2.5,
total_shipping: 3.5,
ship_to_address: {
full_name: 'John Doe',
company: 'Company',
address1: '123 Main St',
address2: 'Apt 2',
city: 'San Francisco',
state: 'CA',
postal_code: '94105',
country: 'United States'
},
status: 'open',
trackstar_tags: ['tag1', 'tag2', {tag3: 'value3'}],
line_items: [
{
product_id: 'product_id',
sku: 'sku',
quantity: 1,
unit_price: 10.99,
discount_amount: 1.5
}
]
})
};
fetch('https://production.trackstarhq.com/wms/orders/{order_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/orders/{order_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([
'warehouse_customer_id' => 'warehouse_customer_id',
'reference_id' => 'order_reference_id',
'order_number' => 'order_number',
'channel_object' => [
'channel_id' => 'channel_id'
],
'trading_partner' => 'Target',
'shipping_method_id' => 'fedex_ground',
'service_level' => 'Standard',
'invoice_currency_code' => 'USD',
'total_price' => 13.49,
'total_tax' => 1.5,
'total_discount' => 2.5,
'total_shipping' => 3.5,
'ship_to_address' => [
'full_name' => 'John Doe',
'company' => 'Company',
'address1' => '123 Main St',
'address2' => 'Apt 2',
'city' => 'San Francisco',
'state' => 'CA',
'postal_code' => '94105',
'country' => 'United States'
],
'status' => 'open',
'trackstar_tags' => [
'tag1',
'tag2',
[
'tag3' => 'value3'
]
],
'line_items' => [
[
'product_id' => 'product_id',
'sku' => 'sku',
'quantity' => 1,
'unit_price' => 10.99,
'discount_amount' => 1.5
]
]
]),
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/orders/{order_id}"
payload := strings.NewReader("{\n \"warehouse_customer_id\": \"warehouse_customer_id\",\n \"reference_id\": \"order_reference_id\",\n \"order_number\": \"order_number\",\n \"channel_object\": {\n \"channel_id\": \"channel_id\"\n },\n \"trading_partner\": \"Target\",\n \"shipping_method_id\": \"fedex_ground\",\n \"service_level\": \"Standard\",\n \"invoice_currency_code\": \"USD\",\n \"total_price\": 13.49,\n \"total_tax\": 1.5,\n \"total_discount\": 2.5,\n \"total_shipping\": 3.5,\n \"ship_to_address\": {\n \"full_name\": \"John Doe\",\n \"company\": \"Company\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 2\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"United States\"\n },\n \"status\": \"open\",\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"line_items\": [\n {\n \"product_id\": \"product_id\",\n \"sku\": \"sku\",\n \"quantity\": 1,\n \"unit_price\": 10.99,\n \"discount_amount\": 1.5\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/orders/{order_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 \"warehouse_customer_id\": \"warehouse_customer_id\",\n \"reference_id\": \"order_reference_id\",\n \"order_number\": \"order_number\",\n \"channel_object\": {\n \"channel_id\": \"channel_id\"\n },\n \"trading_partner\": \"Target\",\n \"shipping_method_id\": \"fedex_ground\",\n \"service_level\": \"Standard\",\n \"invoice_currency_code\": \"USD\",\n \"total_price\": 13.49,\n \"total_tax\": 1.5,\n \"total_discount\": 2.5,\n \"total_shipping\": 3.5,\n \"ship_to_address\": {\n \"full_name\": \"John Doe\",\n \"company\": \"Company\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 2\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"United States\"\n },\n \"status\": \"open\",\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"line_items\": [\n {\n \"product_id\": \"product_id\",\n \"sku\": \"sku\",\n \"quantity\": 1,\n \"unit_price\": 10.99,\n \"discount_amount\": 1.5\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/wms/orders/{order_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 \"warehouse_customer_id\": \"warehouse_customer_id\",\n \"reference_id\": \"order_reference_id\",\n \"order_number\": \"order_number\",\n \"channel_object\": {\n \"channel_id\": \"channel_id\"\n },\n \"trading_partner\": \"Target\",\n \"shipping_method_id\": \"fedex_ground\",\n \"service_level\": \"Standard\",\n \"invoice_currency_code\": \"USD\",\n \"total_price\": 13.49,\n \"total_tax\": 1.5,\n \"total_discount\": 2.5,\n \"total_shipping\": 3.5,\n \"ship_to_address\": {\n \"full_name\": \"John Doe\",\n \"company\": \"Company\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 2\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"United States\"\n },\n \"status\": \"open\",\n \"trackstar_tags\": [\n \"tag1\",\n \"tag2\",\n {\n \"tag3\": \"value3\"\n }\n ],\n \"line_items\": [\n {\n \"product_id\": \"product_id\",\n \"sku\": \"sku\",\n \"quantity\": 1,\n \"unit_price\": 10.99,\n \"discount_amount\": 1.5\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"<string>"
],
"data": {
"id": "order_id",
"warehouse_customer_id": "warehouse_customer_id",
"warehouse_id": "warehouse_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"reference_id": "order_reference_id",
"order_number": "order_number",
"status": "open",
"raw_status": "raw_status",
"channel_object": {
"channel_id": "channel_id",
"channel_name": "channel_name"
},
"type": "d2c",
"trading_partner": "Target",
"service_level": "Standard",
"shipping_method_id": "fedex_ground",
"shipping_method_name": "FedEx Ground",
"carrier_id": "fedex",
"carrier_name": "FedEx",
"scac": "<string>",
"is_third_party_freight": false,
"third_party_freight_account_number": "123456",
"first_party_freight_account_number": "123456",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States",
"phone_number": "123-456-7890",
"email_address": "johndoe@example.com"
},
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
],
"tags": [
"tag_0"
],
"required_ship_date": "2021-01-01T12:00:00Z",
"saturday_delivery": false,
"signature_required": false,
"international_duty_paid_by": "sender",
"shipments": [
{
"shipment_id": "shipment_id",
"warehouse_id": "wh_id",
"shipped_date": "2022-05-06T01:02:03Z",
"raw_status": "raw_status",
"status": "shipped",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"parent_product_id": null
}
],
"ship_to_address": {
"full_name": "John Doe",
"company": "company",
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"state": "state",
"postal_code": "postal_code",
"country": "country"
},
"ship_from_address": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"state": "state",
"postal_code": "postal_code",
"country": "country"
},
"packages": [
{
"package_id": "package_id",
"package_name": "package_name",
"tracking_number": "tracking_number",
"tracking_url": "tracking_url",
"shipping_method_id": "shipping_method_id",
"shipping_method_name": "shipping_method_name",
"carrier_id": "carrier_id",
"carrier_name": "carrier_name",
"scac": "scac",
"bill_of_lading": "bill_of_lading",
"sscc": "sscc",
"pro_number": "pro_number",
"shipping_cost": 1,
"measurements": {
"length": 1,
"width": 1,
"height": 1,
"unit": "in",
"weight": 1,
"weight_unit": "lb"
},
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"lot_id": "lot_id",
"expiration_date": "2022-06-06T01:02:03Z",
"parent_product_id": null
}
]
}
]
}
],
"external_system_url": "https://example.com/order/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
- Amphora
- BlueBox (IDrive Fulfillment)
- Clarus
- Cin7 Core (Dear Systems)
- Deposco
- Extensiv (3PL Central)
- FFE
- GoBolt
- Infoplus
- Logiwa
- Logiwa IO
- MasonHub
- Mintsoft
- Ongoing WMS
- Packiyo
- WMS Sandbox
- Shipfusion
- ShipHero
- ShipMonk
- ShippingTree
- ShipStation
- ShipStream
- Shipwire
- SKUSavvy
- Linnworks Core (SKUVault)
- Sojo
- Unleashed
- Veeqo
- VeraCore
- Warehance
- Whiplash (Ryder)
- Zenventory
The ID of the merchant/tenant/customer that owns the order. Can be passed into the Warehouse Customer endpoint for more details.
Example:
"warehouse_customer_id"
An external unique identifier for the order, such as a Shopify order id. Defaults to id if client has not defined one.
Example:
"order_reference_id"
A user-friendly identifier for their order. Defaults to reference_id if not provided.
Example:
"order_number"
The channel the order was placed on.
- ChannelId
- ChannelName
Show child attributes
Show child attributes
For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).
Example:
"Target"
The ID of the actual shipping method used to ship the order. Can be passed into the Shipping Method endpoint for more details.. If shipping_method_name is also provided, this will take precedence.
Example:
"fedex_ground"
The type of shipping method requested by the customer.
Example:
"Standard"
The currency used for this order. If not provided explicitly, defaults to USD.
Example:
"USD"
The total price a customer paid for the order.
Example:
13.49
The total tax on the order.
Example:
1.5
The total amount discounted from the order.
Example:
2.5
The total shipping cost for the order incurred by the customer.
Example:
3.5
Show child attributes
Show child attributes
The status of the order. See the order information [blocked] for more details.
Available options:
open, confirmed, processing, picked, packed, partially_fulfilled, fulfilled, exception, cancelled, backordered, other Example:
"open"
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" }]
List of the products included in the order.
Show child attributes
Show child attributes
Example:
[
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
]
⌘I