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.
Maximum length:
25
accountNumber
string
requiredOrchestro-provided account number.
Maximum length:
25
carrierCode
string
requiredCode identifying the carrier.
Maximum length:
25
event
object
requiredDetails of the shipment event, including timestamps, location, and signature data.
carrierName
string
Full name of the carrier service.
Maximum length:
100
phyAttributesUpdate
object
Physical attribute updates (e.g., length, width) for the parcel.
Response
200 - application/json
message
string