Sync Connection
Manually trigger a sync for the connection associated with your access token.
Note - this does not sync historical data. Rather, it syncs data from the last sync time to the current time. To sync historical data, use the on-demand syncs endpoint.
Headers
Your organization-level Trackstar API key.
"<x-trackstar-api-key>"
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
"<x-trackstar-access-token>"
Body
The specific functions to force sync. Make sure to use one compatible with the connection's type.
Function to sync
get_inventory, get_products, get_inbound_shipments, get_orders, get_warehouses, get_shipping_methods, get_returns, get_bills, get_warehouse_customers, get_warehouse_locations, get_inventory_ledger, populate_customer_order_trackstar_tags, get_shipments, redact_cart_orders, get_invoice_line_items, get_sales_orders, get_sales_order_shipments, get_locations, get_items, get_customers, get_vendors, get_employees, get_purchase_orders, get_purchase_order_receipts ["get_inventory", "get_orders"]
Response
Successful response
The id of the connection synced.
"07b344db-0304-4866-9ae1-ac8af5292a28"
Whether or not the connection is syncing.
true
The functions that are being synced. Returns empty if all are being synced.
["get_inventory", "get_orders"]