Skip to main content
GET
Get a shipment by ID
Key: Read Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

shipmentId
string
required

Response

default - application/json
id
string
required
reference
string
required
status
enum<string>
required
Available options:
PLACED,
CONFIRMED,
UNKNOWN,
PRE_TRANSIT,
IN_TRANSIT,
OUT_FOR_DELIVERY,
DELIVERED,
AVAILABLE_FOR_PICKUP,
RETURN_TO_SENDER,
FAILURE,
ERROR,
CLOSED,
CANCELED
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
content
object[]
required
employeeId
string | null
reason
enum<string> | null
Available options:
ONBOARDING,
OFFBOARDING,
RENEWAL,
SEND_TO_EMPLOYEE,
SEND_TO_OFFICE,
RECYCLE,
REPAIR,
RESELL,
OTHER,
BOX
trackerStatus
enum<string> | null
Available options:
unknown,
pre_transit,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
return_to_sender,
failure,
cancelled,
error
estimatedDeliveryDate
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
box
object | null
previewFromAddress
object | null
previewToAddress
object | null