Skip to main content

Update 17TRACK Instance

PATCH 
/api/integrations/17track/instances/:instance

Patch any combination of name, api_key, per-entity auto_track toggles, or the is_automatic_sync_enabled flag on the singleton instance. All fields are optional; only the keys present in the request body are applied.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Used by the dashboard's per-entity toggles, the rename action, key rotation, and the automatic-sync flip.

Optional Fields:

  • name — string, max 255 chars
  • api_key — string, 8–255 chars (key rotation)
  • auto_track.sales_order_fulfillments — boolean
  • auto_track.inbound_shipments — boolean
  • auto_track.warehouse_transfer_shipments — boolean
  • auto_track.rmas — boolean
  • auto_track.vendor_credit_shipments — boolean
  • is_automatic_sync_enabled — boolean (global polling/sync kill switch)

Responses:

  • 200 OK — returns the updated instance (without the live dashboard summary; call GET to re-hydrate it)
  • 422 Unprocessable Entity — validation failure

Alert & side-effect settings (all optional):

  • side_effects.vendor_credit_shipment_auto_delivered (boolean, default true) — auto-set the vendor credit shipment's status to Delivered when the carrier confirms delivery
  • side_effects.inbound_shipment_arrival_alert (boolean, default true) — in-app admin alert "package delivered — ready to receive" for inbound shipments
  • side_effects.rma_arrival_alert (boolean, default true) — in-app admin alert "package delivered — ready to inspect" for RMAs
  • quota_alert_threshold (integer 1–99, default 80) — quota usage % at which admins get a warning alert; a second high-priority alert always fires at 100% (exhausted). Changing the threshold re-arms the alert state machine.

The instance resource now also returns side_effects, quota_alert_threshold, and a transit analytics block (avg days in transit + on-time-vs-ETA rate for rows delivered in the last 90 days, overall and per carrier).

Sales-channel scoping (auto_track_channels) — optional. default is all (track everything not explicitly disabled) or none (track nothing until explicitly enabled). channels is an optional object keyed by sales-channel id; each entry may carry a boolean enabled flag and/or a sub_channels object keyed by sub-channel id (booleans). Resolution is most-specific-first: a sub_channels override wins, then the channel enabled flag, then default. Fulfillment type is modeled as a sub-channel (e.g. Amazon FBA vs merchant-fulfilled, or Shopify Web vs POS), so excluding high-volume marketplace-fulfilled shipments is just disabling that sub-channel. Only sales order fulfillments are scoped; other shipment types are unaffected. Validation: default must be all or none (422 otherwise).

Request​

Responses​

OK

Response Headers
    Content-Type