Skip to main content
POST
/
connections
/
sync
Sync Connection
curl --request POST \
  --url https://production.trackstarhq.com/connections/sync \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '
{
  "functions_to_sync": [
    "get_inventory",
    "get_orders"
  ]
}
'
{
  "id": "07b344db-0304-4866-9ae1-ac8af5292a28",
  "syncing": true,
  "functions_to_sync": [
    "get_inventory",
    "get_orders"
  ]
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

​
x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Body

application/json
​
functions_to_sync
enum<string>[]

The specific functions to force sync. Make sure to use one compatible with the connection's type.

Function to sync

Available options:
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,
get_shipments
Example:
["get_inventory", "get_orders"]

Response

Successful response

​
id
string
required

The id of the connection synced.

Example:

"07b344db-0304-4866-9ae1-ac8af5292a28"

​
syncing
boolean
required

Whether or not the connection is syncing.

Example:

true

​
functions_to_sync
string[]
required

The functions that are being synced. Returns empty if all are being synced.

Example:
["get_inventory", "get_orders"]