Sign in

v1

latestOpenAPI 3.0.32026-07-23194968.1 KB
Shipments

Get shipments

Retrieve all OTA shipments in the organization.

Required permissions, when user-scoped authentication is used: OTA_VIEW.

get/api/v1/organization/shipments

Query parameters

orgIdinteger

Organization ID (optional). If not provided, the organization, that is associated with the authentication token, will be used.

Response

List of shipments

idinteger

Shipment unique identifier

productIdinteger

Template (product) ID for this shipment

productNamestring

Template (product) name

shipmentTime'ANY' | 'NIGHT' | 'MORNING' | 'AFTERNOON' | 'EVENING'

Time window for the OTA update delivery

titlestring

Shipment title

pathToFirmwarestring

Server path to the firmware binary, as returned by the firmware upload endpoint (POST /api/upload with type=FIRMWARE).

firmwareOriginalFileNamestring

Original firmware file name

hoststring

Optional. Custom host domain name used for firmware download URL. If not set, the server's default host is used.

startedByUserIdinteger

ID of the user who started the shipment

startedAtinteger

Timestamp (ms) when the shipment was started

finishedAtinteger

Timestamp (ms) when the shipment finished (0 if still running)

deviceIdsinteger[]

List of device IDs targeted by this shipment

attemptsLimitinteger

Maximum number of OTA delivery attempts per device

attemptResetPeriodMsinteger

Period (ms) after which the attempt counter resets

isSecureboolean

Whether the firmware transfer uses a secure channel

skipFwTypeCheckboolean

Whether to skip firmware type compatibility check

isCriticalboolean

Whether this is a critical update

sendPushboolean

Whether push notifications were sent for this shipment

status'RUN' | 'PAUSE' | 'FINISH' | 'CANCEL'

Current shipment status

compareField'NO_CONDITION' | 'BUILD_DATE_DIFFERS' | 'EARLIER_BUILD_DATE' | 'LATEST_FIRMWARE_VERSION' | 'LATEST_BLYNK_VERSION'

Condition used to determine whether the shipment should apply to a device