Skip to main content
POST
/
contracts
/
{id}
/
schedules
/
{schedule_id}
/
transport-chains
/
{transport_chain_id}
/
transport-legs
Create Transport Leg
curl --request POST \
  --url https://v1.api.flux-os.com/contracts/{id}/schedules/{schedule_id}/transport-chains/{transport_chain_id}/transport-legs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "mode": "<unknown>",
  "source_land_description": "<unknown>",
  "destination_commercial_facility": "<unknown>",
  "volume": 123,
  "volume_measurement_unit": "<unknown>",
  "custodian_organization": "<unknown>",
  "position": 123,
  "source_well": null,
  "source_commercial_facility": null,
  "source_facility": null,
  "destination_facility": null,
  "custodian_entity": null,
  "is_custody_transfer": false,
  "fob": false,
  "carrier_organization": null,
  "carrier_entity": null,
  "carrier_user": null
}
'
{}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Path Parameters

id
integer
required

The contract ID.

schedule_id
integer
required

The schedule ID.

transport_chain_id
integer
required

The transport chain ID.

Body

application/json
mode
any
required
source_land_description
any
required
destination_commercial_facility
any
required
volume
number
required
volume_measurement_unit
any
required
custodian_organization
any
required
position
integer
source_well
unknown
source_commercial_facility
unknown
source_facility
unknown
destination_facility
unknown
custodian_entity
unknown
is_custody_transfer
boolean
default:false
fob
boolean
default:false
carrier_organization
unknown
carrier_entity
unknown
carrier_user
unknown

Response

Transport leg successfully created.

data
object