Skip to content
SprintPass Pro
/API Specification/
/SprintPassPro

Orchestration API (v1)

SprintPass Pro API description

Download OpenAPI description
SprintPassProApi.json
SprintPassProApi.yaml
Overview
URL
http://sprintpasspro.emodal.com
Terms of Service
Languages
Servers
Mock server
https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi

SprintPassPro

Operations

Submit one or many orchestration requests

Request

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.

Security
sprintpasspro_X-API-Key
Body
orderArray of objects or null(sprintpasspro_EV_Order)
curl -i -X POST \
  https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi/v1/orchestrations \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "order": [
      {
        "trade_type": "I",
        "billoflading": "BOL12345",
        "unit": {
          "unit_nbr": "ABCD1234567"
        },
        "locations": [
          {
            "port_cd": "PORTA"
          }
        ]
      }
    ]
  }'

Responses

At least one orchestration was accepted. A specific return status is provided for each orchestration.

Bodyapplication/jsonArray [
dataArray of objects or null(sprintpasspro_Datum)
]
Response
application/json
[
  {
    "service_order_nbr": "7a33afe8-0e9a-497d-8916-8dc92048e092",
    "order_nbr": 438984,
    "unit_nbr": 9348934,
    "tran_status": "OK",
    "msgs": [ … ]
  }
]

Cancel orchestration

Request

Canceling an orchestration

Security
sprintpasspro_X-API-Key
Path
tradeTypestringrequired
unitNbrstringrequired
curl -i -X DELETE \
  'https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi/v1/orchestrations/trade-type/{tradeType}/unit-nbr/{unitNbr}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Cancelation request accepted.

Body
Array [
messagesArray of objects or null(sprintpasspro_ResponseMessageModel)read-only
]
Response
No response example

Update orchestration

Request

Updating an orchestration

Security
sprintpasspro_X-API-Key
Path
trade_typestringrequired
Example: I
unit_nbrstringrequired
Example: ABCD1234567
location_typestringrequired
Example: O
Body
location_Typestring or null
location_cdstring or null
port_cdstring or null
guarantee_through_datestring or null
delivery_typestring or null
reservation_detailsobject(sprintpasspro_EV_ReservationDetails)
billofladingstring or null
curl -i -X PATCH \
  https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi/v1/orchestrations/trade-type/I/unit-nbr/ABCD1234567/locations/O \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "guarantee_through_date": "2022-01-01"
  }'

Responses

Orchestration updated.

Body
Array [
messagesArray of objects or null(sprintpasspro_Message)
]
Response
{
  "messages": [
    {
      "message_cd": "10029",
      "message_txt": "Orchestration update request accepted",
      "message_severity_cd": "I"
    }
  ]
}

Cancel appointment

Request

An appointment can be canceled

Security
sprintpasspro_X-API-Key
Path
tradetypestringrequired
unitnbrstringrequired
locationtypestringrequired
curl -i -X DELETE \
  'https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/locations/{location_type}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Appointment canceled.

Body
Array [
messagesArray of objects or null(sprintpasspro_Message)
]
Response
No response example

Orchestration status

Request

Trade Type. I=Import, E=Export

Security
sprintpasspro_X-API-Key
Path
trade_typestringrequired
unit_nbrstringrequired
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/orchestration-status' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Ok

Body
Array [
statusstring or null
submitted_Dttmstring or null
initiated_Dttmstring or null
ended_Dttmstring or null
messagesArray of objects or null(sprintpasspro_WarningMessages)
]
Response
No response example

Unit status

Request

Unit status endpoint

Security
sprintpasspro_X-API-Key
Path
trade_typestringrequired
unit_nbrstringrequired
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/sprintpasspro/sprintpassproapi/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/unit-status' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Ok

Body
Array [
event_Catstring or null
event_Nmstring or null
drayUnitInfoobject(sprintpasspro_DrayUnitData)
drayUnitsStatusInfoobject(sprintpasspro_DrayUnitsStatusInfo)
locationsArray of objects or null(sprintpasspro_DrayLocations)
holdInfoArray of objects or null(sprintpasspro_HoldInfo)
feeInfoArray of objects or null(sprintpasspro_DrayFeeInfo)
lfdInfoobject(sprintpasspro_LFDInfo)
activityArray of objects or null(sprintpasspro_Activity)
]
Response
No response example