Skip to main content
POST
/
shipment-orders
Create shipment orders
curl --request POST \
  --url https://api-stage.orchestro.ai/e1/shipment-orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data @- <<EOF
{
  "callerType": "SHIPPER",
  "accounts": [
    {
      "accountNumber": "TEST_ACCOUNT_1",
      "accountType": "SHIPPER"
    }
  ],
  "parcels": [
    {
      "serviceType": "GRD",
      "shipFrom": {
        "name": "The City Secretary's Office",
        "address1": "1500 Marilla Street",
        "city": "Dallas",
        "state": "TX",
        "zip": "75201",
        "country": "US",
        "company": "Dallas City Hall",
        "address2": "",
        "phone": "",
        "email": "",
        "addressType": "B"
      },
      "shipTo": {
        "name": "The City Secretary's Office",
        "address1": "1500 Marilla Street",
        "city": "Dallas",
        "state": "TX",
        "zip": "75201",
        "country": "US",
        "company": "Dallas City Hall",
        "address2": "",
        "phone": "",
        "email": "",
        "addressType": "B"
      },
      "weight": {
        "value": 6,
        "unit": "lb"
      },
      "rates": [
        {
          "zone": 7,
          "serviceType": "GRD",
          "tnt": 7,
          "baseRate": 3.92,
          "totalRate": 24.47
        }
      ],
      "shipmentDate": "2023-12-22T06:34:00",
      "parcelType": "P",
      "serviceAttributes": [
        {
          "code": "AD_SIGN",
          "description": "Adult Signature Required",
          "rate": 3.98
        }
      ],
      "surcharges": [
        {
          "code": "FUEL",
          "description": "Fuel Surcharge",
          "rate": 5.98
        }
      ]
    }
  ]
}
EOF
{
  "message": "SUCCESS"
}

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.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Content-Type
string
required
Example:

"application/json"

​
Authorization
string
required
Example:

"Bearer token"

Body

application/json
​
callerType
enum<string>
required

Type of caller initiating the shipment

Available options:
SHIPPER,
CARRIER,
RSE
Example:

"SHIPPER"

​
accounts
object[]
required

List of account details. A minimum of 1 and a maximum of 3 accounts can be provided.

Required array length: 1 - 3 elements
​
parcels
object[]
required

Array containing details for each parcel in the shipment. Maximum of 10 parcels allowed.

Required array length: 1 - 10 elements

Response

Shipment order created successfully.

​
message
string
Example:

"SUCCESS"