Sync Labels
POST/api/shippo/instances/:integration_instance/labels/sync
Queues a background import of labels (transactions) from Shippo for the chosen window, including labels bought directly in Shippo.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields (all optional — an empty body syncs everything changed since the last successful sync):
- mode (string): one of since_last_update (default), from_start_date (from the instance's sync_start_date setting), date_range, specific.
- date_from (date, nullable): start of the window (Y-m-d is a local calendar day; an ISO-8601 date-time is used as an instant). Required for date_range when date_to is empty.
- date_to (date, nullable): end of the window; a bare Y-m-d means through the end of that day. Must be on or after date_from.
- reference (string, nullable, max 255): identifies the single record to sync. Required when mode is specific. For labels, reference is the 32-character Shippo transaction object id.
Returns 200 with the tracked_job_log_id of the background job, which can be polled for progress. Returns 422 with field errors when validation fails, 404 for an unknown instance.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.