Skip to main content
GET
cURL

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
read-only
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