POST
/
connections
/
sync

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

x-trackstar-access-token
string
required

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

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.

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

Response

200 - application/json
functions_to_sync
string[]
required

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

id
string
required

The id of the connection synced.

syncing
boolean
required

Whether or not the connection is syncing.