Analytics
Create shipment orders
Analytics
Create shipment orders
This endpoint allows users to create a new shipment order with parcel and account details.
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 '{
"callerType": "SHIPPER",
"accounts": [
{
"accountNumber": "TEST_ACCOUNT_1",
"accountType": "SHIPPER"
}
],
"parcels": [
{
"shipmentDate": "2023-12-22T06:34:00",
"serviceType": "GRD",
"parcelType": "P",
"shipFrom": {
"company": "Dallas City Hall",
"name": "The City Secretary'\''s Office",
"address1": "1500 Marilla Street",
"address2": "",
"city": "Dallas",
"state": "TX",
"zip": "75201",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"shipTo": {
"company": "Dallas City Hall",
"name": "The City Secretary'\''s Office",
"address1": "1500 Marilla Street",
"address2": "",
"city": "Dallas",
"state": "TX",
"zip": "75201",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"serviceAttributes": [
{
"code": "AD_SIGN",
"description": "Adult Signature Required",
"rate": 3.98
}
],
"surcharges": [
{
"code": "FUEL",
"description": "Fuel Surcharge",
"rate": 5.98
}
],
"weight": {
"value": 6,
"unit": "lb"
},
"dimensions": {
"unit": "inch",
"length": 12,
"width": 12,
"height": 4
},
"rates": [
{
"zone": 7,
"serviceType": "GRD",
"tnt": 7,
"baseRate": 3.92,
"totalRate": 24.47
}
]
}
]
}'
{
"message": "SUCCESS"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Example:
"application/json"
Example:
"Bearer token"
Body
application/json
Response
200
application/json
Shipment order created successfully.
The response is of type object
.
curl --request POST \
--url https://api-stage.orchestro.ai/e1/shipment-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--data '{
"callerType": "SHIPPER",
"accounts": [
{
"accountNumber": "TEST_ACCOUNT_1",
"accountType": "SHIPPER"
}
],
"parcels": [
{
"shipmentDate": "2023-12-22T06:34:00",
"serviceType": "GRD",
"parcelType": "P",
"shipFrom": {
"company": "Dallas City Hall",
"name": "The City Secretary'\''s Office",
"address1": "1500 Marilla Street",
"address2": "",
"city": "Dallas",
"state": "TX",
"zip": "75201",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"shipTo": {
"company": "Dallas City Hall",
"name": "The City Secretary'\''s Office",
"address1": "1500 Marilla Street",
"address2": "",
"city": "Dallas",
"state": "TX",
"zip": "75201",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"serviceAttributes": [
{
"code": "AD_SIGN",
"description": "Adult Signature Required",
"rate": 3.98
}
],
"surcharges": [
{
"code": "FUEL",
"description": "Fuel Surcharge",
"rate": 5.98
}
],
"weight": {
"value": 6,
"unit": "lb"
},
"dimensions": {
"unit": "inch",
"length": 12,
"width": 12,
"height": 4
},
"rates": [
{
"zone": 7,
"serviceType": "GRD",
"tnt": 7,
"baseRate": 3.92,
"totalRate": 24.47
}
]
}
]
}'
{
"message": "SUCCESS"
}