Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.orchestro.ai/llms.txt

Use this file to discover all available pages before exploring further.

Description: Carriers need to transmit this object to provide corresponding parcel data to Orchestro for delivery. A single manifest can provide the data for a single parcel or multiple parcels.

​
Root Object

​
shipmentDate
date
required
Shipment Date

​
Account Object

​
accounts
array object
required

​
Parcel Object

​
parcels
array object
required

​
Address Object

ShipFrom
​
shipFrom
object
ShipTo
​
shipTo
object
required
​
standardReturn
boolean
If the package standard return is true then return address is required
Return Address
​
returnAddress
object
​
serviceAttributes
array string
List of service attributes. The service attributes codes available in the appendix
​
packType
string
Reserved for future use
​
reference
string
Reference field for customer use
​
reference2
string
Reference field for customer use
​
reference3
string
Reference field for customer use
​
specialInstructions
string
Extra Delivery instructions

​
Weight Object

​
weight
object

​
Dimension Object

​
dimensions
object

​
Sample JSON

{
  "shipmentDate": "2024-02-02T03:55:44-05:00",
  "accountNumber": "TEST_ACCOUNT_1",
  "accounts": [
    {
      "accountNumber": "TEST_ACCOUNT_1",
      "accountType": "CARRIER"
    }
  ],
  "parcels": [
    {
      "trackingId": "Test_Tracking_Id",
      "shipDate": "2024-02-02T03:55:44-05:00",
      "expectedDate": "2024-02-06T03:55:44-05:00",
      "account": "TEST_ACCOUNT_1",
      "serviceType": "G",
      "originCarrier": "TEST",
      "zone": "6",
      "originCode": "TEST",
      "pickupType": "Pickup",
      "shipFrom": {
        "company": "",
        "name": "Test Name",
        "address1": "306 COUNTY ROAD 655",
        "address2": "",
        "city": "BRAZORIA",
        "state": "TX",
        "zip": "77422",
        "country": "US",
        "phone": "",
        "email": "",
        "addressType": "B"
      },
      "shipTo": {
        "company": "",
        "name": "Test Name",
        "address1": "5413 N LOCUST ST",
        "address2": "",
        "city": "Alpharetta",
        "state": "GA",
        "zip": "60600",
        "country": "US",
        "phone": "",
        "email": "",
        "addressType": "B"
      },
      "standardReturn": true,
      "returnAddress": {
        "name": "",
        "company": "Test Name",
        "address1": "306 COUNTY ROAD 655",
        "address2": "",
        "city": "BRAZORIA",
        "state": "TX",
        "zip": "60600",
        "country": "US",
        "phone": ""
      },
      "serviceAttributes": [
        "AD_SIGN",
        "SAT_DEL"
      ],
      "packType": "P",
      "weight": {
        "value": 3,
        "unit": "lb"
      },
      "dimensions": {
        "unit": "inch",
        "length": 3,
        "width": 12,
        "height": 3
      }
    }
  ]
}