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.
- Автентифікація: заголовок
Authorization: Bearer rv_live_...(API-ключі та scopes) - Потрібний scope:
write:deals
openapi.json) і подається англійською, як у самому API.Параметри
| Поле | Де | Тип | Обов’язк. | Опис |
|---|---|---|---|---|
id | path | string (uuid) | так | Resource id (UUID). |
Відповіді
200
The refreshed shipment.
application/json · Схема: Shipment
| Поле | Тип | Обов’язк. | Опис |
|---|---|---|---|
id | string (uuid) | так | |
dealId | string (uuid) | так | |
status | "planned" | "booked" | "loaded" | "in_transit" | "at_port" | "discharged" | "released" | "delivered" | так | |
containerNo | string | null | так | |
billOfLading | string | null | так | |
vessel | string | null | так | |
portFrom | string | null | так | |
portTo | string | null | так | |
etd | string | null | так | ISO 8601 date-time (UTC). |
eta | string | null | так | ISO 8601 date-time (UTC). |
ata | string | null | так | ISO 8601 date-time (UTC). |
events | object[] | так | |
events[].at | string | ні | |
events[].code | string | ні | |
events[].description | string | ні | |
events[].location | string | ні | |
events[].vessel | string | ні | |
lastTrackedAt | string | null | так | ISO 8601 date-time (UTC). |
warnings | string[] | так |
400
Invalid request parameters or body (code validation_error).
application/problem+json · Схема: Problem
401
Missing, malformed, unknown, revoked or expired API key (code unauthorized).
application/problem+json · Схема: Problem
403
The API key lacks the scope required by this endpoint (code insufficient_scope).
application/problem+json · Схема: Problem
404
Not found in this tenant.
application/problem+json · Схема: Problem
422
The shipment has no container/B/L number to track.
application/problem+json · Схема: Problem
429
Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.
application/problem+json · Схема: Problem
502
Tracker unavailable.
application/problem+json · Схема: Problem