POST /v1/shipments/{id}/refresh
Poll the tracker now
Poll the tracker now
Queries the container tracker (Terminal49 / ShipsGo) and applies status, ETA and events to the shipment (and to all deals sharing the container). Requires scope write:deals.
- Authentication: header
Authorization: Bearer rv_live_...(API keys and scopes) - Required scope:
write:deals
openapi.json).Parameters
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes | Resource id (UUID). |
Responses
200
The refreshed shipment.
application/json · Schema: Shipment
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
dealId | string (uuid) | yes | |
status | "planned" | "booked" | "loaded" | "in_transit" | "at_port" | "discharged" | "released" | "delivered" | yes | |
containerNo | string | null | yes | |
billOfLading | string | null | yes | |
vessel | string | null | yes | |
portFrom | string | null | yes | |
portTo | string | null | yes | |
etd | string | null | yes | ISO 8601 date-time (UTC). |
eta | string | null | yes | ISO 8601 date-time (UTC). |
ata | string | null | yes | ISO 8601 date-time (UTC). |
events | object[] | yes | |
events[].at | string | no | |
events[].code | string | no | |
events[].description | string | no | |
events[].location | string | no | |
events[].vessel | string | no | |
lastTrackedAt | string | null | yes | ISO 8601 date-time (UTC). |
warnings | string[] | yes |
400
Invalid request parameters or body (code validation_error).
application/problem+json · Schema: Problem
401
Missing, malformed, unknown, revoked or expired API key (code unauthorized).
application/problem+json · Schema: Problem
403
The API key lacks the scope required by this endpoint (code insufficient_scope).
application/problem+json · Schema: Problem
404
Not found in this tenant.
application/problem+json · Schema: Problem
422
The shipment has no container/B/L number to track.
application/problem+json · Schema: Problem
429
Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.
application/problem+json · Schema: Problem
502
Tracker unavailable.
application/problem+json · Schema: Problem