> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP.
> Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them.
> Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately.
> A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed.
> List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z.
> Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts.
> To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com

# 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.



## OpenAPI

````yaml post /connections/sync
openapi: 3.1.0
info:
  description: >

    Trackstar is a Unified API that provides standard endpoints for Supply Chain
    Logistics. We currently offer an API for Warehouse Management Systems (WMS).
  title: Trackstar API
  version: 0.1.0
servers:
  - description: Trackstar API
    url: https://production.trackstarhq.com
security: []
tags: []
externalDocs:
  description: Trackstar API Documentation
  url: https://docs.trackstarhq.com
paths:
  /connections/sync:
    post:
      tags:
        - Auth
      summary: Sync Connection
      description: >-
        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.
      operationId: post_sync_connection
      parameters:
        - in: header
          name: x-trackstar-api-key
          description: Your organization-level Trackstar API key.
          schema:
            type: string
            example: <x-trackstar-api-key>
          required: true
        - in: header
          name: x-trackstar-access-token
          description: >-
            Your user's access token for a specific integration (ShipHero,
            Extensiv, etc).
          schema:
            type: string
            example: <x-trackstar-access-token>
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionResourceSyncSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncConnectionResponseSchema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
components:
  schemas:
    ConnectionResourceSyncSchema:
      type: object
      properties:
        functions_to_sync:
          type: array
          description: >-
            The specific functions to force sync. Make sure to use one
            compatible with the connection's type.
          example:
            - get_inventory
            - get_orders
          items:
            type: string
            enum:
              - 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_files
              - get_sales_orders
              - get_sales_order_shipments
              - get_locations
              - get_items
              - get_customers
              - get_vendors
              - get_employees
              - get_purchase_orders
              - get_purchase_order_receipts
            description: Function to sync
            example: get_bills
      additionalProperties: false
      title: ConnectionResourceSyncSchema
    SyncConnectionResponseSchema:
      type: object
      properties:
        id:
          type: string
          description: The id of the connection synced.
          example: 07b344db-0304-4866-9ae1-ac8af5292a28
        syncing:
          type: boolean
          description: Whether or not the connection is syncing.
          example: true
        functions_to_sync:
          type: array
          description: >-
            The functions that are being synced. Returns empty if all are being
            synced.
          example:
            - get_inventory
            - get_orders
          items:
            type: string
            description: ''
            example: functions_to_sync
      required:
        - functions_to_sync
        - id
        - syncing
      additionalProperties: false
      title: SyncConnectionResponseSchema
    ValidationError:
      properties:
        error:
          type: string
        detail:
          type: object
          properties:
            <location>:
              type: object
              properties:
                <field_name>:
                  type: array
                  items:
                    type: string
      required:
        - error
      type: object
      title: ValidationError

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.