Get a shipment line
Módulo Logistics
GET/shipment-lines/{id}shipmentLines.get
A line on a shipping manifest. Returns one shipment line with its `ETag`. A shipment line the caller may not see returns 404.
- Requiere la capacidad logistics.shipment.read.
- Alcances de OAuth: logistics.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the shipment line. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: ShipmentLine
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the shipment line. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| shipment_id | string (uuid) | Sí | Identifier of the shipment. |
| description | string | Sí | Line description.Restricciones: length 1 to 300 |
| quantity | number | Sí | Quantity. |
| element_id | string | null | Sí | Canon element carried.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Truss sections, 10 ft",
"quantity": 24,
"element_id": "4000.01.01-XPMS-001"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/shipment-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.shipmentLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.shipment_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos shipment-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f