---
updatedAt: 2026-05-28T15:05:48.000Z
agentTools:
  projectIndex: https://developers.tive.com/llms.txt
---

# Set Shipment Devices

Set the list of devices for a shipment.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Tive Public API",
    "description": "API to interact with Tive services, data and devices.<br/>All Rights Reserved 2026",
    "contact": {
      "name": "Tive Support",
      "email": "support@tive.com"
    },
    "version": "V3"
  },
  "servers": [
    {
      "url": "https://api.tive.com",
      "description": "production"
    }
  ],
  "paths": {
    "/public/v3/Shipments/{shipmentId}/devices": {
      "put": {
        "tags": [
          "Shipments"
        ],
        "summary": "Set Shipment Devices",
        "description": "Set the list of devices for a shipment.",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "description": "`shipmentId` of the shipment.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-tive-account-id",
            "in": "header",
            "description": "ID of the account the request will be made in.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentDevicesSetRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentDevicesSetRequest"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentDevicesSetRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Shipment devices updated."
          },
          "400": {
            "description": "Unable to update shipment devices.  See response message for details."
          },
          "401": {
            "description": "Unauthorized"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ShipmentDevicesSetRequest": {
        "type": "object",
        "properties": {
          "skipDeviceLocationCheck": {
            "type": "boolean",
            "description": "Determines whether a shipment should start even if the tracker location does not match the shipment start location. Defaults to `false`."
          },
          "closeActiveShipments": {
            "type": "boolean",
            "description": "Close other active shipments related to the trackers being added to this shipment. When closing an existing shipment the new shipment will start at the current time. Defaults to `false`."
          },
          "devices": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "A list of device IDs associated with the shipment. Note, to <emp>start</emp> a shipment you must specify at least one device.",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}
```