# Orchestration API

SprintPass Pro API description

Version: v1

## Security

### sprintpasspro_X-API-Key

X-API-Key Provided by SprintPass Pro

Type: apiKey
In: header
Name: X-API-Key

## Download OpenAPI description

[Orchestration API](https://developer.cargosprint.com/_bundle/sprintpasspro/SprintPassProApi.yaml)

## SprintPassPro

### Submit one or many orchestration requests

 - [POST /v1/orchestrations](https://developer.cargosprint.com/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations/post.md): ### The following types of orchestrations can be created:
#### Trace only
A trace only orchestration reports the status of a container at a given location. See "Unit Status" for details.

 Trace only examples
#### Payment 
A payment orchestration keeps container fees paid until the provided Guarantee Through Date. See "Orchestration" for more details.
#### Appointment
An appointment orchestration attempts to secure an appointment according to the preferences passed.
#### Empty returns
An appointment orchestration can be initiated with an empty container. See examples.
#### Dual move
An appointment orchestration can be initiated with a full container and linked to an empty return orchestration to perform a dual move. See examples.

### Cancel orchestration

 - [DELETE /v1/orchestrations/trade-type/{tradeType}/unit-nbr/{unitNbr}](https://developer.cargosprint.com/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1%7Btradetype%7D~1unit-nbr~1%7Bunitnbr%7D/delete.md): Canceling an orchestration

### Update orchestration

 - [PATCH /v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/locations/{location_type}](https://developer.cargosprint.com/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/updateorchestration.md): Updating an orchestration

### Cancel appointment

 - [DELETE /v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/locations/{location_type}](https://developer.cargosprint.com/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1%7Btrade_type%7D~1unit-nbr~1%7Bunit_nbr%7D~1locations~1%7Blocation_type%7D/delete.md): An appointment can be canceled

### Orchestration status

 - [GET /v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/orchestration-status](https://developer.cargosprint.com/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1%7Btrade_type%7D~1unit-nbr~1%7Bunit_nbr%7D~1orchestration-status/get.md): Trade Type. I=Import, E=Export

### Unit status

 - [GET /v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/unit-status](https://developer.cargosprint.com/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1%7Btrade_type%7D~1unit-nbr~1%7Bunit_nbr%7D~1unit-status/get.md): Unit status endpoint