Description: Carriers need to submit tracking events to the Orchestro network using the format below. Status codes can be provided in the carrier’s native code specification. Orchestro automatically translates these codes to the network status code upon event ingestion.

​
Root Object

​
trackingid
string
required
Barcode attached to the parcel
​
containerTrackingid
string
ID when event applies to a container
​
carrierTrackingNumber
string
Carrier tracking number is applicable for vertically integrated networks such as UPS
​
carrierCode
string
Identification code for the carrier tracking number
​
uspsTrackingNumber
string
This is also applicable for vertically integrated networks

​
Account Object

​
accounts
object
required

​
Event Object

​
event
object
required

​
Attributes Update Object

​
phyAttributesUpdate
object

​
Dimension Update Object

​
attribute
string
required
One of length, width, height, weight
​
newValue
number
required
New measured value
​
unit
string
required
Unit for measured value, usually in or lb

​
Example One (Partner/Carrier sends their track code)

{
  "trackingId": "P55435VK",
  "accountNumber": "CARRIER_ACCOUNTNUM",
  "carrierCode": "ABC",
  "event": {
    "status": "DELIVERED",
    "modifiers": null,
    "latitude": 36.325196,
    "longitude": -119.351611,
    "deliverySignature": "No",
    "comments": "possession",
    "timestamp": "2024-06-04T15:35:00",
    "timezone": "PST",
    "city": "Visallia",
    "state": "CA",
    "zip": "95121",
    "networkCodeLookupFailed": true,
    "networkStatusCode": "DONR",
  "pod": {
            "otherDeliveryInfo": "Front Door",
            "signatureName": "Front Door",
            "images": [
                {
                    "imageType": "POD",
                    "imageUrl": "image",
                    "expiration": null
                },
        {
                    "imageType": "SIGNATURE",
                    "imageUrl": "image",
                    "expiration": null
                }
            ]
        }
  },
  "correlationId": "b35e2fa5-6abf-484a-9844-9789203328f2",
  "networkCode": "OCN",
  "interestedParties": [
    "ABC"
  ],
  "newMachineState": "label"
}

​
Example Two (Tracking Code from Orchestro to shipper)

"trackingCodeFromShipper":{
  "trackingId": "test_tracking_number1",
  "carrierTrackingNumber": "1ZXXXXXXXXXXXXXXXX",
  "carrierCode": "UPSSP",
  "uspsTrackingNumber": "92612903541618541475002472",
  "accounts": [
    {
      "accountNumber": "TEST_ACCOUNT_1",
      "accountType": "CARRIER"
    }
  ],
  "event": {
    "comments": "Delivered",
    "standardNetworkFormat": true,
    "networkTrackCode": "DDEL",
    "alternateNetworkTrackCode": "",
    "deliverySignature": "Yes",
    "timestamp": "2024-06-12T20:51:40-04:00",
    "timezone": "CST",
    "city": "Roxbury",
    "state": "CT",
    "zip": "06783",
    "latitude": -72.669701,
    "longitude": 41.93792,
    "pod": {
      "otherDeliveryInfo": "",
      "signatureName": "Palanivel M",
      "images": [
        {
          "imageType": "POD",
          "imageUrl": "https://geoabcd.com/sites/default/files/2022/Adobe%20Stock_11322_1920x1080.jpg",
          "expiration": "2024-06-12T20:51:40-04:00"
        },
        {
          "imageType": "SIGNATURE",
          "imageUrl": "https://abcdefilroom.com/wp-content/uploads/2018/12/deliv300x199.jpg",
          "expiration": "2024-06-12T20:51:40-04:00"
        }
      ]
    }
  },
  "phyAttributesUpdate": {
    "updates": [
      {
        "attribute": "length",
        "newValue": 11.7,
        "unit": "inch"
      }
    ]
  }
}