On-Demand Syncs

​

Supported Integrations and Functions

​

WMS

• get_products
• get_orders
• get_inbound_shipments
• get_returns
• get_bills
• get_inventory_ledger

• Amazon — get_orders, get_returns, get_products, get_bills, get_inventory_ledger
• Bergen — get_orders, get_inbound_shipments
• Bleckmann — get_orders, get_inbound_shipments, get_returns
• BlueBox — get_returns
• Byrd — get_orders, get_inbound_shipments, get_returns
• Camelot — get_orders, get_inbound_shipments
• Canary7 — get_orders, get_inbound_shipments, get_returns
• Carton Cloud — get_orders
• Cirro — get_orders, get_products
• Crafty — get_orders, get_inbound_shipments
• Davinci — get_orders, get_inbound_shipments, get_returns
• DCL — get_orders
• Deposco — get_bills, get_inventory_ledger
• Extensiv 3PL Central — get_orders, get_inbound_shipments, get_returns, get_products, get_inventory_ledger
• FedEx Fulfillment — get_orders
• FFE — get_orders, get_inbound_shipments, get_returns
• Finale — get_orders, get_inbound_shipments, get_returns
• Fulfillment — get_orders, get_returns
• Fulfillment Lab — get_orders
• Helm WMS — get_inbound_shipments
• i-Fulfilment — get_orders
• Infoplus — get_orders, get_inbound_shipments, get_returns, get_products, get_bills
• Jazz Central — get_orders
• Leanafy — get_inbound_shipments
• Linnworks — get_orders
• Logicpod — get_orders
• Logiwa — get_orders, get_inbound_shipments, get_returns, get_products, get_bills, get_inventory_ledger
• Logiwa.io — get_orders, get_inbound_shipments
• Mayple — get_orders
• Nimble — get_orders, get_inbound_shipments, get_returns, get_products
• NFI — get_orders
• OSA Commerce — get_orders, get_inbound_shipments, get_returns, get_products
• Packem — get_orders
• Packiyo — get_orders, get_returns, get_products
• Rush Order — get_orders, get_inbound_shipments, get_returns
• Salesupply — get_orders
• ShipBob — get_orders
• ShipHero — get_orders, get_inbound_shipments, get_products, get_inventory_ledger
• Shipping Tree — get_inbound_shipments
• ShipStation — get_orders
• ShipStream — get_inbound_shipments, get_returns
• Skulabs — get_orders
• SkyVault — get_orders
• Smart Warehousing — get_orders
• Sojo — get_orders, get_inbound_shipments
• Stord — get_orders, get_inbound_shipments
• TikTok — get_orders
• Vertical Cold — get_orders, get_inbound_shipments
• Walmart — get_orders, get_returns
• Warehance — get_orders, get_products
• Whiplash — get_orders
• Xorosoft — get_orders, get_inbound_shipments

​

Carrier

• get_invoice_line_items

• DHL Express — get_invoice_line_items
• DPD — get_invoice_line_items
• FedEx — get_invoice_line_items
• Royal Mail — get_invoice_line_items
• UPS — get_invoice_line_items
• USPS — get_invoice_line_items

​

Cart

​

Usage

​

Creating a Sync Job

​

Request Parameters

On-demand sync is not enabled for {integration_name} {function_name}

• Create via API
• Create via Dashboard

Python

Node.js

cURL

import requests

TRACKSTAR_API_KEY = "your_api_key"
ACCESS_TOKEN = "your_access_token"

url = "https://production.trackstarhq.com/connections/on-demand-syncs"
headers = {
    "x-trackstar-api-key": TRACKSTAR_API_KEY,
    "x-trackstar-access-token": ACCESS_TOKEN,
    "Content-Type": "application/json"
}

payload = {
    "start_time": "2025-12-01T00:00:00Z",
    "end_time": "2026-01-01T00:00:00Z",
    "function_name": "get_orders"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
sync_job = response.json()

print(sync_job)

1. Open the Connections page and click into the connection you want to sync.
2. In the connection details drawer, switch to the On-Demand Syncs tab.
3. Click Create.

4. In the modal, pick a function, choose a start and end time (interpreted as your local timezone and converted to UTC on submit), and click Create Sync Job.

The new job will appear at the top of the list with status open.

​

Checking Sync Job Status

• Check via API
• Check via Dashboard

Use the sync_job_id returned from the create call:

Python

Node.js

cURL

import requests

TRACKSTAR_API_KEY = "your_api_key"
ACCESS_TOKEN = "your_access_token"
SYNC_JOB_ID = "your_sync_job_id"

url = f"https://production.trackstarhq.com/connections/on-demand-syncs/{SYNC_JOB_ID}"
headers = {
    "x-trackstar-api-key": TRACKSTAR_API_KEY,
    "x-trackstar-access-token": ACCESS_TOKEN
}

response = requests.get(url, headers=headers)
response.raise_for_status()
status = response.json()

print(status)

The On-Demand Syncs tab in the connection details drawer lists all sync jobs for that connection, with their function name, status, and requested window. The list is sorted by most recently created first.Click the refresh icon to re-fetch the list — the dashboard does not auto-poll.

​

Cancelling a Sync Job

• Cancel via API
• Cancel via Dashboard

Python

Node.js

cURL

import requests

TRACKSTAR_API_KEY = "your_api_key"
ACCESS_TOKEN = "your_access_token"
SYNC_JOB_ID = "your_sync_job_id"

url = f"https://production.trackstarhq.com/connections/on-demand-syncs/{SYNC_JOB_ID}/cancel"
headers = {
    "x-trackstar-api-key": TRACKSTAR_API_KEY,
    "x-trackstar-access-token": ACCESS_TOKEN,
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
response.raise_for_status()

print(response.json())

In the On-Demand Syncs tab, click the cancel icon at the end of any row whose status is open. The icon only appears for cancellable rows.Once cancelled, the job stays in the list with status cancelled and the icon disappears.

​

Important Notes

• Asynchronous execution: Sync jobs run in the background. Poll the status endpoint or rely on Trackstar’s existing webhooks (e.g. order.created, order.updated) to know when new data has landed.
• Precedence over scheduled syncs: On-demand syncs take precedence over scheduled syncs on the same connection. While a sync job is in the open state, the regularly scheduled syncs for that connection will not run, which can cause recent data to fall behind. Once all open sync jobs finish (or are cancelled), scheduled syncs automatically resume from where they left off — so no data is missed, only delayed.