POST
/
shipment-events
curl --request POST \
  --url https://api-stage.orchestro.ai/e1/shipment-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "trackingId": "TEST-123",
  "accountNumber": "TEST_ACCOUNT_1",
  "carrierCode": "TEST_CARRIER_CODE",
  "carrierName": "TEST_CARRIER_NAME",
  "event": {
    "comments": "Pickup scan successful",
    "status": "DPCK",
    "alternateStatusCode": "",
    "deliverySignature": "",
    "timestamp": "2014-10-29T06:34:00",
    "timezone": "CST",
    "latitude": 38.896765,
    "longitude": -77.036211,
    "city": "HARKER HEIGHTS",
    "state": "TX",
    "zip": "76548",
    "pod": null
  }
}'

Authorizations

Authorization
string
headerrequired

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

Headers

Content-Type
string
required
Authorization
string
required

Body

application/json
trackingId
string
required

Unique barcode attached to the parcel.

accountNumber
string
required

Orchestro-provided account number.

carrierCode
string
required

Code identifying the carrier.

carrierName
string

Full name of the carrier service.

event
object
required

Details 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