Create Orchestration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Submit

Submit one or many orchestration requests.

{
  "order": [
    { … }
  ]
}

Responses

If multiple orchestrations are submitted, HTTP 202 will be returned if at least one orchestration is accepted. Each orchestration request status will be provided in the data array. HTTP 412 will be returned if all orchestrations in the request fail.

{ 
  "data": [ 
    { 
       "success": "boolean", 
       "unit_nbr": "string",  
       "messages": [ 
         { 
            "message_cd": "string",  
            "message_txt": "string",
            "message_severity_cd": "string",
 
         } 
       ] 
     } 
  ] 
}

Every call to the orchestration API is authenticated by a subscription key (See authentication). The subscription key represents a company within the system. BCO company types can request an appointment and assign to a trucking company later. This needs to be executed before the appointment time or the slot will be missed.

Create Import Orchestration for trace only

The following request will create an orchestration for trace only (not appointment or payment).

curl -i -X POST \
  https://developer.cargosprint.com/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"
          }
        ]
      }
    ]
  }'

Create Import Orchestration for payment only

The following request will create an orchestration for payment (but not appointment). Trace information will also be provided (trace is part of the "Base Orchestration").

• Guarantee through date for payments is provided
• Reservation preferences are not provided

curl -i -X POST \
  https://developer.cargosprint.com/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",
            "guarantee_through_date": "2024-08-30"
          }
        ]
      }
    ]
  }'