Skip to main content

Update Integration Instance

PUT 
/api/trackstar/integration-instances/:integration_instance

Update an existing Trackstar integration instance (PATCH is also accepted). All fields optional. Requires Bearer token.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

integration_settings includes:

  • fulfillment_cost_financial_line_type_id (optional, int|null): COST financial line type used for Trackstar shipping cost lines. null = auto (default "Shipping Cost"). Must be a cost type or returns 422.
  • asn_inbound_type (optional, string|null, max 100): the receipt type advance shipment notices (ASNs) are created with in the warehouse system — one of the values from GET asn/inbound-types. null = the warehouse system's default receipt type. Longer or non-text values return 422.
  • asn_uom (optional, string|null, max 50): the unit of measure (pack type) every ASN line is sent in, as set up in the warehouse system (for example EACH). null = Trackstar's default (Unit). Longer or non-text values return 422.
  • asn_supplier_id (optional, string|null, max 100): the warehouse-system supplier id ASNs are sent under when a purchase order's vendor is not a supplier the warehouse system knows (some warehouse systems, such as Logiwa, refuse unknown supplier names). One of the ids from GET asn/suppliers. A vendor the warehouse system already knows is always sent as itself. null = send the vendor's name. Longer values return 422.

When the effective cost-line type changes, a reconcile tracked job is dispatched (rewires existing Trackstar cost lines old→new and backfills missing from stored payloads) and the response includes reconcile_tracked_job_log_id.

Requires the integrations.update permission.

Omitting fulfillment_cost_financial_line_type_id keeps the configured cost line type; send it (or null) to change it.

connection_settings never contains saved credentials: each secret key (API keys, secrets, passwords, tokens) is left out and replaced by a has_<snake_case_key> boolean saying whether one is saved (apiKey → has_api_key, password → has_password). Credentials in connection_settings are merged into the saved ones: a key you leave out keeps its saved value, so send a secret only to replace it (the response never echoes it back).

Request​

Responses​

OK

Response Headers
    Content-Type