Skip to main content

Push Pending Tracking Numbers to 17TRACK

POST 

/api/integrations/17track/instances/:instance/push-pending

Register every pending tracking number with 17TRACK in one run — the manual recovery path when trackings are waiting to be registered. Pending means not yet registered and not stopped: newly created trackings the automatic (debounced) registration has not sent yet, trackings whose earlier registration failed (for example because the 17TRACK quota was used up), and trackings left behind by a temporary 17TRACK error. The background job re-reads the pending set when it runs, so trackings created in the meantime are included.

Not yet available to API tokens

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

Response branches (all 200 OK):

  • data.tracked_job_log_id set — a new background job was queued for data.pending_count trackings
  • data.tracked_job_log_id: null with pending_count > 0 — a push is already running; it will pick up the pending trackings
  • data.pending_count: 0 — nothing is waiting, no job is queued

Activity log: records manual_push_triggered (with the acting user, pending_count and whether it joined a running push) whenever something is pending.

Other responses:

  • 403 Forbidden — missing the integrations.sync permission
  • 404 Not Found — instance id does not exist

Requires the integrations.sync permission.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type