EnvioOrchestration

/v1/orchestrations

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

Array of objects or null (EV_Order)

Responses

200

Success

post/v1/orchestrations

Request samples

Payload

{"order": [{"trade_Type": "string",
"billoflading": "string",
"vessel_Info": {"scac": "string",
"vessel_Name": "string",
"voyage_Nbr": "string"
},
"unit": {"unit_Nbr": "string",
"unit_Category": "string",
"line_Scac": "string",
"sztypISO": "string",
"seal_Nbr": ["string"
]
},
"locations": [{"location_Type": "string",
"location_Cd": "string",
"port_Cd": "string",
"unloc_Cd": "string",
"guarantee_Through_Date": "string",
"delivery_Type": "string",
"reservation_Details": {"reservation_Preferences": {"tryLaterDates": "string",
"threshold": "string",
"preference_Datetimes": [null
]
},
"hazmat_Info": {"haz_Class": "string",
"haz_UnCode": "string",
"commodity_Weight": "string",
"quantity": "string",
"package_Group": "string",
"commodity_Name": "string",
"emergency_Ph": "string",
"limited_Qty": "string",
"comments": "string"
},
"trucker_Info": {"trucker_Scac": "string",
"truck_Nbr": "string",
"lic_Plate_Nbr": "string",
"lic_Plate_State_Cd": "string",
"driver_Id": "string",
"driver_Fname": "string",
"driver_Lname": "string"
},
"pin_Nbr": "string",
"dualUnit": {"unit": {"unit_Nbr": null,
"unit_Category": null,
"line_Scac": null,
"sztypISO": null,
"seal_Nbr": [ ]
},
"drayUnit_Id": 0
}
}
}
]
}
]
}

/v1/orchestrations/trade-type/{tradeType}/unit-nbr/{unitNbr}

SecurityX-API-Key

Request

path Parameters

tradeType required	string
unitNbr required	string

Responses

200

Success

delete/v1/orchestrations/trade-type/{tradeType}/unit-nbr/{unitNbr}

/v1/orchestrations/trade-type/{tradetype}/unit-nbr/{unitnbr}/locations/{locationtype}

SecurityX-API-Key

Request

path Parameters

tradetype required	string
unitnbr required	string
locationtype required	string

Request Body schema:
application/json-patch+json

location_Type	string or null
location_Cd	string or null
port_Cd	string or null
guarantee_Through_Date	string or null
delivery_Type	string or null
	object (EV_ReservationDetails)
billoflading	string or null

Responses

200

Success

patch/v1/orchestrations/trade-type/{tradetype}/unit-nbr/{unitnbr}/locations/{locationtype}

Request samples

Payload

{"location_Type": "string",
"location_Cd": "string",
"port_Cd": "string",
"guarantee_Through_Date": "string",
"delivery_Type": "string",
"reservation_Details": {"reservation_Preferences": {"tryLaterDates": "string",
"threshold": "string",
"preference_Datetimes": [{"range": ["string"
],
"days": [0
],
"after": "string",
"before": "string"
}
]
},
"hazmat_Info": {"haz_Class": "string",
"haz_UnCode": "string",
"commodity_Weight": "string",
"quantity": "string",
"package_Group": "string",
"commodity_Name": "string",
"emergency_Ph": "string",
"limited_Qty": "string",
"comments": "string"
},
"trucker_Info": {"trucker_Scac": "string",
"truck_Nbr": "string",
"lic_Plate_Nbr": "string",
"lic_Plate_State_Cd": "string",
"driver_Id": "string",
"driver_Fname": "string",
"driver_Lname": "string"
},
"pin_Nbr": "string",
"dualUnit": {"unit": {"unit_Nbr": "string",
"unit_Category": "string",
"line_Scac": "string",
"sztypISO": "string",
"seal_Nbr": ["string"
]
},
"drayUnit_Id": 0
}
},
"billoflading": "string"
}

/v1/orchestrations/trade-type/{tradetype}/unit-nbr/{unitnbr}/locations/{locationtype}

SecurityX-API-Key

Request

path Parameters

tradetype required	string
unitnbr required	string
locationtype required	string

Responses

200

Success

delete/v1/orchestrations/trade-type/{tradetype}/unit-nbr/{unitnbr}/locations/{locationtype}

/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/orchestration-status

SecurityX-API-Key

Request

path Parameters

trade_type required	string
unit_nbr required	string

Responses

200

Success

get/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/orchestration-status

/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/unit-status

SecurityX-API-Key

Request

path Parameters

trade_type required	string
unit_nbr required	string

Responses

200

Success

get/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/unit-status

➔ Next to Notification

EnvioOrchestration

/v1/orchestrations

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/v1/orchestrations/trade-type/{tradeType}/unit-nbr/{unitNbr}

path Parameters

/v1/orchestrations/trade-type/{tradetype}/unit-nbr/{unitnbr}/locations/{locationtype}

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/v1/orchestrations/trade-type/{tradetype}/unit-nbr/{unitnbr}/locations/{locationtype}

path Parameters

/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/orchestration-status

path Parameters

/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/unit-status

path Parameters

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json