Skip to main content
GET
/
v2
/
transponders
/
shipments
/
{id}
cURL
curl --request GET \
  --url https://api.example.com/v2/transponders/shipments/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "fleet": {
    "id": 123,
    "title": "<string>",
    "is_active": true
  },
  "transponders": [
    {
      "id": 123,
      "number": "<string>",
      "vehicle_type": 123,
      "agencies": [
        123
      ],
      "status": "IN_STOCK",
      "fleet": 123,
      "vehicle": 123
    }
  ],
  "received_by": {
    "id": 123,
    "username": "<string>",
    "email": "jsmith@example.com"
  },
  "shipped_by": {
    "id": 123,
    "username": "<string>",
    "email": "jsmith@example.com"
  },
  "direction": "IN",
  "status": "PENDING",
  "shipped_at": "2023-11-07T05:31:56Z",
  "received_at": "2023-11-07T05:31:56Z",
  "remarks": "<string>",
  "courier": "DHL",
  "tracking_code": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Read model serializer for shipments

id
integer
required
fleet
object
required

Fleet model serializer without nested relations

transponders
object[]
required
received_by
object
required
shipped_by
object
required
direction
enum<string>
required
  • IN - Incoming
  • OUT - Outgoing
Available options:
IN,
OUT
status
enum<string>
  • PENDING - Pending
  • SHIPPED - Shipped
  • RECEIVED - Received
  • CANCELLED - Cancelled
Available options:
PENDING,
SHIPPED,
RECEIVED,
CANCELLED
shipped_at
string<date-time> | null
received_at
string<date-time> | null
remarks
string | null
courier
  • DHL - DHL
  • FedEx - FedEx
  • UPS - UPS
  • USPS - USPS
  • OTHER - Other
Available options:
DHL,
FedEx,
UPS,
USPS,
OTHER
tracking_code
string | null
Maximum string length: 128