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": "test_tracking_number1",
  "carrierTrackingNumber": "1ZXXXXXXXXXXXXXXXX",
  "carrierCode": "UPSSP",
  "uspsTrackingNumber": "92612903541618541475002472",
  "accounts": [
    {
      "accountNumber": "TEST_ACCOUNT_1",
      "accountType": "CARRIER"
    }
  ],
  "event": {
    "comments": "Pickup scan received",
    "status": "2",
    "alternateStatusCode": "",
    "deliverySignature": "No",
    "timestamp": "2024-06-12T20:51:40-04:00",
    "timezone": "CST",
    "city": "Roxbury",
    "state": "CT",
    "zip": "06783",
    "latitude": -72.669701,
    "longitude": 41.93792
  }
}


Example Two (Partner/Carrier sends their track code)

{
  "trackingId": "test_tracking_number1",
  "carrierTrackingNumber": "1ZXXXXXXXXXXXXXXXX",
  "carrierCode": "UPSSP",
  "uspsTrackingNumber": "92612903541618541475002472",
  "accounts": [
    {
      "accountNumber": "TEST_ACCOUNT_1",
      "accountType": "CARRIER"
    }
  ],
  "event": {
    "comments": "Pickup Succesful",
    "standardNetworkFormat": true,
    "networkTrackCode": "DPCK",
    "alternateNetworkTrackCode": "",
    "deliverySignature": "No",
    "timestamp": "2024-06-12T20:51:40-04:00",
    "timezone": "CST",
    "city": "Roxbury",
    "state": "CT",
    "zip": "06783",
    "latitude": -72.669701,
    "longitude": 41.93792
  }
}

Example Three (Partner/Carrier sends their track code)

{
  "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://geodis.com/sites/default/files/2022/Adobe%20Stock_11322_1920x1080.jpg",
          "expiration": "2024-06-12T20:51:40-04:00"
        },
        {
          "imageType": "SIGNATURE",
          "imageUrl": "https://philadelphiamailroom.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"
      }
    ]
  }
}