Create Cart Order Shipment
curl --request POST \
--url https://production.trackstarhq.com/cart/orders/{order_id}/shipments \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"carrier_name": "Carrier Name",
"shipping_method_name": "Standard Shipping",
"line_items": [
{
"product_sku": "product_sku",
"quantity": 0
}
]
}
'import requests
url = "https://production.trackstarhq.com/cart/orders/{order_id}/shipments"
payload = {
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"carrier_name": "Carrier Name",
"shipping_method_name": "Standard Shipping",
"line_items": [
{
"product_sku": "product_sku",
"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.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'x-trackstar-access-token': '<x-trackstar-access-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
tracking_number: 'tracking_number',
tracking_url: 'https://www.example.com/tracking',
carrier_name: 'Carrier Name',
shipping_method_name: 'Standard Shipping',
line_items: [{product_sku: 'product_sku', quantity: 0}]
})
};
fetch('https://production.trackstarhq.com/cart/orders/{order_id}/shipments', 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/cart/orders/{order_id}/shipments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tracking_number' => 'tracking_number',
'tracking_url' => 'https://www.example.com/tracking',
'carrier_name' => 'Carrier Name',
'shipping_method_name' => 'Standard Shipping',
'line_items' => [
[
'product_sku' => 'product_sku',
'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/cart/orders/{order_id}/shipments"
payload := strings.NewReader("{\n \"tracking_number\": \"tracking_number\",\n \"tracking_url\": \"https://www.example.com/tracking\",\n \"carrier_name\": \"Carrier Name\",\n \"shipping_method_name\": \"Standard Shipping\",\n \"line_items\": [\n {\n \"product_sku\": \"product_sku\",\n \"quantity\": 0\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://production.trackstarhq.com/cart/orders/{order_id}/shipments")
.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 \"tracking_number\": \"tracking_number\",\n \"tracking_url\": \"https://www.example.com/tracking\",\n \"carrier_name\": \"Carrier Name\",\n \"shipping_method_name\": \"Standard Shipping\",\n \"line_items\": [\n {\n \"product_sku\": \"product_sku\",\n \"quantity\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/cart/orders/{order_id}/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"tracking_number\": \"tracking_number\",\n \"tracking_url\": \"https://www.example.com/tracking\",\n \"carrier_name\": \"Carrier Name\",\n \"shipping_method_name\": \"Standard Shipping\",\n \"line_items\": [\n {\n \"product_sku\": \"product_sku\",\n \"quantity\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"unused_fields"
],
"data": {
"id": "order_id",
"order_number": "order_number",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"status": "fulfilled",
"raw_status": "raw_status",
"requested_shipping_method": "Standard",
"shipping_method_id": "shipping_method_id",
"shipping_method_name": "Standard Shipping",
"carrier_id": "carrier_id",
"carrier_name": "Carrier Name",
"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"
},
"bill_to_address": {
"full_name": "John Doe",
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"earliest_ship_date": "2022-10-10T01:02:03Z",
"latest_ship_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"line_item_id": "line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"parent_product_sku": "parent_product_sku",
"quantity": 1,
"unit_price": 10.99,
"discount": 1.5,
"tax": 0.5,
"warehouse_id": "warehouse_id"
}
],
"shipping_groups": [
{
"shipping_group_id": "shipping_group_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"raw_status": "raw_status",
"status": "shipped",
"warehouse_id": "warehouse_id",
"line_items": [
{
"line_item_id": "shipping_group_line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"quantity": 0
}
]
}
],
"shipments": [
{
"shipment_id": "shipment_id",
"raw_status": "raw_status",
"status": "shipped",
"warehouse_id": "warehouse_id",
"shipping_method_id": "shipment_shipping_method_id",
"shipping_method_name": "shipment_shipping_method_name",
"carrier_id": "carrier_id",
"carrier_name": "carrier_name",
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"line_items": [
{
"shipment_line_item_id": "shipment_line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"parent_product_sku": "parent_product_sku",
"quantity": 0
}
],
"shipping_groups": [
"sg_id_1",
"sg_id_2"
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z"
}
],
"tags": [
"tag_0"
],
"external_system_url": "https://example.com/order/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>"
]
}
}
}Orders
Create Cart Order Shipment
Get the required, optional, and integration specific fields by calling the integrations endpoint.
POST
/
cart
/
orders
/
{order_id}
/
shipments
Create Cart Order Shipment
curl --request POST \
--url https://production.trackstarhq.com/cart/orders/{order_id}/shipments \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"carrier_name": "Carrier Name",
"shipping_method_name": "Standard Shipping",
"line_items": [
{
"product_sku": "product_sku",
"quantity": 0
}
]
}
'import requests
url = "https://production.trackstarhq.com/cart/orders/{order_id}/shipments"
payload = {
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"carrier_name": "Carrier Name",
"shipping_method_name": "Standard Shipping",
"line_items": [
{
"product_sku": "product_sku",
"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.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'x-trackstar-access-token': '<x-trackstar-access-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
tracking_number: 'tracking_number',
tracking_url: 'https://www.example.com/tracking',
carrier_name: 'Carrier Name',
shipping_method_name: 'Standard Shipping',
line_items: [{product_sku: 'product_sku', quantity: 0}]
})
};
fetch('https://production.trackstarhq.com/cart/orders/{order_id}/shipments', 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/cart/orders/{order_id}/shipments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tracking_number' => 'tracking_number',
'tracking_url' => 'https://www.example.com/tracking',
'carrier_name' => 'Carrier Name',
'shipping_method_name' => 'Standard Shipping',
'line_items' => [
[
'product_sku' => 'product_sku',
'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/cart/orders/{order_id}/shipments"
payload := strings.NewReader("{\n \"tracking_number\": \"tracking_number\",\n \"tracking_url\": \"https://www.example.com/tracking\",\n \"carrier_name\": \"Carrier Name\",\n \"shipping_method_name\": \"Standard Shipping\",\n \"line_items\": [\n {\n \"product_sku\": \"product_sku\",\n \"quantity\": 0\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://production.trackstarhq.com/cart/orders/{order_id}/shipments")
.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 \"tracking_number\": \"tracking_number\",\n \"tracking_url\": \"https://www.example.com/tracking\",\n \"carrier_name\": \"Carrier Name\",\n \"shipping_method_name\": \"Standard Shipping\",\n \"line_items\": [\n {\n \"product_sku\": \"product_sku\",\n \"quantity\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/cart/orders/{order_id}/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"tracking_number\": \"tracking_number\",\n \"tracking_url\": \"https://www.example.com/tracking\",\n \"carrier_name\": \"Carrier Name\",\n \"shipping_method_name\": \"Standard Shipping\",\n \"line_items\": [\n {\n \"product_sku\": \"product_sku\",\n \"quantity\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "id",
"unused_fields": [
"unused_fields"
],
"data": {
"id": "order_id",
"order_number": "order_number",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"status": "fulfilled",
"raw_status": "raw_status",
"requested_shipping_method": "Standard",
"shipping_method_id": "shipping_method_id",
"shipping_method_name": "Standard Shipping",
"carrier_id": "carrier_id",
"carrier_name": "Carrier Name",
"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"
},
"bill_to_address": {
"full_name": "John Doe",
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"earliest_ship_date": "2022-10-10T01:02:03Z",
"latest_ship_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"line_item_id": "line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"parent_product_sku": "parent_product_sku",
"quantity": 1,
"unit_price": 10.99,
"discount": 1.5,
"tax": 0.5,
"warehouse_id": "warehouse_id"
}
],
"shipping_groups": [
{
"shipping_group_id": "shipping_group_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"raw_status": "raw_status",
"status": "shipped",
"warehouse_id": "warehouse_id",
"line_items": [
{
"line_item_id": "shipping_group_line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"quantity": 0
}
]
}
],
"shipments": [
{
"shipment_id": "shipment_id",
"raw_status": "raw_status",
"status": "shipped",
"warehouse_id": "warehouse_id",
"shipping_method_id": "shipment_shipping_method_id",
"shipping_method_name": "shipment_shipping_method_name",
"carrier_id": "carrier_id",
"carrier_name": "carrier_name",
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"line_items": [
{
"shipment_line_item_id": "shipment_line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"parent_product_sku": "parent_product_sku",
"quantity": 0
}
],
"shipping_groups": [
"sg_id_1",
"sg_id_2"
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z"
}
],
"tags": [
"tag_0"
],
"external_system_url": "https://example.com/order/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
- Cart Sandbox
- Amazon
- BigCommerce
- eBay
- Faire
- Groupon
- JOOR
- Magento (Adobe Commerce)
- Mirakl
- NuOrder
- OrderDesk
- OrderDesk
- Overstock
- Rithum (_Home Depot
- Shopify
- Squarespace
- TikTok
- TikTok
- Walmart
- Wayfair
- Wix
- WooCommerce
The tracking number for the shipment.
Example:
"tracking_number"
The URL for the tracking number.
Example:
"https://www.example.com/tracking"
The name of the carrier used to ship the order.
Example:
"Carrier Name"
The name of the actual shipping method.
Example:
"Standard Shipping"
List of the products included in the order.
Show child attributes
Show child attributes
Example:
[
{
"product_sku": "product_sku",
"quantity": 0
}
]