Analytics
Scan events
This endpoint captures event scan details for parcels as they move through the network.
POST
/
shipment-events
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Content-Type
string
requiredAuthorization
string
requiredBody
application/json
trackingId
string
requiredUnique barcode attached to the parcel.
accountNumber
string
requiredOrchestro-provided account number.
carrierCode
string
requiredCode identifying the carrier.
carrierName
string
Full name of the carrier service.
event
object
requiredDetails of the shipment event, including timestamps, location, and signature data.
phyAttributesUpdate
object
Physical attribute updates (e.g., length, width) for the parcel.
Response
200 - application/json
message
string