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
        }
      ],
      "dimensions": {
        "unit": "inch",
        "length": 12,
        "width": 12,
        "height": 4
      }
    }
  ]
}
EOF

{
  "message": "SUCCESS"
}

POST

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
        }
      ],
      "dimensions": {
        "unit": "inch",
        "length": 12,
        "width": 12,
        "height": 4
      }
    }
  ]
}
EOF

{
  "message": "SUCCESS"
}

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

Show child attributes

accounts.accountNumber

string

required

Unique identifier for the account, assigned by Orchestro.

Example:

"TEST_ACCOUNT_1"

accounts.accountType

string

required

Defines the account type, such as SHIPPER, CARRIER, or RSE.

Example:

"SHIPPER"

parcels

object[]

required

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

Required array length: 1 - 10 elements

Show child attributes

parcels.serviceType

string

required

Type of service used for the shipment, e.g., ground or express.

Example:

"GRD"

parcels.shipFrom

object

required

Address details for either the shipper or recipient.

Show child attributes

parcels.shipFrom.name

string

required

Name of the person or department receiving the parcel.

Example:

"The City Secretary's Office"

parcels.shipFrom.address1

string

required

Primary address line.

Example:

"1500 Marilla Street"

parcels.shipFrom.city

string

required

City name.

Example:

"Dallas"

parcels.shipFrom.state

string

required

Two-letter state code.

Example:

"TX"

parcels.shipFrom.zip

string

required

Postal or ZIP code.

Example:

"75201"

parcels.shipFrom.country

string

required

Country code, following the ISO 3166-1 alpha-2 standard.

Example:

"US"

parcels.shipFrom.company

string

Company name associated with the shipment address.

Example:

"Dallas City Hall"

parcels.shipFrom.address2

string

Secondary address line, if applicable.

Example:

""

parcels.shipFrom.phone

string

Contact phone number.

Example:

""

parcels.shipFrom.email

string

Email address for notifications.

Example:

""

parcels.shipFrom.addressType

string

Address type, either Business (B) or Residential (R).

Example:

"B"

parcels.shipTo

object

required

Address details for either the shipper or recipient.

Show child attributes

parcels.shipTo.name

string

required

Name of the person or department receiving the parcel.

Example:

"The City Secretary's Office"

parcels.shipTo.address1

string

required

Primary address line.

Example:

"1500 Marilla Street"

parcels.shipTo.city

string

required

City name.

Example:

"Dallas"

parcels.shipTo.state

string

required

Two-letter state code.

Example:

"TX"

parcels.shipTo.zip

string

required

Postal or ZIP code.

Example:

"75201"

parcels.shipTo.country

string

required

Country code, following the ISO 3166-1 alpha-2 standard.

Example:

"US"

parcels.shipTo.company

string

Company name associated with the shipment address.

Example:

"Dallas City Hall"

parcels.shipTo.address2

string

Secondary address line, if applicable.

Example:

""

parcels.shipTo.phone

string

Contact phone number.

Example:

""

parcels.shipTo.email

string

Email address for notifications.

Example:

""

parcels.shipTo.addressType

string

Address type, either Business (B) or Residential (R).

Example:

"B"

parcels.weight

object

required

Show child attributes

parcels.weight.value

number

required

Weight of the parcel.

Example:

6

parcels.weight.unit

string

required

Unit of weight measurement.

Example:

"lb"

parcels.rates

object[]

required

Array of rate information, including base rate and total rate for the parcel.

Show child attributes

parcels.rates.zone

number

required

Shipping zone.

Example:

7

parcels.rates.serviceType

string

required

Service type, such as ground shipping.

Example:

"GRD"

parcels.rates.tnt

number

required

Time to transit.

Example:

7

parcels.rates.baseRate

number

required

Base rate for the service.

Example:

3.92

parcels.rates.totalRate

number

required

Total rate including all charges.

Example:

24.47

parcels.shipmentDate

string<date-time>

Date and time of the shipment.

Example:

"2023-12-22T06:34:00"

parcels.parcelType

string

Parcel type, reserved for future use.

Example:

"P"

parcels.serviceAttributes

object[]

List of additional service attributes for the parcel, such as delivery instructions.

Show child attributes

parcels.serviceAttributes.code

string

required

Service attribute code indicating special delivery options.

Example:

"AD_SIGN"

parcels.serviceAttributes.description

string

required

Description of the service attribute.

Example:

"Adult Signature Required"

parcels.serviceAttributes.rate

number

required

Charge applied for the service attribute.

Example:

3.98

parcels.surcharges

object[]

List of surcharges applied to the parcel, such as fuel charges.

Show child attributes

parcels.surcharges.code

string

required

Surcharge code.

Example:

"FUEL"

parcels.surcharges.description

string

required

Details of the surcharge.

Example:

"Fuel Surcharge"

parcels.surcharges.rate

number

required

Rate charged for the surcharge.

Example:

5.98

parcels.dimensions

object

Show child attributes

parcels.dimensions.unit

string

required

Unit of dimensional measurement.

Example:

"inch"

parcels.dimensions.length

number

required

Length of the parcel.

Example:

12

parcels.dimensions.width

number

required

Width of the parcel.

Example:

12

parcels.dimensions.height

number

required

Height of the parcel.

Example:

4

Response

Shipment order created successfully.

message

string

Example:

"SUCCESS"

Scan events

⌘I

Analytics

Authorizations

Headers

Body

Response